This repository contains the documentation for the Canonical Identity Platform.
The documentation is built using Sphinx and is automatically published to Read the Docs. It utilizes Canonical's documentation standards to provide a comprehensive guide to architecture, deployment, and integration of the identity stack.
See the full documentation: https://canonical-identity.readthedocs-hosted.com/
This section outlines the layout of this repository and the purpose of key directories.
This directory contains the source files for the documentation, primarily written in reStructuredText (.rst).
To build and preview the documentation locally in your browser:
- Navigate to the root directory.
- Run
make run.
This directory serves as the central storage for all visual assets, including architecture and sequence diagrams, and component illustrations.
This directory contains the CI/CD configurations used for documentation quality assurance.
- Build checks: Automated tests verify that the documentation builds without errors.
- Link & Spelling checks: Workflows ensure all internal/external links are valid and the text follows standard spelling conventions.
- Read the Docs Integration: Merges to the main branch trigger an automatic deployment to the live documentation site via a webhook integration.
We warmly welcome contributions to the Canonical Identity Platform documentation! Whether it's fixing a typo, improving a technical explanation, or adding a new guide, your help is appreciated.
- Fork the repository and create a new branch for your changes.
- Ensure your documentation follows the Canonical Documentation Style Guide.
- Open a Pull Request and describe the changes you've made.
Please read and sign our Contributor Licence Agreement (CLA) before submitting any changes.