openstack/cinder-specs
Code Issues Proposed changes
OpenStack Block Storage (Cinder) Specifications
575 Commits 1 Branch 0 Tags 12 MiB
Python 100%
98f490651d
Go to file
Brian Rosmaita 98f490651d Add clarification about re-proposing specs 
Make it clear that previously approved but unimplemented specs must
be re-proposed for the current release.

Change-Id: Ibe3da75827b340218ae1777615c5edb8dcec57f5
2020-11-09 21:50:03 -05:00
doc Add clarification about re-proposing specs 2020-11-09 21:50:03 -05:00
specs Merge "Retarget specs for Wallaby" 2020-10-22 12:25:27 +00: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 Add clarification about re-proposing specs 2020-11-09 21:50:03 -05:00
setup.cfg Cleanup py27 support 2020-04-25 16:42:22 +02:00
setup.py Fix rst formatting and fix tox 2014-07-17 18:13:42 -07:00
test-requirements.txt Switch to newer openstackdocstheme and reno versions 2020-05-30 16:24:59 +02:00
tox.ini Cleanup py27 support 2020-04-25 16:42:22 +02:00

README.rst

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.

Previously approved specifications must be re-proposed for a new release. The review will most likely be quick, but we need to make sure that everyone still understands the spec as written, and that it still fits in with the project's plans.

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.