This repository is the website and documentation source for Cloud Custodian, built as a static site using mkdocs.
The project solves the problem of maintaining and publishing documentation for Cloud Custodian by providing a centralized repository where documentation content can be authored, versioned, and deployed. It uses mkdocs to transform markdown and configuration files into a static HTML website. The approach leverages Python tooling with Poetry for dependency management, allowing contributors to add plugins and customize the site's appearance and functionality through the mkdocs.yml configuration file.
Developers maintaining Cloud Custodian's documentation should use this repository. It suits teams that want documentation version-controlled alongside code, with the ability to preview changes before merging. The setup requires Python 3.8 or later and Poetry 1.2 or later. Contributors can run the documentation locally during development and pull requests automatically generate staging previews, enabling review of rendered changes before they go live.
Dependency management follows a structured approach using Poetry rather than pip directly, with both pyproject.toml and poetry.lock files committed to version control to ensure reproducible builds across environments.
