search

uabrc / uabrc.github.io

UAB Research Computing Documentation
https://docs.rc.uab.edu
21 stars 11 forks source link

Consider adding a glossary of RC terms #676

Open wwarriner opened 4 months ago

wwarriner commented 4 months ago

What would you like to see added?

Check out here for an example: https://hpcc.umd.edu/hpcc/help/glossary.html

Maybe we can add our own glossary with relevant terms. There is a mkdocs-material plugin that may make this simpler: https://squidfunk.github.io/mkdocs-material/reference/tooltips/#adding-a-glossary

wwarriner commented 3 weeks ago

Results from testing mkdocs-ezglossary-plugin (GitHub). Works well, seems suitable for our use-case. Definitions and links are straightforward, and the links have an on-hover tooltip. It's not clear how to map synonyms and alternate word forms to the same definition. In other words, mapping "GPU" and "GPUs" to the same definition isn't clear.

I can't find anything in mkdocs-material nor mkdocs-ezglossary-plugin documentation that shows how to simplify this, short of duplicating definition content.