OpenStack Block Storage (Cinder) Specifications

Go to file

Jeremy Stanley e813fbd1bd Workflow documentation is now in infra-manual Replace URLs for workflow documentation to appropriate parts of the OpenStack Project Infrastructure Manual. Change-Id: I574550889421497743485613b773f1500cbeabb4		2014-12-05 03:30:36 +00:00
doc/source	Merge "Adds Block Storage v2 API specification information"	2014-12-01 21:51:35 +00:00
specs	Over subscription in thin provisioning	2014-12-03 15:45:40 -05:00
tests	Adds Block Storage v2 API specification information	2014-10-17 20:30:44 -05:00
.gitignore	Adds Block Storage v2 API specification information	2014-10-17 20:30:44 -05:00
.gitreview	Added .gitreview	2014-05-09 22:05:53 +00:00
.testr.conf	Initialize the Cinder-Specs Repository	2014-05-20 19:37:21 -06:00
LICENSE	Initialize the Cinder-Specs Repository	2014-05-20 19:37:21 -06:00
README.rst	Workflow documentation is now in infra-manual	2014-12-05 03:30:36 +00:00
requirements.txt	Merge "Remove docutils pin"	2014-10-26 18:24:08 +00:00
setup.cfg	Fix tox -e docs	2014-07-25 21:05:58 +02:00
setup.py	Fix rst formatting and fix tox	2014-07-17 18:13:42 -07:00
tox.ini	Fix rst formatting and fix tox	2014-07-17 18:13:42 -07:00

README.rst

OpenStack Cinder Specifications

This git repository is used to hold approved design specifications for additions to the Cinder project. Reviews of the specs are done in gerrit, using a similar workflow to how we review and merge changes to the code itself.

The layout of this repository is:

specs/<release>/

You can find an example spec in specs/template.rst.

Specifications are proposed for a given release by adding them to the specs/<release> directory and posting it for review. The implementation status of a blueprint for a given release can be found by looking at the blueprint in launchpad. Not all approved blueprints will get fully implemented.

Specifications have to be re-proposed for every release. The review may be quick, but even if something was previously approved, it should be re-reviewed to make sure it still makes sense as written.

Prior to the Juno development cycle, this repository was not used for spec reviews. Reviews prior to Juno were completed entirely through Launchpad blueprints:

http://blueprints.launchpad.net/cinder

Please note, Launchpad blueprints are still used for tracking the current status of blueprints. For more information, see:

https://wiki.openstack.org/wiki/Blueprints

For more information about working with gerrit, see:

http://docs.openstack.org/infra/manual/developers.html#development-workflow

To validate that the specification is syntactically correct (i.e. get more confidence in the Jenkins result), please execute the following command:

$ tox

After running tox, the documentation will be available for viewing in HTML format in the doc/build/ directory. Please do not checkin the generated HTML files as a part of your commit.