Build

Development

1. Install Python.

2. Set up the local virtual environment.

   ./setup-venv.sh

3. Activate the virtual environment and serve the site.

   source venv/bin/activate
   mkdocs serve
   open http://localhost:8000
   

Deployment

• Opening a PR will run the GitHub action to build the site.
• Pushing changes to the main branch will trigger the GitHub action to build and deploy the site.

Known Issues

The mkdocs-markdownextradata-plugin does not handle the Ansible pages well, because they embed Jinja expressions and there does not appear to be a way to escape those characters in that context.