This commit was bulk generated and pushed by the OpenDev sysadmins as a part of the Git hosting and code review systems migration detailed in these mailing list posts: http://lists.openstack.org/pipermail/openstack-discuss/2019-March/003603.html http://lists.openstack.org/pipermail/openstack-discuss/2019-April/004920.html Attempts have been made to correct repository namespaces and hostnames based on simple pattern matching, but it's possible some were updated incorrectly or missed entirely. Please reach out to us via the contact information listed at https://opendev.org/ with any questions you may have.
|3 years ago|
|apidocs||8 years ago|
|openstack-database-api/src/markdown||8 years ago|
|.gitignore||8 years ago|
|.gitreview||3 years ago|
|README.rst||8 years ago|
|doc-test.conf||8 years ago|
|test-requirements.txt||8 years ago|
|tox.ini||8 years ago|
Database-API Repository +++++++++++++++++++
This repository contains documentation for the OpenStack project.
For more details, see the OpenStack Documentation wiki page.
It includes these manuals:
- Database Services API Reference
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
The manuals are in the
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:
The root of the generated HTML documentation is:
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.
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
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 should be filed on Launchpad, not GitHub:
Refer to http://docs.openstack.org to see where these documents are published and to learn more about the OpenStack project.