openstack
/
charm-deployment-guide
Code Issues Proposed changes

Review README 

Improve organisation

Provide better information

Use proper formatting

Change-Id: I06aef99300b317843b38d5594b55cf1c4f690a69
This commit is contained in:
Peter Matulis 2021-02-12 15:43:51 -05:00
parent 6e5c08c5d1
commit 1e20cf3a0f
1 changed files with 29 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

50
README.rst
View File

@ -1,32 +1,40 @@
========================
Team and repository tags
========================
=================================
OpenStack Charms Deployment Guide
=================================
.. image:: http://governance.openstack.org/badges/charm-deployment-guide.svg
:target: http://governance.openstack.org/reference/tags/index.html
:target: http://governance.openstack.org/reference/tags/index.html
.. Change things from this point on
The `OpenStack Charms Deployment Guide`_ is the main source of information for
the usage of the `OpenStack Charms`_.
================================
OpenStack Charm Deployment Guide
================================
Building
--------
To build the guide, execute the following command::
To build the guide run this simple command:
$ tox
.. code-block:: none
After running ``tox``, the documentation will be available for viewing in HTML
format in the ``deploy-guide/build/html`` directory. View these new documents
in your favorite web browser.
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.
Submitting changes to this documentation
----------------------------------------
Contributing
------------
If you wish to raise an issue against the documentation, please do so at
`<https://bugs.launchpad.net/charm-deployment-guide>`__.
Documentation issues can be filed on `Launchpad`_.
Submissions to this source are controlled via the OpenStack gerrit system at
`<https://review.openstack.org>`__. If you wish to submit content then please
see `<https://docs.openstack.org/infra/manual/developers.html>`__ for details
on how to submit changes.
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 https://docs.openstack.org please
read the `OpenStack Documentation Contributor Guide`_.
.. LINKS
.. _OpenStack Charms Deployment Guide: https://docs.openstack.org/project-deploy-guide/charm-deployment-guide
.. _OpenStack Charms: https://launchpad.net/openstack-charms
.. _Launchpad: https://bugs.launchpad.net/charm-deployment-guide/+filebug
.. _OpenStack Gerrit system: https://review.openstack.org
.. _OpenDev Developer’s Guide: https://docs.openstack.org/infra/manual/developers.html
.. _OpenStack Documentation Contributor Guide: https://docs.openstack.org/doc-contrib-guide/index.html