This repository contains the sources files for the NeSI support documentation.
Rendered pages are visible at https://nesi.github.io/support-docs/.
The repository is organised using the following folders:
checks
: scripts intended to be run by CI,docs
: markdown files, structure determines categories and sections[^1],docs/assets
: non-template related files, e.g. images,overrides
: theme overides or extensions for page templates.overrides/partials
: Overrides and extensions for sub components.[^1]: A section or category can be replaced by an index.md
file, this will replace the default nav with a page.
Following pages contain information to help maintain the documentation:
mkdocs-macros-plugin
environment.We are using the mkdocs material theme.
The site uses Google analytics. You will need to ask a google workspace admin to add you to the project.
Migration of the Zendesk documentation is done using our migration pipeline (NeSI internal GitLab.
Any one off filters (e.g. don't need to be checked every time, just when converting from ZD) should go there.