openstack
/
cyborg-specs
Code Issues Proposed changes
Acceleration Management(cyborg) Specifications
49 Commits 1 Branch 0 Tags 1.6 MiB
Python 100%
Go to file
Andreas Jaeger 546b9c3856 Switch to newer openstackdocstheme and reno versions 
Switch to openstackdocstheme 2.2.1 and reno 3.1.0 versions. Using
these versions will allow especially:
* Linking from HTML to PDF document
* Allow parallel building of documents
* Fix some rendering problems

Update Sphinx version as well.

Disable openstackdocs_auto_name to use 'project' variable as name.

Change pygments_style to 'native' since old theme version always used
'native' and the theme now respects the setting and using 'sphinx' can
lead to some strange rendering.

openstackdocstheme renames some variables, so follow the renames
before the next release removes them. A couple of variables are also
not needed anymore, remove them.

See also
http://lists.openstack.org/pipermail/openstack-discuss/2020-May/014971.html

The repo is setup in project-config to use storyboard, so update the
config.

Change-Id: I1ba7f47312fea8de36c4c0c0ca6bf9c2220cbf42
 		2020-06-09 07:35:30 +02:00
doc/source Switch to newer openstackdocstheme and reno versions 2020-06-09 07:35:30 +02:00
specs Add spec infrastructure for Victoria 2020-04-27 19:27:15 +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 Cleanup py27 support and docs 2020-04-09 21:47:26 +02:00
setup.py Cleanup py27 support and docs 2020-04-09 21:47:26 +02:00
test-requirements.txt Switch to newer openstackdocstheme and reno versions 2020-06-09 07:35:30 +02:00
tox.ini Merge "Update tox py version conflict flag" 2020-04-07 01:27:39 +00: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.