Contributing to documentation

Getting started

git clone https://git.hep.kbfi.ee/hpc/docs.git

In order to add a new page, create a markdown file and add the entry in the mkdocs.yml file, under nav

Local testing

Please preview your changes before publishing your changes in git. For this purpose one can set up MkDocs locally by installing mkdocs with the necessary extensions:

pip install mkdocs \
            mkdocs-git-revision-date-localized-plugin \
            mkdocs-encryptcontent-plugin \
            mkdocs-material \
            materialx \
            pymdown-extensions

And then in order to preview your documentation as you work on it use the built-in dev-server by running mkdocs serve in the same directory where the mkdocs.yml configuration file is located.

Publish your changes

Add your files, commit and push back to repo.

git add file
git commit -m "Commit message regarding what you did"
git push

General tips

Break long lines of text into shorter ones to make future editing easier. Two consecutive lines would still be considered as single paragraph by MkDocs;
Likewise, use backslash (\) to break longer lines in code block.