openstack
/
manila-specs
Code Issues Proposed changes
Specs repo for Manila (OpenStack Shared File Systems) project.
190 Commits 1 Branch 0 Tags 4.7 MiB
Python 100%
Go to file
likui 207b716fc2 setup.cfg: Replace dashes with underscores 
Setuptools v54.1.0 introduces a warning that the use of
dash-separated options in 'setup.cfg' will not be supported
in a future version [1].
Get ahead of the issue by replacing the dashes with underscores.
Without this, we see 'UserWarning' messages
like the following on new enough
versions of setuptools:

  UserWarning: Usage of dash-separated 'description-file' will not be
  supported in future versions. Please use the underscore name
  'description_file' instead

[1] https://github.com/pypa/setuptools/commit/a2e9ae4cb

Change-Id: I8c16923e7eeb18a945127650adeec5eda3c844c0
 		2022-06-01 22:23:28 +08:00
doc/source Merge "share transfer between project" 2022-01-19 10:27:24 +00:00
specs Merge "share transfer between project" 2022-01-19 10:27:24 +00:00
.gitignore Remove testr 2021-05-25 19:45:05 +05:30
.gitreview OpenDev Migration Patch 2019-04-19 19:33:23 +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 setup.cfg: Replace dashes with underscores 2022-06-01 22:23:28 +08: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 Remove testr 2021-05-25 19:45:05 +05:30

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.