Glossary

[bdu-birhanu]

Pull Request

Overview

This pull request adds a glossary of terms for our documentation covering essential Research computing system-related terms and concepts.

Proposed Changes

• Added a glossary file containing terms related to RC tools and services.
• Used the mkdocs-ezglossary-plugin which provide the following functionalities:
  • mapping plural/singular terms like GPU/GPUs, module/modules, etc.
  • mapping capitalization variations such as TensorFlow/tensorflow and Quality of Service Limits/quality of service limits.
  • Provides on-hover tooltips and links to the glossary page when glossary terms are clicked.
• Added mkdocs-ezglossary-plugin configuration files to mkdocs.yml.

Related Issues

Fixes #676

[wwarriner]

I am impressed with the amount of work here. I think this is a great start. This will take multiple people reviewing to make sure the glossary is complete and that it is accurate.

I'll take a first look at it and get back to you for the accuracy side. Ultimately, I want other people, outside of the facilitation team, to weigh in on it. I think the other teams will have things to add.

It may also be worth perusing the docs to find terms that were not already in the list I gave you.

We will also want to make it a regular part of our operations to ensure new words get added to the glossary as they come up, and that we are cross-linking back to the glossary. We may consider adding a checklist to our PRs to remind us of steps to take, like this one. I will put in an issue for that.

[wwarriner]

I have some intricate ideas on how to get this one off the ground. Rather than tackle many words and pages at once, let's do one or a few terms at a time. Let's start with what I commented in #922 about PIs and Core Directors.

That said, I don't want you to lose your hard work so far, so I have an idea about how to go about that involving clever branching. We can discuss today at the meeting.