Acceleration Management(cyborg) Specifications
Go to file
Nguyen Hai bd99c0b160 import zuul job settings from project-config
This is a mechanically generated patch to complete step 1 of moving
the zuul job settings out of project-config and into each project
repository.

Because there will be a separate patch on each branch, the branch
specifiers for branch-specific jobs have been removed.

Because this patch is generated by a script, there may be some
cosmetic changes to the layout of the YAML file(s) as the contents are
normalized.

See the python3-first goal document for details:
https://governance.openstack.org/tc/goals/stein/python3-first.html

Change-Id: I556e322c69c4f20a79edc76ad4beb86a5d57efe6
Story: #2002586
Task: #24291
2018-08-17 14:47:10 +09:00
doc/source Initialize cyborg-specs repository 2018-03-22 16:07:07 +08:00
releasenotes Initialize cyborg-specs repository 2018-03-22 16:07:07 +08:00
specs Initialize cyborg-specs repository 2018-03-22 16:07:07 +08:00
.coveragerc Initialize cyborg-specs repository 2018-03-22 16:07:07 +08:00
.gitignore Initialize cyborg-specs repository 2018-03-22 16:07:07 +08:00
.gitreview Added .gitreview 2018-03-20 12:36:01 +00:00
.mailmap Initialize cyborg-specs repository 2018-03-22 16:07:07 +08:00
.stestr.conf Initialize cyborg-specs repository 2018-03-22 16:07:07 +08:00
.zuul.yaml import zuul job settings from project-config 2018-08-17 14:47:10 +09:00
CONTRIBUTING.rst Initialize cyborg-specs repository 2018-03-22 16:07:07 +08:00
HACKING.rst Initialize cyborg-specs repository 2018-03-22 16:07:07 +08:00
LICENSE Initialize cyborg-specs repository 2018-03-22 16:07:07 +08:00
README.rst Initialize cyborg-specs repository 2018-03-22 16:07:07 +08:00
babel.cfg Initialize cyborg-specs repository 2018-03-22 16:07:07 +08:00
requirements.txt Initialize cyborg-specs repository 2018-03-22 16:07:07 +08:00
setup.cfg Initialize cyborg-specs repository 2018-03-22 16:07:07 +08:00
setup.py Initialize cyborg-specs repository 2018-03-22 16:07:07 +08:00
test-requirements.txt Initialize cyborg-specs repository 2018-03-22 16:07:07 +08:00
tox.ini fix tox python3 overrides 2018-06-08 23:21:19 +08:00

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.