versioning
In order to support different versions of a documentation, we should stick to the recommendations by mkdocs-material. However, since our primary server is a gitlab server (and not github) we need a slightly different CI-routine.
In short:
- the mkdocs build output is stored in a separate branch (
gl-pages
) - with each new tag, mike is invoked to build a new directory containing the tagged version which is then added to the
gl-pages
branch and is pushed to origin - defining a default version (
mkdocs.yml
:extra;version:default:<alias>
) ensures that other versions than the default will show a warning if set up like this
The current hand-made solution should be therefore replaced.