023c4b8448
Update pom.xml for building the database-api document to follow the conventions used by the OpenStack documentation team: * Remove "review" from published guide * Disable Disqus * Use latest clouddocs-maven-plugin (2.0.2) * Fix canonicalURL so that it points to the current location * Fix formatting and whitespace of file Remove hardcoded publication date from cdb-devguide, this gets generated at build time. Update doc-test.conf for pom.xml change. Change-Id: I90eb16917edbb99d99147c4a8116f5bcf28e6975
Trove
Trove is Database as a Service for Open Stack.
Usage for integration testing
If you'd like to start up a fake Trove API daemon for integration testing with your own tool, run:
$ ./tools/start-fake-mode.shStop the server with:
$ ./tools/stop-fake-mode.shTests
To run all tests and PEP8, run tox, like so:
$ toxTo run just the tests for Python 2.7, run:
$ tox -epy27To run just PEP8, run:
$ tox -epep8To generate a coverage report,run:
$ tox -ecover(note: on some boxes, the results may not be accurate unless you run it twice)
Docs
This repository contains the following OpenStack manual:
- Database Services API Reference
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 mavenOn Fedora 15 and later:
yum install maven3Building
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-sourcesThe generated PDF documentation file is:
apidocs/target/docbkx/webhelp/cdb-devguide/cdb-devguide-reviewer.pdfThe root of the generated HTML documentation is:
apidocs/target/docbkx/webhelp/cdb-devguide/content/index.htmlTesting 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 teststox -e checksyntax- to run syntax checkstox -e checkdeletions- to check that no deleted files are referencedtox -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:
Installing
Refer to http://docs.openstack.org to see where these documents are published and to learn more about the OpenStack project.