diff options
author | Jenkins <jenkins@review.openstack.org> | 2014-12-08 21:29:24 +0000 |
---|---|---|
committer | Gerrit Code Review <review@openstack.org> | 2014-12-08 21:29:25 +0000 |
commit | ae0488773ccad21e6626d88a1ff49d8b38af4c10 (patch) | |
tree | 6577663c0e7cdf808818f60eeb77f37ff6c9e766 /CONTRIBUTING.rst | |
parent | 50418b5ca9de7df254f339bb21096b126d1b5058 (diff) | |
parent | 28e8fcf0ee3f7423e0f128bf0aafbff120450378 (diff) | |
download | trove-ae0488773ccad21e6626d88a1ff49d8b38af4c10.tar.gz |
Merge "Clean up github references from docs"
Diffstat (limited to 'CONTRIBUTING.rst')
-rw-r--r-- | CONTRIBUTING.rst | 75 |
1 files changed, 73 insertions, 2 deletions
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 5c2f7e5a..34b147bc 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -1,3 +1,11 @@ +============ +Contributing +============ + +Our community welcomes all people interested in open source cloud +computing, and encourages you to join the `OpenStack Foundation +<http://www.openstack.org/join>`_. + If you would like to contribute to the development of OpenStack, you must follow the steps documented at: @@ -9,14 +17,22 @@ the workflow documented at: http://docs.openstack.org/infra/manual/developers.html#development-workflow -Pull requests submitted through GitHub will be ignored. +(Pull requests submitted through GitHub will be ignored.) Bugs should be filed on Launchpad, not GitHub: https://bugs.launchpad.net/trove +We welcome all types of contributions, from blueprint designs to +documentation to testing to deployment scripts. 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 <http://wiki.openstack.org>`_, blogs, or on IRC at +``#openstack-trove`` on ``irc.freenode.net``. + + Code Reviews ------------- +============ We value your contribution in reviewing code changes submitted by others, as this helps increase the quality of the product as well. @@ -74,4 +90,59 @@ Other references: - https://review.openstack.org/#/c/116176/ +Trove Documentation +=================== + +This repository also contains the following OpenStack manual: + +* Database Services API Reference + +Prerequisites for Building the Documentation +-------------------------------------------- +`Apache Maven <http://maven.apache.org/>`_ 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 ``apidocs`` directory. + +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 apidocs + mvn clean generate-sources + +The generated PDF documentation file is:: + + apidocs/target/docbkx/webhelp/cdb-devguide/cdb-devguide-reviewer.pdf + +The root of the generated HTML documentation is:: + + apidocs/target/docbkx/webhelp/cdb-devguide/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 +<https://github.com/openstack/openstack-doc-tools>`_ for execution of +these tests. openstack-doc-tools has a requirement on maven for the +build check. |