Vitrage Design Specifications

Go to file

Yujun Zhang 949be77bf7 Move datasource-scaffold to rocky/implemented Note also blueprint name is changed from datasource skeleton generator to datasource scaffold Implements: blueprint datasource-scaffold Change-Id: I0e466946273b8df6cc723c99683da818e04f8e07		2018-05-17 13:43:29 +08:00
doc/source	Added Rocky specs to index.rst	2018-01-25 09:45:53 +00:00
specs	Move datasource-scaffold to rocky/implemented	2018-05-17 13:43:29 +08:00
tests	Initial setup of vitrage-spec project	2015-11-06 13:56:56 +02:00
.gitignore	add .iml to git ignore	2015-12-24 14:28:14 +02:00
.gitreview	Added .gitreview	2015-11-06 06:43:41 +00:00
.testr.conf	Initial setup of vitrage-spec project	2015-11-06 13:56:56 +02:00
LICENSE	Initial setup of vitrage-spec project	2015-11-06 13:56:56 +02:00
README.rst	Build sphinx doc automatically on changes	2017-11-22 09:53:43 +08:00
requirements.txt	Build sphinx doc automatically on changes	2017-11-22 09:53:43 +08:00
setup.cfg	Update docs build job for new documentation PTI jobs	2017-12-26 09:04:01 +08:00
setup.py	Initial setup of vitrage-spec project	2015-11-06 13:56:56 +02:00
tox.ini	Merge "Update docs build job for new documentation PTI jobs"	2018-01-19 01:24:36 +00:00

README.rst

Team and repository tags

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