charm-guide/README.md

1.5 KiB
Raw Permalink Blame History

OpenStack Charm Guide

tags

The OpenStack Charm Guide is the main source of information for the development of the OpenStack Charms. Release notes and support notes are also to be found here.

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

Documentation issues can be filed on Launchpad.

This repository is under version control and is managed via the OpenStack Gerrit system (see the OpenDev Developers Guide). For specific guidance on working with the documentation hosted on docs.openstack.org please read the OpenStack Documentation Contributor Guide.