diff --git a/README b/README deleted file mode 100644 index 15dc24077..000000000 --- a/README +++ /dev/null @@ -1,15 +0,0 @@ -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 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. diff --git a/README.rst b/README.rst new file mode 100644 index 000000000..086bb4ba6 --- /dev/null +++ b/README.rst @@ -0,0 +1,99 @@ +API-Site Repository ++++++++++++++++++++ + +This repository contains documentation for the OpenStack project. + +For more details, see the `OpenStack Documentation wiki page +`_. + +It includes these manuals: + + * API Quick Start + * API Complete Reference + +In addition to these, this repository contains: + + * api.openstack.org: ``www`` + + +Prerequisites +============= +`Apache Maven `_ must be installed to build the +documentation. + +To install Maven 3 for Ubuntu 12.04 and later,and Debian wheezy and later:: + + apt-get install maven + +On Fedora 15 and later:: + + yum install maven3 + +Building +======== +The manuals are in the ``api-quick-start`` and ``api-ref`` +directories. + +To build a specific guide, look for a ``pom.xml`` file within a subdirectory, +then run the ``mvn`` command in that directory. For example:: + + cd api-quick-start + mvn clean generate-sources + +The generated PDF documentation file is:: + + api-quick-start/target/docbkx/webhelp/api-quick-start-onepager-external/api-quick-start-onepager.pdf + +The root of the generated HTML documentation is:: + + api-quick-start/target/docbkx/webhelp/api-quick-start-onepager-external/content/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 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. openstack-doc-tools has a requirement on maven for the +build check. + + +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 meetup and offer contributions through our processes, the `OpenStack +wiki `_, 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 +`Documentation HowTo `_. + +Bugs +==== + +Bugs should be filed on Launchpad, not GitHub: + + https://bugs.launchpad.net/openstack-api-site/ + + +Installing +========== +Refer to http://docs.openstack.org to see where these documents are published +and to learn more about the OpenStack project.