OpenStack Block Storage (Cinder) Specifications
Go to file
Brian Rosmaita 48f54bab22 Retarget specs to ussuri
Move some specs that didn't get completed in Train but which are
being worked on for delivery in ussuri to the appropriate directory,
and set up redirects so that train URLs for the specs will redirect
to the current location.

Change-Id: Ic73f4801b8307ad2a0c9be0f3ab6c12b4019e0e7
2020-01-13 22:17:24 -05:00
doc Retarget specs to ussuri 2020-01-13 22:17:24 -05:00
specs Retarget specs to ussuri 2020-01-13 22:17:24 -05:00
.gitignore Adds Block Storage v2 API specification information 2014-10-17 20:30:44 -05:00
.gitreview OpenDev Migration Patch 2019-04-19 19:36:06 +00:00
.testr.conf Initialize the Cinder-Specs Repository 2014-05-20 19:37:21 -06:00
.zuul.yaml import zuul job settings from project-config 2018-09-09 05:49:11 -04:00
bindep.txt Update bindep.txt for doc builds 2017-12-25 15:35:20 +00: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
setup.cfg Change openstack-dev to openstack-discuss 2018-12-03 21:30:18 -05:00
setup.py Fix rst formatting and fix tox 2014-07-17 18:13:42 -07:00
test-requirements.txt Retarget specs to ussuri 2020-01-13 22:17:24 -05:00
tox.ini Retarget specs to ussuri 2020-01-13 22:17:24 -05: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.