Support documentation for NAISS. These pages are written using Hugo, with the exception of the support/software pages which are written in mkDocs. Both tools however enable to publish material in MarkDown.
- Find instructions at https://www.mkdocs.org/getting-started/
- You need some extra extensions to render these documents
- In order to install attr_list, adminition and superfences
pip install mkdocs-material
- In order to install attr_list, adminition and superfences
The published webpages reside on different location depending if you are changing the support documentation or that main website.
The primary document is available in site
The primary document is available in template/mkdocs.yaml
When site is build this file will act as a template, copied to
the main folder and software information will be added to it.
All the markdown file are found in docs
All the markdown file are found in software
The primary document is available in template/index.md
When site is build this file will act as a template, copied to
the main folder and software information will be added to it.
Also there is a file called clusters.yaml
which directs what softwares will be published by pointing out active clusters, and their os.
Files for different software should be stored under software/[software name]
- general.md Contains general information about the software and a section on how to use the software on clusters
- versions.yaml A YAML file containing information about at which clusters the software is installed and what versions are installed
- keywords.yaml A YAML file containing information about what keywords could be associated with the software
To create material for mkdocs just make build which will create a site folder with all html files
for both hugo and mkdocs. This folder can the be moved to the actual site.
In order to start mkdocs at the local computer use make serve from top level folder and navigate to https://127.0.0.1:1313
In order to publish these documents to the official PDC webportal you need to have those specific access rights to KTH ITA.
Publishing is achieve by running command make public