65cef67a16
We would like to start documenting our APIs in an industry-standard, machine-readable manner. Doing so opens up many opportunities for both OpenStack developer and OpenStack users alike, notably the ability to both auto-generate and auto-validate both client tooling and documentation alike. Of the many API description languages available, OpenAPI (fka "Swagger") appears to be the one with both the largest developer mind share and the one that would be the best fit for OpenStack due to the existing tooling used in many OpenStack services, thus we would opt to use this format. Change-Id: I3ecc8954394ce364ee3b654c92b62633456d16b7 Signed-off-by: Stephen Finucane <stephenfin@redhat.com> |
||
---|---|---|
doc | ||
specs | ||
.gitignore | ||
.gitreview | ||
.zuul.yaml | ||
LICENSE | ||
README.rst | ||
bindep.txt | ||
setup.cfg | ||
setup.py | ||
test-requirements.txt | ||
tox.ini |
README.rst
Team and repository tags
OpenStack Cinder Specifications
This git repository is used to hold approved design specifications for additions to the Cinder 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>/
You can find an example spec in specs/template.rst.
Specifications are proposed for a given release by adding them to the specs/<release> directory and posting it for review. The implementation status of a blueprint for a given release can be found by looking at the blueprint in launchpad. Not all approved blueprints will get fully implemented.
Previously approved specifications must be re-proposed for a new release. The review will most likely be quick, but we need to make sure that everyone still understands the spec as written, and that it still fits in with the project's plans.
Prior to the Juno development cycle, this repository was not used for spec reviews. Reviews prior to Juno were completed entirely through Launchpad blueprints:
https://blueprints.launchpad.net/cinder
Please note, Launchpad blueprints are still used for tracking the current status of blueprints. For more information, see:
https://wiki.openstack.org/wiki/Blueprints
For more information about working with gerrit, see:
https://docs.openstack.org/infra/manual/developers.html#development-workflow
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.
Please do not checkin the generated HTML files as a part of your
commit.