openstack/vitrage-specs
Code Issues Proposed changes
Vitrage Design Specifications
173 Commits 1 Branch 0 Tags 2.5 MiB
Python 100%
d48036ba3e
Go to file
YuehuiLei d48036ba3e 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: Icd54fc860f354787bfd16da7d47e705523305094
2021-05-04 16:58:45 +08:00
doc/source Remove unicode from specs 2021-01-05 06:54:32 +00:00
specs Remove unicode from specs 2021-01-05 06:54:32 +00:00
tests Initial setup of vitrage-spec project 2015-11-06 13:56:56 +02:00
.gitignore Switch to stestr 2018-07-04 13:54:56 +07:00
.gitreview OpenDev Migration Patch 2019-04-19 19:42:05 +00:00
.stestr.conf Switch to stestr 2018-07-04 13:54:56 +07:00
.zuul.yaml import zuul job settings from project-config 2018-08-17 14:05:09 +09:00
bindep.txt [ussuri][goal] Drop python 2.7 support 2019-12-30 12:22:09 +00:00
LICENSE Initial setup of vitrage-spec project 2015-11-06 13:56:56 +02:00
README.rst Update the governance link 2018-08-27 22:30:41 -04:00
requirements.txt Switch to newer openstackdocstheme version 2020-06-02 14:05:12 +02:00
setup.cfg setup.cfg: Replace dashes with underscores 2021-05-04 16:58:45 +08:00
setup.py Initial setup of vitrage-spec project 2015-11-06 13:56:56 +02:00
tox.ini Use py3 as the default runtime for tox 2021-04-20 10:45:55 +08:00

README.rst

Team and repository tags

image

OpenStack Vitrage Specifications

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

Where there are two sub-directories:

specs/<release>/approved: specifications approved but not yet implemented specs/<release>/implemented: implemented specifications

This directory structure allows you to see what we thought about doing, decided to do, and actually got done. Users interested in functionality in a given release should only refer to the implemented directory.

You can find an example spec in doc/source/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.

Launchpad blueprints:

http://blueprints.launchpad.net/vitrage

Starting from the Mitaka-1 development milestone Vitrage performs the pilot of the specs repos approach.

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:

http://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.

To build the document automatically on changes, use the command:

$ tox -e autobuild

Then open in a browser http://localhost:8000