This repository contains the source for the Canonical OpenStack documentation.
Canonical OpenStack is an enterprise-grade cloud platform that delivers distilled upstream OpenStack excellence in a human-friendly product. It provides elastic, on-demand compute, network, and storage resources through a self-service portal or upstream OpenStack APIs.
The documentation follows the Diátaxis framework:
- Tutorials – Hands-on introduction for new users
- How-to guides – Step-by-step guides for key operations and common tasks
- Reference – Technical specifications, APIs, architecture
- Explanation – Discussion and clarification of key topics
- Python 3.10+
makegit
git clone git@github.com:canonical/canonical-openstack-docs.git
cd canonical-openstack-docs/docs
make html serveTo preview with live reload at http://127.0.0.1:8000:
make runmake spelling # Check spelling
make linkcheck # Validate links
make woke # Check inclusive language
make lint-md # Check Markdown style
make vale # Check style guide compliance (optional)We welcome contributions! See CONTRIBUTING.md for guidelines on:
- Reporting issues
- Development setup
- Making changes
- Running tests
- Opening pull requests
- Code review process
- Fork the repository
- Create a branch:
git checkout -b <issue-id>-<description> - Make your changes in the
docs/directory - Build and test locally:
cd docs && make html && make spelling && make linkcheck - Commit with a signed commit:
git commit -S -m "feat: your change" - Push and open a PR
All contributions require a signed Canonical Contributor License Agreement.
This documentation is licensed under GPL-3.0.