Skip to content
GitLab
Projects Groups Snippets
  • /
  • Help
    • Help
    • Support
    • Community forum
    • Submit feedback
    • Contribute to GitLab
  • Sign in
  • E eSSIF-Lab framework
  • Project information
    • Project information
    • Activity
    • Labels
    • Members
  • Repository
    • Repository
    • Files
    • Commits
    • Branches
    • Tags
    • Contributors
    • Graph
    • Compare
  • Issues 10
    • Issues 10
    • List
    • Boards
    • Service Desk
    • Milestones
  • Merge requests 0
    • Merge requests 0
  • CI/CD
    • CI/CD
    • Pipelines
    • Jobs
    • Schedules
  • Deployments
    • Deployments
    • Environments
    • Releases
  • Monitor
    • Monitor
    • Incidents
  • Analytics
    • Analytics
    • Value stream
    • CI/CD
    • Repository
  • Wiki
    • Wiki
  • Snippets
    • Snippets
  • Activity
  • Graph
  • Create a new issue
  • Jobs
  • Commits
  • Issue Boards
Collapse sidebar
  • ESSIF-LabESSIF-Lab
  • eSSIF-Lab framework
  • Issues
  • #9
Closed
Open
Issue created Jul 31, 2020 by Rieks Joosten@rieks.joostenMaintainer

Term-file authoring

In this issue, we write the specifications of the structure of so-called 'term-files', i.e. files in which some concept is being specified/described, instances of which are being referred to by a specific term (phrase, word). This top message contains such specifications, and will be edited/updated as needed and agreed. Subsequent messages document the discussions.

A term may be defined by creating a so-called term-file in the docs/terminology/terms directory for that term. You are advised to copy the Term-definition template, and rename it into term-<SCOPE>-<TERM>.mdx, where <SCOPE> is the id of the scope within which the term is defined, and <TERM> is the name of the term you are defining. Then, follow the instructions in the template to complete the contents of the term-file.

The term-file:

  • MUST start with `import Term from '../src/components/Term' (as in the template);
  • MUST be followed by a DocuSaurus header block (edit as needed);
  • MUST include one or more subsections, as specified in the Term-definition template document
  • MAY include a subsection ## Meta, in which attributes are defined that are used to generate or adapt document files (e.g. glossaries, term definitions, etc.)
Edited Sep 22, 2020 by Rieks Joosten
Assignee
Assign to
Time tracking