OpenStack Networking (Neutron) Specifications
Go to file
niuke d1eca25a3f 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: I1ec92d9cb6148e2cf0172075ec1eeeede13015fa
2023-04-28 08:20:56 +00:00
doc Spec folder for 2023.2 cycle 2023-03-01 19:40:37 +01:00
images Add Node-Local Virtual IP Spec 2021-08-17 13:51:48 +03:00
misc Removed networking_general_api_information.rst 2016-08-27 21:07:47 +00:00
specs Merge "port-hints: Retrofit spec to details changed during implementation" 2023-04-03 20:10:24 +00:00
tests Fix py27 job in specs repo 2018-05-30 10:28:57 +02:00
.gitignore Switch to stestr 2018-06-22 12:50:11 +02:00
.gitreview OpenDev Migration Patch 2019-04-19 19:34:46 +00:00
.stestr.conf Switch to stestr 2018-06-22 12:50:11 +02:00
.zuul.yaml Fix tox.ini for tox4 2023-01-03 15:11:01 +00:00
LICENSE Add base neutron-specs framework 2014-04-14 03:08:02 +00:00
README.rst Delete redundant rst files and update README 2018-04-11 15:24:45 +09:00
requirements.txt Switch to stestr 2018-06-22 12:50:11 +02:00
setup.cfg setup.cfg: Replace dashes with underscores 2023-04-28 08:20:56 +00:00
setup.py Spec folder for Zed 2022-04-13 17:28:52 +02:00
tox.ini Update envlist for tox4 2023-01-17 09:47:07 -05:00

Team and repository tags

image

OpenStack Neutron Specifications

This git repository is used to hold approved design specifications for additions to the Neutron 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 Juno development cycle, this repository was not used for spec reviews. Reviews prior to Juno were completed entirely through Launchpad blueprints:

https://blueprints.launchpad.net/neutron

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 check in the generated HTML files as a part of your commit.