openstack/cloudkitty-specs
Code Issues Proposed changes
CloudKitty (Rating) design specification
25 Commits 1 Branch 0 Tags 725 KiB
Python 100%
ce5cc73278
Go to file
Luka Peschke ce5cc73278 Add a v2 reporting endpoint 
See "specs/train/add_v2_reporting_endpoint.rst" for details.

Change-Id: I821a89572610d1d04369571d4d597ed96cc304cd
Story: 2005664
Task: 30957
2019-05-21 12:29:37 +00:00
doc/source Initializing the Train specs 2019-03-29 09:52:16 +01:00
specs Add a v2 reporting endpoint 2019-05-21 12:29:37 +00:00
.gitignore Initialize cloudkitty-specs repo 2017-01-09 09:37:44 +08:00
.gitreview OpenDev Migration Patch 2019-04-19 19:34:34 +00:00
.zuul.yaml import zuul job settings from project-config 2018-08-31 08:57:19 -04:00
LICENSE Initialize cloudkitty-specs repo 2017-01-09 09:37:44 +08:00
README.rst Refreshing the repository 2018-10-25 16:39:58 +02:00
requirements.txt Remove yasfb dependency 2019-03-28 17:18:44 +01:00
setup.cfg Fix author-email in setup.cfg 2019-01-22 16:27:16 +08:00
setup.py Initialize cloudkitty-specs repo 2017-01-09 09:37:44 +08:00
tox.ini fix tox python3 overrides 2018-09-26 18:50:37 -04:00

README.rst

OpenStack Cloudkitty Specifications

This git repository is used to hold approved design specifications for additions to the Cloudkitty 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 story for a given release can be found by looking at the story in Storyboard. Not all stories 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.

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.