📚️ Documentation
Docs are published via Cloudflare Pages and protected from the public using Access.
Contributing
You can contribute to the docs by clicking on the Contributing tab in the sidebar. This repo uses mkdocs static site generator and located in the documentation dir.
Running documentation locally
Running locally can most easily be done using mkdocs via a Python virtual environment.
Running docs locally
cd documentation
python3 -m venv venv
source venv/bin/activate
pip install mkdocs mkdocs-material
mkdocs serve
Publishing documentation locally
Deploying docs locally with cfdev
cfdev cibuild --rebuild-helper --file ./.teamcity/docker-compose.yaml build-publish-docs
Important note if publishing docs locally
You will need to set the CLOUDFLARE_API_TOKEN for the Internal Stream Apps account that should have edit permissions for Cloudflare Pages. This is used by ci-builders local build which injects it into Docker.