summaryrefslogtreecommitdiff
path: root/CONTRIBUTING.rst
diff options
context:
space:
mode:
authorMonty Taylor <mordred@inaugust.com>2014-11-21 10:53:36 -0500
committerNikhil Manchanda <SlickNik@gmail.com>2014-12-05 23:24:53 -0800
commit28e8fcf0ee3f7423e0f128bf0aafbff120450378 (patch)
treebce282f7ed8a1ceee093a2e919af4f06975ccada /CONTRIBUTING.rst
parentb2aa4f993e4559fee0410bd7b69753e4ab8c0e2c (diff)
downloadtrove-28e8fcf0ee3f7423e0f128bf0aafbff120450378.tar.gz
Clean up github references from docs
OpenStack hosts things in places that are not github. Also, it seems that there is a big blob of unrelated readme in the README file. Closes-Bug: 1399839 Change-Id: I70cc6772b50591c4b3badd6c92567a7a6541bacf
Diffstat (limited to 'CONTRIBUTING.rst')
-rw-r--r--CONTRIBUTING.rst75
1 files changed, 73 insertions, 2 deletions
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst
index e81157cd..56806005 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://wiki.openstack.org/GerritWorkflow
-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.