2021-02-15 CTWG Meeting Notes

Meeting Date

• 15 Feb 2021 

Attendees

• Drummond Reed
• Rieks Joosten
• Daniel Hardman
• Scott Whitmire
• Brian Dill
• Maria Iliadi (GRNET)

Main Goal of this Meeting:

To review the proposed new Docusaurus Terminology tooling and take one term through the entire lifecycle.

Agenda 

Recording

• Link

Presentation(s)

• None
  

Documents

• Docusaurus Terminology GitLab master

Notes

1. New members
   1. Maria is a software engineer who has been working at GRNET for over a year working mostly on Python and Javascript.
      1. She has been working on Docusaurus Terminology in order to add terms to the documentation for packages using it.
2. Report on last meeting and updates on subsequent conversations
   1. Rieks shared that he has shared in our Slack channel a summary of requirements/suggestions from eSSIF-Lab for Terminology Engine v2 (TEv2), where TEv1 is the current Docusaurus Terminology tool of GRNET.
3. Review of Docusaurus Terminology tooling and end-to-end example of a term lifecycle
   
   1. Maria began by offering to do a walk-through of the Docusaurus Terminology capabilities.
   2. The GRNET tool repo is here: https://gitlab.grnet.gr/terminology/docusaurus-terminology/-/tree/master
   3. Maria showed us a number of capabilities of the current version of Docusaurus Terminology.
   4. Daniel then asked Rieks to summarize what the delta is between the current version and what CTWG needs.
      1. Rieks said that the primary delta is the need to support terms from multiple terminology owners or scopes.
      2. The second question Rieks had was around the use of double percent signs for delimiting terms.
         1. Maria noted that there has already been feedback about the inconvenience of using double percent signs.
         2. The Docusaurus Terminology team is already working on a more convenient method.
         3. This method would use the standard Markdown syntax of square brackets for a term followed by the term path in parathenses.
   5. Rieks summarized that the Docusaurus Terminology tool works primarily between the curation and the production.
   6. Daniel shared that his overall reaction that there are several aspects of how this tool works
      1. It combines the management of raw terminology with the management of those terms within a particular artifact (e.g., a white paper).
      2. Maria clarified that you can generate a glossary without modifying an artifact. 
   7. Daniel then asked more questions about using Docusaurus Terminology with multiple repositories with different owners.
      1. Rieks clarified that Docusaurus Terminology V1 creates a list of the glossary entries from a group of artifacts.
      2. The glossary itself becomes just another document, in which each term used in the definition of another term would itself be a popup and a link.
   8. We discussed what we would need to do an end-to-end lifecycle test.
      1. Pick one white paper.
      2. Make sure it is in the Markdown format needed.
      3. Run it through the Docusaurus Terminology tooling.
      4. See how well it develops the output we need.
   9. Maria offered to help with the documentation.
4. Next steps
   1. Daniel will set up the CTWG Sandbox repo.
   2. Maria will check the steps for GitHub vs. GitLab and update documentation accordingly.
   3. Rieks will provide his SSI governance white paper in the Markdown with the terminology marked in the syntax required by Docusaurus Terminology.
   4. Daniel will hook up the CI/CD pipeline so that it automatically generates a new website based on the output.
   5. Our goal is to demonstrate all of this working at our next meeting in two weeks.
   6. Once that is working, Rieks suggested we can show how other ToIP authors can use these same tools.
5. Review of Decisions and Action Items
6. Next meeting

Slides

From Maria's presentation:

Decisions

• We will proceed with an end-to-end demonstration of how glossary development will work with a single white paper contributed by Rieks.

Action Items

• Daniel Hardman will set up the CTWG Sandbox repo.
• Maria will check the steps for GitHub vs. GitLab and update documentation accordingly.
• Rieks Joosten  will provide his SSI governance white paper in the Markdown with the terminology marked in the syntax required by Docusaurus Terminology.
• Daniel Hardman will hook up the CI/CD pipeline so that it automatically generates a new website based on the output.