openstack
/
charm-guide
Code Issues Proposed changes
OpenStack Charms development and usage documentation
610 Commits 10 Branches 0 Tags 8.5 MiB
Python 100%
Go to file
Peter Matulis 75c3a0a89c Copy security pages from deploy-guide 
This PR is part of the ongoing work to migrate pages
from the deploy-guide to the charm-guide that are not
specific to a manual test cloud deployment.

The filename for the TLS page was renamed to tls.rst .

Some links necessarily needed to be changed in some
files.

Two trivial format corrections were made:

 i) in keystone.rst
    _keyston_tokens: => _keystone_tokens:

ii) in tls.rst
    csr => CSR

Change-Id: I20e89f4daa21f853ebaec8d928a7d0dc479512d8
 		2022-07-22 21:10:30 -04:00
doc Copy security pages from deploy-guide 2022-07-22 21:10:30 -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 Improve build targets 2022-05-19 13:58:44 -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 Developer’s Guide). The Documentation contributions page outlines how to contribute to this project.

Bugs

Documentation issues can be filed on Launchpad.