e73cf31813
This patch adds the team's and repository's badges to the README file. The motivation behind this is to communicate the project status and features at first glance. For more information about this effort, please read this email thread: http://lists.openstack.org/pipermail/openstack-dev/2016-October/105562.html To see an example of how this would look like check: b'https://gist.github.com/326db469cfd3580aa8fe949a671348fd\n' Change-Id: I28487d4403825604a6c7e298ddf06e2dde4ee5df
120 lines
3.1 KiB
ReStructuredText
120 lines
3.1 KiB
ReStructuredText
========================
|
|
Team and repository tags
|
|
========================
|
|
|
|
.. image:: http://governance.openstack.org/badges/openstack-manuals.svg
|
|
:target: http://governance.openstack.org/reference/tags/index.html
|
|
|
|
.. Change things from this point on
|
|
|
|
OpenStack Manuals
|
|
+++++++++++++++++
|
|
|
|
This repository contains documentation for the OpenStack project.
|
|
|
|
For more details, see the `OpenStack Documentation Contributor
|
|
Guide <http://docs.openstack.org/contributor-guide/>`_.
|
|
|
|
It includes these manuals:
|
|
|
|
* Administrator Guide
|
|
* Architecture Design Guide
|
|
* Command-Line Interface Reference
|
|
* Configuration Reference
|
|
* Documentation Contributor Guide
|
|
* End User Guide
|
|
* High Availability Guide
|
|
* Installation Tutorials
|
|
* Networking Guide
|
|
* Operations Guide
|
|
* Virtual Machine Image Guide
|
|
|
|
In addition to the guides, this repository contains:
|
|
|
|
* docs.openstack.org contents: ``www``
|
|
|
|
|
|
Building
|
|
========
|
|
|
|
Various manuals are in subdirectories of the ``doc/`` directory.
|
|
|
|
Guides
|
|
------
|
|
|
|
All guides are in the RST format. You can use ``tox`` to prepare
|
|
virtual environment and build all guides::
|
|
|
|
$ tox -e docs
|
|
|
|
You can also build a specific guide.
|
|
|
|
For example, to build *OpenStack End User Guide*, use the following command::
|
|
|
|
$ tox -e build -- user-guide
|
|
|
|
You can find the root of the generated HTML documentation at::
|
|
|
|
doc/user-guide/build/html/index.html
|
|
|
|
|
|
Testing of changes and building of the manual
|
|
=============================================
|
|
|
|
Install the Python tox package and run ``tox`` from the top-level
|
|
directory to use the same tests that are done as part of our Jenkins
|
|
gating jobs.
|
|
|
|
If you like to run individual tests, run:
|
|
|
|
* ``tox -e checkbuild`` - to actually build the manual
|
|
* ``tox -e checklang`` - to build translated manuals
|
|
* ``tox -e checkniceness`` - to run the niceness tests
|
|
* ``tox -e linkcheck`` - to run the tests for working remote URLs
|
|
|
|
tox will use the openstack-doc-tools package for execution of these
|
|
tests.
|
|
|
|
|
|
Contributing
|
|
============
|
|
|
|
Our community welcomes all people interested in open source cloud
|
|
computing, and encourages you to join the `OpenStack Foundation
|
|
<https://www.openstack.org/join>`_.
|
|
|
|
The best way to get involved with the community is to talk with others
|
|
online or at a meet up and offer contributions through our processes,
|
|
the `OpenStack wiki <https://wiki.openstack.org>`_, blogs, or on IRC at
|
|
``#openstack`` on ``irc.freenode.net``.
|
|
|
|
We welcome all types of contributions, from blueprint designs to
|
|
documentation to testing to deployment scripts.
|
|
|
|
If you would like to contribute to the documents, please see the
|
|
`OpenStack Documentation Contributor Guide
|
|
<http://docs.openstack.org/contributor-guide/>`_.
|
|
|
|
Generated files
|
|
---------------
|
|
|
|
Some documentation files are generated using tools. These files include
|
|
a ``do not edit`` header and should not be modified by hand.
|
|
Please see `Generated files
|
|
<http://docs.openstack.org/contributor-guide/doc-tools.html>`_.
|
|
|
|
|
|
Bugs
|
|
====
|
|
|
|
Bugs should be filed on Launchpad, not GitHub:
|
|
|
|
https://bugs.launchpad.net/openstack-manuals
|
|
|
|
|
|
Installing
|
|
==========
|
|
|
|
Refer to http://docs.openstack.org to see where these documents are published
|
|
and to learn more about the OpenStack project.
|