Specs repo for Manila (OpenStack Shared File Systems) project.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Zuul d40a877052 Merge "Set concurrency control spec to release independent" 4 days ago
doc/source Move unimplemented specifications to separate folder 1 week ago
specs Merge "Set concurrency control spec to release independent" 4 days ago
.gitignore Add line for PyCharm IDE in gitignore file 10 months ago
.gitreview OpenDev Migration Patch 1 month ago
.testr.conf Create skeleton using cookiecutter 3 years ago
.zuul.yaml import zuul job settings from project-config 9 months ago
CONTRIBUTING.rst Create skeleton using cookiecutter 3 years ago
LICENSE Create skeleton using cookiecutter 3 years ago
README.rst Update links in README 9 months ago
requirements.txt Switch to openstackdocstheme 1 year ago
setup.cfg Change openstack-dev to openstack-discuss 5 months ago
setup.py Create skeleton using cookiecutter 3 years ago
test-requirements.txt Remove unit test targets 1 year ago
tox.ini fix tox python3 overrides 10 months ago

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:

https://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:

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.