openstack
/
manila-specs
Code Issues Proposed changes
Specs repo for Manila (OpenStack Shared File Systems) project.
156 Commits 1 Branch 0 Tags 4.6 MiB
Python 100%
Go to file
Andreas Jaeger 84b9989a79 Switch to newer openstackdocstheme version 
Switch to openstackdocstheme 2.2.1 version. Using
this version will allow especially:
* Linking from HTML to PDF document
* Allow parallel building of documents
* Fix some rendering problems

Update Sphinx version as well.

Change pygments_style to 'native' since old theme version always used
'native' and the theme now respects the setting and using 'sphinx' can
lead to some strange rendering.

openstackdocstheme renames some variables, so follow the renames
before the next release removes them. A couple of variables are also
not needed anymore, remove them.

See also
http://lists.openstack.org/pipermail/openstack-discuss/2020-May/014971.html

Change-Id: I9843c6b66d4411857cb19c5d176d39b200423257
 		2020-05-31 17:56:34 +02:00
doc/source Switch to newer openstackdocstheme version 2020-05-31 17:56:34 +02:00
specs Merge "Update scenario tests spec" 2020-04-16 20:53:40 +00:00
.gitignore Add line for PyCharm IDE in gitignore file 2018-06-27 17:58:35 -04:00
.gitreview OpenDev Migration Patch 2019-04-19 19:33:23 +00:00
.testr.conf Create skeleton using cookiecutter 2016-05-12 14:51:16 +00:00
.zuul.yaml import zuul job settings from project-config 2018-08-20 18:49:43 +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 Update links in README 2018-08-19 04:25:57 +08:00
requirements.txt Switch to newer openstackdocstheme version 2020-05-31 17:56:34 +02:00
setup.cfg Change openstack-dev to openstack-discuss 2018-12-03 21:35:10 -05:00
setup.py Create skeleton using cookiecutter 2016-05-12 14:51:16 +00:00
test-requirements.txt Remove unit test targets 2017-11-17 13:41:24 -05:00
tox.ini Drop install_command usage in tox 2020-04-22 18:30:26 -07: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:

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.