dc42e0532a
Convert the README file from reST to markdown as the GitHub support for reST is poor (the current links are broken) and it's more consistent with the charms to have a README in markdown. The CG is being changed in the same way: https://review.opendev.org/c/openstack/charm-guide/+/782845 Change-Id: I20107e9d8ea8945d7138f1c5d2609b46519d3d42
1.5 KiB
1.5 KiB
OpenStack Charms Deployment Guide
The OpenStack Charms Deployment Guide is the main source of information for the usage of the OpenStack Charms.
Building
To build the guide run this simple command:
tox
The resulting HTML files will be found in the deploy-guide/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.