openstack/cinder-specs
Code Issues Proposed changes
OpenStack Block Storage (Cinder) Specifications
345 Commits 1 Branch 0 Tags 12 MiB
Python 100%
c55e613867
Go to file
Flavio Percoco c55e613867 Show team and repo badges on README 
This patch adds the team's and repository's badges to the README file.
The motivation behind this is to communicate the project status and
features at first glance.

For more information about this effort, please read this email thread:

http://lists.openstack.org/pipermail/openstack-dev/2016-October/105562.html

To see an example of how this would look like check:

b'https://gist.github.com/8cdb455dd0c3172dccad1a8e405cfdbf\n'

Change-Id: I535a29088caa796c89cd2330f4f0be6dc5b95d4c
2016-11-25 13:42:20 +01:00
doc/source Open Ocata for specs 2016-07-25 07:35:32 -04:00
specs Trival fix a typo 2016-11-08 11:29:20 +08: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 Show team and repo badges on README 2016-11-25 13:42:20 +01:00
requirements.txt Merge "Remove docutils pin" 2014-10-26 18:24:08 +00:00
setup.cfg Changed the home-page of cinder-specs in setup.cfg 2016-10-23 17:29:34 +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

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.

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.