OpenStack Block Storage (Cinder) Specifications
Go to file
xianming mao b4baff9915 Drop H803 in flake8 ignore list and useless directory openstack/common
In hacking >=0.10.0,there is not H803,and in this project there have
not directory openstack/common,so we should delete them to improve
performance!

Change-Id: Ie39175fa16fa488d3e6066df25ebfcaa0a0fc4e2
2016-08-10 19:43:30 +08:00
doc/source Open Ocata for specs 2016-07-25 07:35:32 -04:00
specs Open Ocata for specs 2016-07-25 07:35:32 -04:00
tests Remove hardcoded releases list from unit tests 2015-10-05 23:31:43 +03: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 Merge "remove python 2.6 trove classifier" 2016-02-24 17:56:05 +00:00
setup.py Fix rst formatting and fix tox 2014-07-17 18:13:42 -07:00
tox.ini Drop H803 in flake8 ignore list and useless directory openstack/common 2016-08-10 19:43:30 +08:00

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.