These are the user docs for STFC Cloud's Azimuth deployment. They provide information for users specific to our deployment.
Azimuth is a self-service portal for managing cloud resources with a particular focus on simplifying the use of cloud for scientific computing, high-performance computing (HPC) and artificial intelligence (AI). Learn more...
Unlike most STFC Cloud user docs which are on Confluence, these are maintained on Github Pages, built with MKDocs via GitHub actions:
- They are a fork, this lets us maintain parity, allowing us in future to pull upstream changes
- They are self-contained, for linking to from Azimuth
- They use features (code block annotations, in-sentence images, in-page ToC, font-awesome icons, custom svg emojis) that aren't present in confluence
These docs have been forked from the generic Azimuth user docs. At the time of writing, these are incomplete and reference obsoleted features and deployment methods like Kubeapps, so have been majority rewritten.
The Apache License 2.0 has been maintained.
Contributions are welcomed via pull request.
These docs are produced with mkdocs-material
To get started, after making an environment (venv/conda etc), a requirements.txt file has been provided for easy local setup.
I.e., for conda:
conda create -n mkdocs
conda activate mkdocs
pip install -r requirements.txt --upgradeDocs can then be served locally and will update live:
mkdocs serveA link to the docs will be shown, but it defaults to http://127.0.0.1:8000
- Docs configuration (plugins, navigation, theme) is done in mkdocs.yml.
- Doc pages are in ./docs/
- Images and custom icons are stored in ./docs/assets
- The build process is configured in ./.github/workflows /deploy-pages.yml