openstack
/
operations-guide
Code Issues Proposed changes

Rename README to README.rst 

The file uses already the RST format in most cases. Let's rename
it so that it gets displayed nicely on github. Reformat a few
pieces to follow RST format.

Change-Id: I38b6bcdc282b23d09a3a2dc409e85caf60e1dafe
This commit is contained in:
Andreas Jaeger 2014-02-02 12:22:35 +01:00
parent ea44cf7b21
commit 490a1bd561
1 changed files with 9 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
README → README.rst
View File

@ -1,3 +1,7 @@
OpenStack Operations Guide
+++++++++++++++++++
This repository contains the source files for the OpenStack Operations Guide.
You can read this guide at `docs.openstack.org/ops <http://docs.openstack.org/ops>`_.
@ -43,10 +47,11 @@ 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 checkniceness" - to run the niceness tests
* "tox -e checksyntax" - to run syntax checks
* "tox -e checkdeletions" - to check that no deleted files are referenced
* "tox -e checkbuild" - to actually build the manual
* ``tox -e checkniceness`` - to run the niceness tests
* ``tox -e checksyntax`` - to run syntax checks
* ``tox -e checkdeletions`` - to check that no deleted files are referenced
* ``tox -e checkbuild`` - to actually build the manual
tox will use the openstack-doc-tools package for execution of these
tests.