NeSI support documentation

This repository contains the sources files for the NeSI support documentation.

Rendered pages are visible at https://nesi.github.io/support-docs/.

Warning This is a beta version and should not be considered as the official documentation. The official documentation is accessible at https://support.nesi.org.nz.

Contents

The repository is organised using the following folders:

• checks : scripts intended to be run by CI,
• docs: markdown files, structure determines categories and sections¹,
• 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.

Developer Documentation

Following pages contain information to help maintain the documentation:

• See contributing (local version), to learn how to you can contribute.
• See formatting, for examples of markdown syntax.
• See create a new page, for general principles to consider when writing pages.
• See macros, for mkdocs-macros-plugin environment.
• See checks, for information on quality assurance tests.
• See workflows, for information on CI workflows.

Theme

We are using the mkdocs material theme.

Analyics

The site uses Google analytics. You will need to ask a google workspace admin to add you to the project.

Migration

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.

Footnotes

1. A section or category can be replaced by an index.md file, this will replace the default nav with a page. ↩