Replace git.openstack.org URLs with opendev.org URLs
|2 months ago|
|doc/source||4 months ago|
|specs||4 months ago|
|tests||3 years ago|
|.gitignore||1 year ago|
|.gitreview||2 months ago|
|.stestr.conf||1 year ago|
|.zuul.yaml||11 months ago|
|LICENSE||3 years ago|
|README.rst||10 months ago|
|requirements.txt||6 months ago|
|setup.cfg||7 months ago|
|setup.py||3 years ago|
|tox.ini||2 months ago|
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:
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
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.
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:
For more information about working with gerrit, see:
To validate that the specification is syntactically correct (i.e. get more confidence in the Jenkins result), please execute the following command:
tox, the documentation will be available for viewing in HTML format in the
To build the document automatically on changes, use the command:
$ tox -e autobuild
Then open in a browser http://localhost:8000