openstack/openstack-manuals
Code Issues Proposed changes

Cleanup README

Browse Source 
Change-Id: I9e1ff4d53ad8aab78a5e99657ec6465868fbae77
This commit is contained in:
KATO Tomoyuki 2016-10-14 11:15:41 +09:00
parent 35c188916a
commit 7494461c72
1 changed files with 11 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
README.rst
View File

@ -15,7 +15,7 @@ It includes these manuals:
* Documentation Contributor Guide * Documentation Contributor Guide
* End User Guide * End User Guide
* High Availability Guide * High Availability Guide
* Installation Guide * Installation Tutorials
* Networking Guide * Networking Guide
* Operations Guide * Operations Guide
* Virtual Machine Image Guide * Virtual Machine Image Guide
@ -33,16 +33,16 @@ Various manuals are in subdirectories of the ``doc/`` directory.
Guides Guides
------ ------
All guides are in the RST format. You can use tox to prepare All guides are in the RST format. You can use ``tox`` to prepare
virtual environment and build all guides:: virtual environment and build all guides::
tox -e docs $ tox -e docs
You can also build a specific guide. You can also build a specific guide.
For example, to build *OpenStack End User Guide*, use the following command:: For example, to build *OpenStack End User Guide*, use the following command::
tox -e build -- user-guide $ tox -e build -- user-guide
You can find the root of the generated HTML documentation at:: You can find the root of the generated HTML documentation at::
@ -58,10 +58,10 @@ gating jobs.
If you like to run individual tests, run: If you like to run individual tests, run:
* ``tox -e linkcheck`` - to run the tests for working remote URLs
* ``tox -e checkniceness`` - to run the niceness tests
* ``tox -e checkbuild`` - to actually build the manual * ``tox -e checkbuild`` - to actually build the manual
* ``tox -e checklang`` - to build translated manuals * ``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 tox will use the openstack-doc-tools package for execution of these
tests. tests.
@ -72,11 +72,11 @@ Contributing
Our community welcomes all people interested in open source cloud Our community welcomes all people interested in open source cloud
computing, and encourages you to join the `OpenStack Foundation computing, and encourages you to join the `OpenStack Foundation
<http://www.openstack.org/join>`_. <https://www.openstack.org/join>`_.
The best way to get involved with the community is to talk with others 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, online or at a meet up and offer contributions through our processes,
the `OpenStack wiki <http://wiki.openstack.org>`_, blogs, or on IRC at the `OpenStack wiki <https://wiki.openstack.org>`_, blogs, or on IRC at
``#openstack`` on ``irc.freenode.net``. ``#openstack`` on ``irc.freenode.net``.
We welcome all types of contributions, from blueprint designs to We welcome all types of contributions, from blueprint designs to
@ -90,9 +90,9 @@ Generated files
--------------- ---------------
Some documentation files are generated using tools. These files include Some documentation files are generated using tools. These files include
a ``do not edit`` header and should not be modified by hand. Please see a ``do not edit`` header and should not be modified by hand.
`Generated files Please see `Generated files
<http://docs.openstack.org/contributor-guide/tools-and-content-overview.html#Generated-files/>`_. <http://docs.openstack.org/contributor-guide/doc-tools.html>`_.
Bugs Bugs