CSC dictionary

[rkronberg]

Proposed changes

AI generated. Needs a proper proof-reading!

Edit: proof-read once and improved accordingly. Does not hurt if another pair of eyes checks as well.

https://csc-guide-preview.2.rahtiapp.fi/origin/dictionary/support/faq/csc-dictionary/

Checklist before requesting a review

• I have followed the instructions in the Contributing and Styleguide documents.
• My pull request passes the automated tests. If not, visit pull requests at Travis CI and have a look at the job log.
• I have included a link to the appropriate preview page (select your branch from the list).

[samumantha]

Thanks! I think in general having something like this is good for new users.
I am however wondering if adding a new page is the best way here. There is already the glossary, could that be expanded and used to link words from the rest of the documentation?
Or in the form of cheatsheet(s) (something that people could have open while working with a certain service) ?
In addition, some of the terms presented here also have alternative words used in some courses or even docs, which could be mentioned.

[rkronberg]

The glossary page is also used to generate the tool-tips used throughout docs. I'm unsure if adding any other content on that page would actually break the functionality. Does @joonas-somero know?

IMHO, a list of abbreviations and explanations of HPC terminology make sense to have on different pages, as the intentions are a bit different, right? Perhaps this is just a matter of taste. Anyway, the possible technical limitation mentioned above remains.

This was just something I quickly created, and I do not unfortunately have time to continue refining it right now. Maybe we can publish, and improve it later? Or if you Samantha have time to take over this, feel free!

[rkronberg]

The page also now does not include any links. Those could be added as well.

[samumantha]

Tool tips could also work well for the terminology?

[samumantha]

About publishing and improving later: Please assign someone else for review, also short on time right now (and limited knowledge on some of the terms myself.

[joonas-somero]

The glossary page is also used to generate the tool-tips used throughout docs. I'm unsure if adding any other content on that page would actually break the functionality. Does @joonas-somero know?

It seems that at some point the glossary page support/glossary.md has had its generation script result committed. It is supposed to only have a note saying the page will be generated during deployment. The actual glossaries are in csc-overrides/assets/snippets/glossaries/. The purpose of the generated page is just to have an actual page that shows all of the entries in one place.