IP Fabric Documentation Project

We are using MkDocs with the excellent Material for MkDocs. Last but not least, there is mike, which is a tool for building and publishing different versions of the documentation.

Release Process

One of the main motivations for migrating towards Markdown-based documentation is the ability to follow a standard development model. Thus, any update to the documentation happens as follows:

• Create your “feature” branch. It is good practice to include a ticket number at the beginning. For example, NIM-5808_readme.
• Do all your commits in the branch. When ready, open a merge request (MR) on GitLab (also make sure that it starts with your ticket number, correctly formatted).
• Set yourself as the assignee (as you are the owner of the MR).
• At the moment, please set the reviewer to @antonin.kral-ipf and/or @zdenek.sindylek-ipf for all your MRs.
• The CI/CD pipeline builds and publishes on every push to main.
• mike is then used by repository maintainers to push a new version release to the documentation web. (See the…