openstack
/
tacker-specs
Code Issues Proposed changes
NFV Orchestration (Tacker) Specifications
222 Commits 1 Branch 0 Tags 17 MiB
Python 100%
Go to file
Manpreet Kaur 55cf046a80 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: Iaa9f6083e0c47f437821d317d00e301e8ffe9bdb
 		2021-05-18 13:16:39 +05:30
doc Merge "Revise some instructions" 2021-03-22 16:07:58 +00:00
specs Merge "Revise some instructions" 2021-03-22 16:07:58 +00:00
.gitignore Add base tacker-specs framework 2014-06-03 17:55:27 +09:00
.gitreview OpenDev Migration Patch 2019-04-19 19:35:23 +00:00
.testr.conf Add base tacker-specs framework 2014-06-03 17:55:27 +09:00
.zuul.yaml import zuul job settings from project-config 2018-08-17 20:15:37 +09:00
LICENSE Add base tacker-specs framework 2014-06-03 17:55:27 +09:00
README.rst Change tacker-specs webpage from oslosphinx to openstackdocstheme 2018-03-13 12:41:45 +09:00
setup.cfg setup.cfg: Replace dashes with underscores 2021-05-18 13:16:39 +05:30
setup.py Add base tacker-specs framework 2014-06-03 17:55:27 +09:00
test-requirements.txt Refactor and clean up specs dir 2018-04-05 15:21:56 +09:00
tox.ini Cleanup py27 support 2020-04-10 11:50:37 +02:00

README.rst

Team and repository tags

image

OpenStack Tacker Specifications

This git repository is used to hold approved design specifications for additions to the Tacker 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.

Please note, Launchpad blueprints are still used for tracking the current status of blueprints. For more information, see:

https://wiki.openstack.org/wiki/Blueprints

Launchpad blueprints for Tacker can be found at:

https://blueprints.launchpad.net/tacker

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.