openstack
/
charm-guide
Code Issues Proposed changes
OpenStack Charms development and usage documentation
395 Commits 10 Branches 0 Tags 8.5 MiB
Python 100%
Go to file
Peter Matulis 892413a875 Update .gitreview for wallaby branch 
Change-Id: Ie1dd5e700bf436d134bd0bd832b0b48cae119bbf
 		2021-05-11 16:40:31 -04:00
doc/source Update find-us page 2021-05-11 18:39:28 +00:00
.gitignore Initial baseline of OpenStack Charm documentation 2016-06-20 11:59:38 +01:00
.gitreview Update .gitreview for wallaby branch 2021-05-11 16:40:31 -04:00
.zuul.yaml Update docs job 2019-05-19 14:06:57 +02:00
HACKING.rst Add deploy guide link and release schedules 2017-11-27 19:52:38 +00:00
LICENSE Initial baseline of OpenStack Charm documentation 2016-06-20 11:59:38 +01:00
README.md Convert README to markdown 2021-03-24 15:10:23 -04:00
rebuild Rebuild to republish 2018-06-11 16:15:04 -05:00
requirements.txt Switch to newer openstackdocstheme version 2020-05-31 20:18:01 +02:00
setup.cfg Convert README to markdown 2021-03-24 15:10:23 -04:00
setup.py Initial baseline of OpenStack Charm documentation 2016-06-20 11:59:38 +01:00
tox.ini Update doc tools for the charm guide 2019-10-29 10:12:02 -04:00

README.md

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 Developer’s Guide). For specific guidance on working with the documentation hosted on docs.openstack.org please read the OpenStack Documentation Contributor Guide.