Review README
Improve organisation Provide better information Use proper formatting Change-Id: I06aef99300b317843b38d5594b55cf1c4f690a69
This commit is contained in:
parent
6e5c08c5d1
commit
1e20cf3a0f
48
README.rst
48
README.rst
|
@ -1,32 +1,40 @@
|
||||||
========================
|
=================================
|
||||||
Team and repository tags
|
OpenStack Charms Deployment Guide
|
||||||
========================
|
=================================
|
||||||
|
|
||||||
.. image:: http://governance.openstack.org/badges/charm-deployment-guide.svg
|
.. 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`_.
|
||||||
|
|
||||||
================================
|
Building
|
||||||
OpenStack Charm Deployment Guide
|
--------
|
||||||
================================
|
|
||||||
|
|
||||||
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
|
tox
|
||||||
format in the ``deploy-guide/build/html`` directory. View these new documents
|
|
||||||
in your favorite web browser.
|
|
||||||
|
|
||||||
|
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
|
Documentation issues can be filed on `Launchpad`_.
|
||||||
`<https://bugs.launchpad.net/charm-deployment-guide>`__.
|
|
||||||
|
|
||||||
Submissions to this source are controlled via the OpenStack gerrit system at
|
This repository is under version control and is managed via the `OpenStack
|
||||||
`<https://review.openstack.org>`__. If you wish to submit content then please
|
Gerrit system`_ (see the `OpenDev Developer’s Guide`_). For specific guidance
|
||||||
see `<https://docs.openstack.org/infra/manual/developers.html>`__ for details
|
on working with the documentation hosted on https://docs.openstack.org please
|
||||||
on how to submit changes.
|
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
|
||||||
|
|
Loading…
Reference in New Issue