7a42b0dd9d
This PR will also be used to generate a 2023.2 version of the Charm Guide. Change-Id: I61ef59b3b03847a6746cf1dea5d59ad69690e61d Signed-off-by: Peter Matulis <peter.matulis@canonical.com> |
||
---|---|---|
doc | ||
.gitignore | ||
.gitreview | ||
.zuul.yaml | ||
HACKING.rst | ||
LICENSE | ||
README.md | ||
bindep.txt | ||
rebuild | ||
requirements.txt | ||
setup.cfg | ||
setup.py | ||
tox.ini |
README.md
OpenStack Charm Guide
The OpenStack Charm Guide is the main source of information for the OpenStack Charms.
Building
To build the guide run this simple command:
tox
The resulting HTML files will be found in the doc/build/html
directory. These
can be opened individually with a web browser or hosted by a local web server.
Contributing
This repository is under version control and is managed via the OpenStack Gerrit system (see the OpenDev Developer’s Guide). The Documentation contributions page outlines how to contribute to this project.
Bugs
Documentation issues can be filed on Launchpad.