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.

Documentation Structure

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

Quickstart

Prerequisites

Python 3.10+
make
git

Build Locally

git clone git@github.com:canonical/canonical-openstack-docs.git
cd canonical-openstack-docs/docs
make html serve

To preview with live reload at http://127.0.0.1:8000:

make run

Run Checks Locally

make 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)

Contributing

We welcome contributions! See CONTRIBUTING.md for guidelines on:

Reporting issues
Development setup
Making changes
Running tests
Opening pull requests
Code review process

Quick Contribution Steps

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

Documentation Structure

Quickstart

Prerequisites

Build Locally

Run Checks Locally

Contributing

Quick Contribution Steps

Community and Support

Community (Sunbeam / Open Source)

Commercial (Canonical OpenStack)

License