14d45468ce
In Ib226cbf9fc1fb7d3146083d65c44d8e0b80e2a7b we were introduced the doc8 check, but the configuration in cyborg/tox.ini is incorrect. This patch will combine the doc8 check in [testenv:docs] to fix 'tox -e doc8' error. Story: 2008084 Task: 40785 Change-Id: I9eb30de1407022a31086caab265e5e51e3d06bf9
Team and repository tags
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:
$ toxAfter running tox, the documentation will be available
for viewing in HTML format in the doc/build/ directory.