openstack
/
cyborg-specs
Code Issues Proposed changes
Acceleration Management(cyborg) Specifications
37 Commits 1 Branch 0 Tags 1.6 MiB
Python 100%
Go to file
Ghanshyam Mann d61c67babf Update tox py version conflict flag 
ignore_basepython_conflict flag needs to be set True
as basepython is py3 in common env.

Change-Id: If7aeb0be012cb4ec43d29880c466a8bd14dd6532
 		2020-02-03 12:19:13 -06:00
doc/source Add Ussuri spec path in doc/index.rst 2019-11-26 05:32:34 +00:00
releasenotes Initialize cyborg-specs repository 2018-03-22 16:07:07 +08:00
specs Specification of Cyborg API microversion 2020-02-03 14:02:39 +08:00
.coveragerc Initialize cyborg-specs repository 2018-03-22 16:07:07 +08:00
.gitignore Specification of Cyborg API microversion 2020-02-03 14:02:39 +08:00
.gitreview OpenDev Migration Patch 2019-04-19 19:48:29 +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 fix bug link in readme 2018-10-18 08:08:03 +00:00
babel.cfg Initialize cyborg-specs repository 2018-03-22 16:07:07 +08:00
requirements.txt add doc8 check 2020-01-17 03:56:56 +00:00
setup.cfg Change openstack-dev to openstack-discuss 2019-06-02 06:46:44 +00: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 Update tox py version conflict flag 2020-02-03 12:19:13 -06: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.