GÉANT Automation Platform

Documentation for the GÉANT Automation Platform (GAP)

Writing documentation

First, create a venv to work in: python3 -m venv venv

Then, install mkdocs-material: pip install mkdocs-material

To run the live preview server of MkDocs - which includes hot reloading - run mkdocs serve.

Testing documentation

To verify that documentation passes the linting pipeline, install vale with pip install vale and then run vale --config=vale/.vale.ini docs/.