Documentation

This documentation site is generated from our GitLab repository using mkdocs with the material theme, like the other CentOS SIG and infra documentation.

To test changes, run make test, which serves the site on http://localhost:8000/proposed_updates/, or make build to render the static site into site/. make build uses --strict, as CI does, so broken links fail the build. To view the site from another machine (e.g. when working in a VM), run make test ADDR=0.0.0.0:8000 and use the machine's address instead of localhost.

Both use the system mkdocs if it can load the material theme (on Fedora: dnf install mkdocs mkdocs-material), and otherwise install mkdocs-material into a local Python virtual environment.

If you have podman, make podman-test and make podman-build do the same using the mkdocs-material container image that CI uses.