OpenStack Block Storage (Cinder) Specifications
Go to file
Brian Rosmaita 2a67eec96b Reorganize specs table of contents
Move the 'untargeted' specs to the top of the page where they'll
be more easily found and create a 'previously approved specs'
section to organize the old specs better.

Change-Id: I4309c6193c8e5fcc2756685623acbe85577a779e
2024-01-10 10:20:43 -05:00
doc Reorganize specs table of contents 2024-01-10 10:20:43 -05:00
specs Merge "Remove placeholder for 2024.1" 2024-01-10 14:48:23 +00:00
.gitignore Remove testr detrius 2021-02-16 08:47:22 -05:00
.gitreview OpenDev Migration Patch 2019-04-19 19:36:06 +00:00
.zuul.yaml import zuul job settings from project-config 2018-09-09 05:49:11 -04: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
bindep.txt Update bindep.txt for doc builds 2017-12-25 15:35:20 +00:00
setup.cfg Update metadata in setup.cfg 2021-12-25 13:44:31 +05:30
setup.py Fix rst formatting and fix tox 2014-07-17 18:13:42 -07:00
test-requirements.txt Update doc8 version 2022-08-29 15:40:50 +05:30
tox.ini Changed minversion in tox to 3.18.0 2021-03-17 12:40:57 +05:30

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.