Specs repo for Manila (OpenStack Shared File Systems) project.
Go to file
Flavio Percoco bbf6522daf 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/80b65c2147ce454a8741baf448e2c220\n'

Change-Id: Ib0b2edbb822e307ddcf6b6efe1bd53f53eb2e266
2016-11-25 12:40:09 +01:00
doc/source Remove duplicated imports of specs into index 2016-11-17 13:55:52 +00:00
priorities Fix table of Ocata priorities 2016-11-18 11:14:08 -05:00
specs Merge "Add share_type filter support to pool_list" 2016-11-18 18:41:03 +00:00
.gitignore Create skeleton using cookiecutter 2016-05-12 14:51:16 +00:00
.gitreview Added .gitreview 2016-05-04 06:26:17 +00:00
.testr.conf Create skeleton using cookiecutter 2016-05-12 14:51:16 +00:00
CONTRIBUTING.rst Create skeleton using cookiecutter 2016-05-12 14:51:16 +00:00
LICENSE Create skeleton using cookiecutter 2016-05-12 14:51:16 +00:00
README.rst Show team and repo badges on README 2016-11-25 12:40:09 +01:00
requirements.txt Create skeleton using cookiecutter 2016-05-12 14:51:16 +00:00
setup.cfg Changed the home-page of manila-specs in setup.cfg 2016-10-23 22:31:29 +05:30
setup.py Create skeleton using cookiecutter 2016-05-12 14:51:16 +00:00
test-requirements.txt Create skeleton using cookiecutter 2016-05-12 14:51:16 +00:00
tox.ini Add py27 tox env to tox config to unblock CI 2016-11-17 15:42:19 +02:00

README.rst

Team and repository tags

image

OpenStack Manila Specifications

This git repository is used to hold approved design specifications for additions to the Manila 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 Newton development cycle, this repository was not used for spec reviews. Reviews prior to Newton were completed entirely informally using wiki pages linked from blueprints:

http://blueprints.launchpad.net/manila

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.