openstack
/
manila-specs
Code Issues Proposed changes
Specs repo for Manila (OpenStack Shared File Systems) project.
70 Commits 1 Branch 0 Tags 4.6 MiB
Python 100%
Go to file
Tom Barron 3c669be677 Update tox.ini to align with other manila repos 
so that we can run 'tox' locally and properly validate our spec
docs.

* Update tox minversion and requirements
* Clean out build directory before new docs build
* Run doc8 validation
* Fix numerous incidental errors in the specs and templates
  so that doc8 now passes
* Setup both py35 and py27 environments
* Turn off yasfb extension until it can work with python 3

Change-Id: I722a9ad852cdfa0974322fbe29db37956dab3ee0
 		2017-04-13 20:21:54 -04:00
doc/source Update tox.ini to align with other manila repos 2017-04-13 20:21:54 -04:00
priorities Fix table of Ocata priorities 2016-11-18 11:14:08 -05:00
specs Update tox.ini to align with other manila repos 2017-04-13 20:21:54 -04: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 Optimize the link address 2017-04-11 11:56:58 +05:30
requirements.txt Update tox.ini to align with other manila repos 2017-04-13 20:21:54 -04: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 Update tox.ini to align with other manila repos 2017-04-13 20:21:54 -04:00
tox.ini Update tox.ini to align with other manila repos 2017-04-13 20:21:54 -04: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.