add glossary of abbreviations
The documentation is full of abbreviations. While many are spelled out in some article, the reader did not necessarily read the article with the definition beforehand. Luckily it is quiet easy to add a (basic) glossary:
mkdocs.yml
markdown_extensions:
[…]
- abbr
- pymdownx.snippets
includes/abbreviations.md
*[AAI]: Authentication and Authorisation Infrastructure
*[IDP]: Identity Provider
*[IdP]: Identity Provider
*[VO]: Virtual Organisation
[…]
fd -t f .md docs/ -x sed -i '$ a --8<-- "includes/abbreviations.md"' {}
The result can be seen in the screenshot: Every occurrence of an abbreviation defined in includes/abbreviations.md
(here AAI
) has a mouse over tool tip.
This approach is going for a low hanging fruit. I guess there are plugins for mkdocs which allow other/better forms of glossary.