Skip to content

Commit

Permalink
Website runs locally
Browse files Browse the repository at this point in the history
Signed-off-by: Rieks <RieksJ@users.noreply.github.com>
  • Loading branch information
RieksJ committed Aug 11, 2023
1 parent 9ab009f commit bcba9a6
Show file tree
Hide file tree
Showing 149 changed files with 313 additions and 1,764 deletions.
6 changes: 3 additions & 3 deletions docs/tev2/README.md → docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,11 @@ date: 20220402
# Contributing to TEv2 Tools

:::info Editor's note
This documentation is based on the [ToIP TT-Tools Proposal](https://tno-terminology-design.github.io/tev2-specifications/docs/tev2/toip-terminology-toolbox) memo, which we currently keep as a reference.
This documentation is based on the [ToIP TT-Tools Proposal](https://tno-terminology-design.github.io/tev2-specifications/docs/toip-terminology-toolbox) memo, which we currently keep as a reference.
:::

The '[Terminology Engine v2 (TEv2)](https://tno-terminology-design.github.io/tev2-specifications/docs/tev2/tev2-overview)' consists of two parts:
1. The [Terminology Toolbox](https://tno-terminology-design.github.io/tev2-specifications/docs/tev2/tev2-toolbox) is a set of (extendable) command-line tools that can be used for generic purposes, such as resolving [TermReferences](term-ref@), and creating glossaries.
The '[Terminology Engine v2 (TEv2)](https://tno-terminology-design.github.io/tev2-specifications/docs/tev2-overview)' consists of two parts:
1. The [Terminology Toolbox](https://tno-terminology-design.github.io/tev2-specifications/docs/tev2-toolbox) is a set of (extendable) command-line tools that can be used for generic purposes, such as resolving [TermReferences](term-ref@), and creating glossaries.
2. The use of these, and other tools (in our case: [Docusaurus](https://docusaurus.io/), and [github CI/CD](https://resources.github.com/ci-cd/)), for facilitating the [curation](curate@) of [terminologies](terminology@) by [terms communities](terms-community@).

We are seeking parties that can contribute to the development of these (extendable) command-line tools, and do so in close collaboration with the eSSIF-Lab consortium. Please express your interest as an [issue in the eSSIF-Lab repo](https://github.com/tno-terminology-design/tev2-specifications/issues).

Large diffs are not rendered by default.

File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
14 changes: 7 additions & 7 deletions docs/tev2/manuals/curator.md → docs/manuals/curator.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,19 +28,19 @@ The task of [curators](@) is to create/maintain the [scope directory](@) that th
This section needs to be revised from here onward
:::

TEv2 assumes that the [curated](@) data resides in an existing [scope directory](@), and that [curated files](@) are expected to be processable by other tools, including, but not limited to [github pages](https://pages.github.com/) or [Docusaurus](https://docusaurus.io/docs/docs-introduction), which are static site generators for web sites that document all sorts of guidance, specifications, etc. Such a [scope directory](@) must be [set up](/docs/tev2/manuals/tev2-installation) in advance.
TEv2 assumes that the [curated](@) data resides in an existing [scope directory](@), and that [curated files](@) are expected to be processable by other tools, including, but not limited to [github pages](https://pages.github.com/) or [Docusaurus](https://docusaurus.io/docs/docs-introduction), which are static site generators for web sites that document all sorts of guidance, specifications, etc. Such a [scope directory](@) must be [set up](/docs/manuals/tev2-installation) in advance.

Thus, whenever a [terms-community](@) decided that some contribution is to be included in the part of the [corpus](@) that is maintained by that [community](terms-community@), the [curators](@) of that [community](terms-community@) are tasked to

1. create/maintain/update any [scope](@)-related administration in the [scope directory](@) that is needed for curation, as specified by a [Scope Administration File (SAF)]/tev2/spec-files/saf;
2. convert that contribution to (a set of) [curated files](@), that comply with the [specifications](/docs/tev2/spec-files/ctext) for such files;
3. store them at the location as designated in the [SAF]/tev2/spec-files/saf;
1. create/maintain/update any [scope](@)-related administration in the [scope directory](@) that is needed for curation, as specified by a [Scope Administration File (SAF)](docs/spec-files/saf);
2. convert that contribution to (a set of) [curated files](@), that comply with the [specifications](/docs/spec-files/ctext) for such files;
3. store them at the location as designated in the [SAF](docs/spec-files/saf);
4. generate/update any artifact that the [community](terms-community@) wants to automatically maintain, which in particular includes the [MRG](@) and associated [HRG](@).

This document provides an overview of the knowledge that [curators](@) may need to perform this task, which can be broken up in the following parts:

1. [Setup/installation](/docs/tev2/manuals/tev2-installation) of a [scope directory](@) that is suitable for working with TEv2, and the creation of a [SAF]/tev2/spec-files/saf.
1. [Setup/installation](/docs/manuals/tev2-installation) of a [scope directory](@) that is suitable for working with TEv2, and the creation of a [SAF](docs/spec-files/saf).

2. [Curation](@) of terminological contributions. This requires knowledge about the [file structure](/docs/tev2/spec-files/ctext) of [curated file](@).
2. [Curation](@) of terminological contributions. This requires knowledge about the [file structure](/docs/spec-files/ctext) of [curated file](@).

3. [generation](/docs/tev2/tev2-toolbox) of [curated texts](@). It is typical for a [terms community](@) to want to have a [glossary](@) of the [terms](@) they either have [defined](@) themselves, or are [defined](@) elsewhere but are to be used within that [community](@). However, other artifacts may be generated as well (a [dictionary](@), white papers, etc.) - this is all up to the [community](@).
3. [generation](/docs/tev2-toolbox) of [curated texts](@). It is typical for a [terms community](@) to want to have a [glossary](@) of the [terms](@) they either have [defined](@) themselves, or are [defined](@) elsewhere but are to be used within that [community](@). However, other artifacts may be generated as well (a [dictionary](@), white papers, etc.) - this is all up to the [community](@).
Original file line number Diff line number Diff line change
Expand Up @@ -29,9 +29,9 @@ This page should only document the generic stuff. Any installation details that

TEv2 is a tool for [curating](@) [terminology](@)-related data from the perspective of a single [scope](@). Installation comprises
- setting up, or appointing an (online) directory that will serve as a [scope directory](@);
- creating a [Scope Administration File (SAF)]/tev2/spec-files/saf, and providing the configuration of the [scope](@) and its [terminology](@);
- installing the [tev2-toolbox](/docs/tev2/tev2-toolbox);
- integrating the [tools](/docs/tev2/tev2-toolbox) with other tools, such as a CI/CD pipeline on github or gitlab, static site generators such as [github pages](https://pages.github.com/) or [Docusaurus](https://docusaurus.io/docs/docs-introduction), etc. See also: [Using the Tools](/docs/tev2/tev2-toolbox).
- creating a [Scope Administration File (SAF)](docs/spec-files/saf), and providing the configuration of the [scope](@) and its [terminology](@);
- installing the [tev2-toolbox](/docs/tev2-toolbox);
- integrating the [tools](/docs/tev2-toolbox) with other tools, such as a CI/CD pipeline on github or gitlab, static site generators such as [github pages](https://pages.github.com/) or [Docusaurus](https://docusaurus.io/docs/docs-introduction), etc. See also: [Using the Tools](/docs/tev2-toolbox).

### Structure of Scope Directories

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,12 +13,12 @@ This page intends to provide (lots of pointers to) information that people may n

## What it is about

At the core of [TEv2](@) is [text conversion](/docs/tev2/overview/tev2-design-principles): every [tool in the toolbox](/docs/tev2/tev2-toolbox) takes one or more input files, does some textual processing, and produces outputs. The basic [conversion pattern](/docs/tev2/overview/tev2-design-principles#text-conversion-steps) that individual [tools](/docs/tev2/tev2-toolbox) are expected to follow ensures that they can be easily extended, e.g., to operate on different input formats, or to produce alternative output formats.
At the core of [TEv2](@) is [text conversion](/docs/overview/tev2-design-principles): every [tool in the toolbox](/docs/tev2-toolbox) takes one or more input files, does some textual processing, and produces outputs. The basic [conversion pattern](/docs/overview/tev2-design-principles#text-conversion-steps) that individual [tools](/docs/tev2-toolbox) are expected to follow ensures that they can be easily extended, e.g., to operate on different input formats, or to produce alternative output formats.

There are various things that make the further development of [TEv2](@) challenging:

1. the interop between individual tools: outputs of one tool must be fit for processing by another tool (which may include existing third party tools, such as static website generators), as described in the [TEv2 Architecture](/docs/tev2/overview/tev2-architecture).
2. designing actual tools such that they can be easily extended (also by others) to accept different input formats, and/or produce different output formats, as described in the [text conversion steps pattern](/docs/tev2/overview/tev2-design-principles#text-conversion-steps)
1. the interop between individual tools: outputs of one tool must be fit for processing by another tool (which may include existing third party tools, such as static website generators), as described in the [TEv2 Architecture](/docs/overview/tev2-architecture).
2. designing actual tools such that they can be easily extended (also by others) to accept different input formats, and/or produce different output formats, as described in the [text conversion steps pattern](/docs/overview/tev2-design-principles#text-conversion-steps)
3. designing tools such that they can be easily used in different contexts (e.g. whether or not to dockerize a tool)
4. collaborating with other people that work on the tools such that the coherence and consistent working of tools that different people develop is guaranteed. We may need to better organize this.
5. making the tools automatically testable, e.g. by running test suites as part of the CI/CD street we envisage that tools would have.
Expand All @@ -33,11 +33,11 @@ There are various things that make the further development of [TEv2](@) challeng


:::info In order to appreciate and come to grips with these challenges, it will definitely help if you read up on some more backgrounds of what we try to do. Here are some pointers:
- The [TEv2 Overview](/docs/tev2/tev2-overview) (and its sub-documents) will provide you with with such backgrounds.
- The [TEv2 Overview](/docs/tev2-overview) (and its sub-documents) will provide you with with such backgrounds.
- Other documented topics include:
- [file structure spec](/docs/tev2/tev2-spec-files)
- [syntax specifications](/docs/tev2/tev2-syntax)
- [specifications of individual tools](/docs/tev2/tev2-toolbox) - not all specifications hare already been drafted/checked.
- [file structure spec](/docs/tev2-spec-files)
- [syntax specifications](/docs/tev2-syntax)
- [specifications of individual tools](/docs/tev2-toolbox) - not all specifications hare already been drafted/checked.
:::

## Tooling status as of ...
Expand All @@ -46,19 +46,19 @@ For the date of the tooling status, see the "<i>last updated on</i>" text at the

### Under development

- [MRGT](/docs/tev2/spec-tools/mrgt), which is in [this toip repo](https://github.com/trustoverip/ctwg-toolkit-mrg). The tool works, but still has some [bugs/issues](https://github.com/trustoverip/ctwg-toolkit-mrg/issues) that need to be fixed.
- [TRRT](/docs/tev2/spec-tools/trrt), which is currently actively developed by TNO in [this repo](https://github.com/tno-terminology-design/trrt).
- [MRGT](/docs/spec-tools/mrgt), which is in [this toip repo](https://github.com/trustoverip/ctwg-toolkit-mrg). The tool works, but still has some [bugs/issues](https://github.com/trustoverip/ctwg-toolkit-mrg/issues) that need to be fixed.
- [TRRT](/docs/spec-tools/trrt), which is currently actively developed by TNO in [this repo](https://github.com/tno-terminology-design/trrt).

### High priority
- ingress tools that convert wiki-files (and perhaps some other formats) into [curated texts](/docs/tev2/spec-files/00-ctext.md);
- [HRGT](/docs/tev2/spec-tools/hrgt), so that we can actually generate human-readable glossaries. For this tool, specifications need to be further drafted (and agreed on).
- ingress tools that convert wiki-files (and perhaps some other formats) into [curated texts](/docs/spec-files/00-ctext.md);
- [HRGT](/docs/spec-tools/hrgt), so that we can actually generate human-readable glossaries. For this tool, specifications need to be further drafted (and agreed on).

### Medium priority:
- [ICT](/docs/tev2/spec-tools/ict), which allows for integrity checking. The current specifications are outdated and first need to be revised.
- [ICT](/docs/spec-tools/ict), which allows for integrity checking. The current specifications are outdated and first need to be revised.

### Lower priority:
- extensions for the [TRRT](@), and perhaps other tools, so that they can be used in [ReSpec](https://dev.w3.org/2008/video/mediaann/ReSpec.js/documentation.html) environments, such as often used for W3C standards.
- [MRDT](/docs/tev2/spec-tools/mrdt) and [HRDT](/docs/tev2/spec-tools/hrdt)
- [MRDT](/docs/spec-tools/mrdt) and [HRDT](/docs/spec-tools/hrdt)


## Starting to contribute
Expand Down
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -17,13 +17,13 @@ As TEv2 is not (yet) available, the texts that specify the tool are still 'raw',

The Terminology Engine (v2) is a set of specifications and tools that caters for the creation and maintenance (i.e. [curation](@)) of [terminologies](@), as well as for its subsequent use in publications of different types (e.g. websites, whitepapers) and formats (e.g. html, LaTeX), as appropriate for different, individual [scopes](@).

The main objective of [TEv2](@) is to provide support to [communities](@) that actively seek to [understand one another](/docs/tev2/overview/tev2-common-understanding), first within the [community](@) itself, but also across [communities](@) that also use [TEv2](@).
The main objective of [TEv2](@) is to provide support to [communities](@) that actively seek to [understand one another](/docs/overview/tev2-common-understanding), first within the [community](@) itself, but also across [communities](@) that also use [TEv2](@).

In practice, this means that [TEv2](@) provides tools and mechanisms that:
1. help [readers](@) of publications (that were generated with [TEv2](@) tools) to understand the [terms](@) that are used therein, in the way that the [authors](@) have intended (rather than interpreting such [terms](@) in their own way);
2. facilitating [authors](@) to write and publish texts where terms can be referenced to their intended meaning, within, and across [scopes](@);
3. supporting [authors](@), [readers](@) and other stakeholders to such publications as they seek to create and further develop a [terminology](@) that they can commit to (within a specific [scope](@)), which we expect to also help develop insights in their subject matter of that [scope](@)).

These contributions are what so-called [curators](@) of the [scope](@) seek to deliver. They are the ones that make sure that there is a [location](scopedir@) where people can contribute to the development of the [terminology](@) of a [scope](@), and tools are installed and operational that enable [authors](@) to use them as they publish their documents. [Curators](@) have their own [manual](/docs/tev2/manuals/curator).
These contributions are what so-called [curators](@) of the [scope](@) seek to deliver. They are the ones that make sure that there is a [location](scopedir@) where people can contribute to the development of the [terminology](@) of a [scope](@), and tools are installed and operational that enable [authors](@) to use them as they publish their documents. [Curators](@) have their own [manual](/docs/manuals/curator).

The [eSSIF-Lab website](/docs/essifLab) already shows the first ideas of what that might look like (popups on [terms](@) showing their [definition](@)).
Loading

0 comments on commit bcba9a6

Please sign in to comment.