openstack/cloudkitty-specs
Code Issues Proposed changes
CloudKitty (Rating) design specification
59 Commits 1 Branch 0 Tags 724 KiB
Python 100%
d5261f48a3
Go to file
Rafael Weingärtner d5261f48a3 Fix docs build error 
This patch fixes docs build errors such as the ones seen in
https://review.opendev.org/c/openstack/cloudkitty-specs/+/866198

Change-Id: Ie965ad1621c984e6eaa9ae6c85fa0f637f078391
2023-01-30 08:47:13 -03:00
doc/source Propose reprocessing API 2022-01-10 15:28:40 +01:00
specs Propose reprocessing API 2022-01-10 15:28:40 +01: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
CONTRIBUTING.rst [ussuri][goal] Update contributor documentation 2021-05-17 14:26:54 +00:00
LICENSE Initialize cloudkitty-specs repo 2017-01-09 09:37:44 +08:00
README.rst Update and replace http with https for doc links 2019-08-22 14:54:05 +08:00
requirements.txt Switch to newer openstackdocstheme version 2020-08-24 11:17:21 +02:00
setup.cfg setup.cfg: Replace dashes with underscores 2021-05-16 20:51:06 +00:00
setup.py Initialize cloudkitty-specs repo 2017-01-09 09:37:44 +08:00
tox.ini Fix docs build error 2023-01-30 08:47:13 -03: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:

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