openstack-attic/volume-api
Code Issues Proposed changes
47 Commits 1 Branch 2 Tags 9.4 MiB
Text 100%
4963f3493b
Go to file
Jeremy Stanley 4963f3493b Remove tox locale overrides 
* tox.ini: The LANG, LANGUAGE and LC_ALL environment overrides were
introduced originally during the testr migration in an attempt to be
conservative about the possibility that locale settings in the
calling environment could cause consistency problems for test runs.
In actuality, this should be unnecessary and any place where it does
cause issues ought to be considered an actual bug. Also, having
these in the configuration actively causes older pip to have
problems with non-ASCII content in some package metadata files under
Python 3, so drop it now.

Change-Id: Iea6ca35b3dcac693f6dd8b580c0c35ff9844803b
Closes-Bug: #1277495
2014-02-10 03:13:50 +00:00
src/wadls/volume-api/src Add xml:ids to resources 2014-02-03 18:50:43 +01:00
v1 Add xml:ids to resources 2014-02-03 18:50:43 +01:00
v2 Add xml:ids to resources 2014-02-03 18:50:43 +01:00
.gitignore doc-tools: Ignore build-*.log.gz 2014-02-08 22:11:44 +01:00
.gitreview Initial commit. 2012-09-05 13:09:36 -07:00
doc-test.conf Add doc-test.conf 2014-02-03 20:31:45 +01:00
README.rst Fix bullet list format in README.rst 2014-02-02 12:19:12 +01:00
test-requirements.txt Updated from global requirements 2014-01-25 03:36:40 +00:00
tox.ini Remove tox locale overrides 2014-02-10 03:13:50 +00:00

README.rst

Volume API

This repository contains the RESTful API information for the OpenStack Block Storage, also known as Cinder. The Cinder project provides open source block-based storage component for cloud computing.

For more details, see the OpenStack Documentation wiki page.

It includes these manuals:

  • Block Storage Service API v1 Reference
  • Block Storage Service API v2 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 v1 and v2 directories.

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 v2
mvn clean generate-sources

The generated PDF documentation file is:

api-quick-start/target/docbkx/webhelp/api-quick-start-onepager-external/api-quick-start-onepager.pdf

The root of the generated HTML documentation is:

api-quick-start/target/docbkx/webhelp/api-quick-start-onepager-external/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.