openstack/cinder-specs
Code Issues Proposed changes
OpenStack Block Storage (Cinder) Specifications
88 Commits 1 Branch 0 Tags 12 MiB
Python 100%
d11c3fec58
Go to file
Anne Gentle d11c3fec58 Adds Block Storage v2 API specification information 
Goal is to start maintaining API specs in the specs repos
for each project to eliminate maintenance of <project>-api repos.

Change-Id: Ife0721e831f7d5348cdc7b541c0b755a01bc23e9
2014-10-17 20:30:44 -05:00
doc/source Adds Block Storage v2 API specification information 2014-10-17 20:30:44 -05:00
specs Adds Block Storage v2 API specification information 2014-10-17 20:30:44 -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 Fix the template link in README 2014-06-26 19:30:53 +05:30
requirements.txt Add RSS feed 2014-09-10 15:57:54 -04: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:

https://wiki.openstack.org/wiki/Gerrit_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.