openstack-attic/database-api
Code Issues Proposed changes
25 Commits 1 Branch 0 Tags 11 MiB
JavaScript 45.5%
XSLT 38%
CSS 16.5%
da21811504
Go to file
Andreas Jaeger da21811504 Add list of files to ignore 
Add list of files to ignore. This needs a corresponding change
to tox.ini to call the tool with "--exceptions-file=doc-test.exceptions"
and a new release of the openstack-doc-tools project.

Change-Id: I00be628ccab9d10dceaba59fe7402e7703192818
2014-01-20 16:05:05 +01:00
apidocs Merge "Update pom.xml, remove bookinfo.xml" 2014-01-18 14:48:04 +00:00
openstack-database-api/src/markdown Adding backup size to response documentation. 2013-08-16 11:02:42 -05:00
xsd Fix whitespace 2014-01-13 22:16:06 +01:00
.gitignore Add usual documentation .gitignore content. 2014-01-18 09:21:43 +01:00
.gitreview Rename to openstack org in .gitreview. 2013-06-14 18:22:50 -04:00
doc-test.exceptions Add list of files to ignore 2014-01-20 16:05:05 +01:00
README.rst Setup for openstack-doc-tools 2014-01-13 22:04:22 +01:00
test-requirements.txt Setup for openstack-doc-tools 2014-01-13 22:04:22 +01:00
tox.ini Add list of files to ignore 2014-01-20 16:05:05 +01:00

README.rst

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

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 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 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.