OpenStack Charms development and usage documentation
Go to file
Peter Matulis d0684259c7 Finalise 22.04/Yoga release notes
Change-Id: I0972d5ebc3c121906a154ee61668861451b55f39
2022-05-05 12:49:27 -04:00
doc Finalise 22.04/Yoga release notes 2022-05-05 12:49:27 -04:00
.gitignore Initial baseline of OpenStack Charm documentation 2016-06-20 11:59:38 +01:00
.gitreview OpenDev Migration Patch 2019-04-19 19:39:52 +00:00
.zuul.yaml Add a spellchecker 2022-04-11 12:45:10 -04: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 Enhance doc contribution guidelines 2022-03-14 11:23:19 -04:00
bindep.txt Add a spellchecker 2022-04-11 12:45:10 -04:00
rebuild Rebuild to republish 2018-06-11 16:15:04 -05:00
requirements.txt Add new charm delivery page - Charmhub 2022-04-29 18:45:30 -04: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 Add a spellchecker 2022-04-11 12:45:10 -04:00

README.md

OpenStack Charm Guide

tags

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 Developers Guide). The Documentation contributions page outlines how to contribute to this project.

Bugs

Documentation issues can be filed on Launchpad.