openstack
/
cloudkitty-specs
Code Issues Proposed changes
CloudKitty (Rating) design specification
7 Commits 1 Branch 0 Tags 721 KiB
Python 100%
Go to file
Luka Peschke 7baca66b9e Spec: Refactor CloudKitty's documentation 
This is a proposal for the new layout of cloudkitty's documentation,

Once this has been approved and discussed, we'll add some tasks to the
associated story.

Depends-On: https://review.openstack.org/#/c/613339/
Change-Id: I64704d9e78a7c70c66cab3068fbc4addf87783a6
Story: 2004179
Task: 27664
 		2018-11-28 10:36:17 +01:00
doc/source Spec: Refactor CloudKitty's documentation 2018-11-28 10:36:17 +01:00
specs Spec: Refactor CloudKitty's documentation 2018-11-28 10:36:17 +01:00
.gitignore Initialize cloudkitty-specs repo 2017-01-09 09:37:44 +08:00
.gitreview Added .gitreview 2016-11-24 15:09:06 +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 Initialize cloudkitty-specs repo 2017-01-09 09:37:44 +08:00
setup.cfg Initialize cloudkitty-specs repo 2017-01-09 09:37:44 +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.