openstack
/
charm-guide
Code Issues Proposed changes
OpenStack Charms development and usage documentation
479 Commits 10 Branches 0 Tags 8.5 MiB
Python 100%
Go to file
Peter Matulis c98fe888ea Move howto contents to admin directory 
This is needed because it was discovered that the
"admin guide" link from upstream (docs.openstack.org)
cannot be a redirect (to our current howto dir). I
like the new organisation better anyway.

Conflicts:
  doc/test/redirect-tests.txt - fix tests up since admin cannot
  be redirected to howto and this change makes it such that howto
  redirects to admin

(cherry picked from commit 8bf87e2c8a)

Change-Id: Ia62536914f00e4721cb72a394920fa47bda306dd
 		2022-01-26 18:14:33 -07:00
doc Move howto contents to admin directory 2022-01-26 18:14:33 -07:00
.gitignore Initial baseline of OpenStack Charm documentation 2016-06-20 11:59:38 +01:00
.gitreview Update .gitreview for stable/xena branch 2021-10-27 14:40:12 -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 Migration follow-up 2021-10-20 21:27:20 -04:00
rebuild Rebuild to republish 2018-06-11 16:15:04 -05:00
requirements.txt Refactor Charm Guide 2021-10-04 20:38:11 -07: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 Refactor Charm Guide 2021-10-04 20:38:11 -07:00

README.md

OpenStack Charm Guide

tags

The OpenStack Charm Guide is the main source of information for the 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

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.