This is internal documentation and guiding principles for how the CIMORe group uses the HUNT Cloud platform. It is meant as a reference document to ensure common practices.
This documentation is markdown-based. To suggest a change or addition, edit or add a new markdown file to the docs folder. The repository is set up with github actions to automatically rebuild after a new commit to the main branch. If a new markdown file is added, make sure to add it to the nav in the mkdocs.yml file.
We try to stick to fairly standard markdown to keep the documentation portable. See the mkdocs.yml file for the extensions we are currently using. Currently only the admonitions extension is in use.
This documentation is build using the Material theme for MkDocs. Please refer to the documentation for the Material theme if you want to make more advanced edits to the documentation. In this case, make sure to host the page locally to make sure that the modifications works as intended before pushing to github.