From 7494461c720b99f02f398790e84bafd76371ee53 Mon Sep 17 00:00:00 2001 From: KATO Tomoyuki Date: Fri, 14 Oct 2016 11:15:41 +0900 Subject: [PATCH] Cleanup README Change-Id: I9e1ff4d53ad8aab78a5e99657ec6465868fbae77 --- README.rst | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/README.rst b/README.rst index 3e6004194d..0ecd388149 100644 --- a/README.rst +++ b/README.rst @@ -15,7 +15,7 @@ It includes these manuals: * Documentation Contributor Guide * End User Guide * High Availability Guide - * Installation Guide + * Installation Tutorials * Networking Guide * Operations Guide * Virtual Machine Image Guide @@ -33,16 +33,16 @@ Various manuals are in subdirectories of the ``doc/`` directory. 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:: - tox -e docs + $ 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 + $ tox -e build -- user-guide 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: - * ``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 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. @@ -72,11 +72,11 @@ Contributing Our community welcomes all people interested in open source cloud computing, and encourages you to join the `OpenStack Foundation -`_. +`_. 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 `_, blogs, or on IRC at +the `OpenStack wiki `_, blogs, or on IRC at ``#openstack`` on ``irc.freenode.net``. 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 -a ``do not edit`` header and should not be modified by hand. Please see -`Generated files -`_. +a ``do not edit`` header and should not be modified by hand. +Please see `Generated files +`_. Bugs