Contributing to the Documentation #

The documentation site is hosted on GitHub Pages
The site is generated using Hugo

Pre-requisits #

To work on the documentation you will need:

1. A text file editor, preferably with Markdown support.
2. Hugo installed locally to test the changes.
3. Task - to run the taskfile tasks.

How-To #

The documentation sits in the docs/site folder.
The content sits in the content folder. and static files such as images and samples reside in the static folder.

To view local changes before pushing, run:

task run-docs-site

This will run Hugo locally and open them in a new Tab.

Helm Chart Documentation #

If changes were made to the Helm chart parameters, we also need to update the helm chart documentation.

To update them, run:

task helm-docs