Acceleration Management(cyborg) Specifications
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Zuul 6646004290 Merge "Clean up unused cyborg-spec document" 18 hours ago
doc/source Clean up unused cyborg-spec document 1 month ago
releasenotes Initialize cyborg-specs repository 1 year ago
specs Clean up unused cyborg-spec document 1 month ago
.coveragerc Initialize cyborg-specs repository 1 year ago
.gitignore Initialize cyborg-specs repository 1 year ago
.gitreview OpenDev Migration Patch 1 month ago
.mailmap Initialize cyborg-specs repository 1 year ago
.stestr.conf Initialize cyborg-specs repository 1 year ago
.zuul.yaml import zuul job settings from project-config 9 months ago
CONTRIBUTING.rst Initialize cyborg-specs repository 1 year ago
HACKING.rst Initialize cyborg-specs repository 1 year ago
LICENSE Initialize cyborg-specs repository 1 year ago
README.rst fix bug link in readme 7 months ago
babel.cfg Initialize cyborg-specs repository 1 year ago
requirements.txt Initialize cyborg-specs repository 1 year ago
setup.cfg Clean up unused cyborg-spec document 1 month ago
setup.py Initialize cyborg-specs repository 1 year ago
test-requirements.txt Initialize cyborg-specs repository 1 year ago
tox.ini fix tox python3 overrides 11 months ago

README.rst

Team and repository tags

image

OpenStack Cyborg Specifications

This git repository is used to hold approved design specifications for additions to the Cyborg 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.

To track all the blueprints of cyborg, please refer to the trello board: https://trello.com/b/4nFtHNSg/queens-dev

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.