OpenStack Block Storage (Cinder) Specifications
Go to file
zhangbailin c4fe9b117a Update url of the cinder-specs's document
Update doc links according to OpenStack document migration,
Use https instead of http for docs links, and update the old url.

Change-Id: I7c11c10b39b3d04313d19b2b93652af6014d3e03
2017-09-15 05:38:06 +00:00
doc/source Fix incorrect indention in index.rst file 2017-08-08 09:36:27 +08:00
specs Move generic-backup-implementation spec to Queens directory 2017-09-14 10:04:14 -06: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 Update url of the cinder-specs's document 2017-09-15 05:38:06 +00:00
requirements.txt Manual update sphinx version 2017-09-07 06:42:12 +00:00
setup.cfg Remove support for py34. 2017-06-21 07:35:25 +00:00
setup.py Fix rst formatting and fix tox 2014-07-17 18:13:42 -07:00
tox.ini Remove support for py34. 2017-06-21 07:35:25 +00:00

Team and repository tags

image

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:

https://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://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.