121d2b5355
This patch does two things to clean up gate package requirements, adding a bindep file and moving packages to the right location. Bindep controls which system packages are installed. If a project does not have a bindep.txt file present, the gate jobs will fall back to a common list of packages. These include things like mariadb and various clients that are not needed for specs repos. Added a basic bindep.txt file with just the things we need to ensure are present for building the docs in specs. There are also plans to stop looking at requirements.txt for specs since these repos do not install Python code. The two locations that are looked at are test-requirements.txt for running included tests, and doc/requirements.txt for anything needed for doc builds such as sphinx and plugins. Change-Id: I3a222d7eec32b0d5ae6ef4ad20b34603931e13d6
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.
Specifications have to be re-proposed for every release. The review may be quick, but even if something was previously approved, it should be re-reviewed to make sure it still makes sense as written.
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/cinderPlease note, Launchpad blueprints are still used for tracking the current status of blueprints. For more information, see:
https://wiki.openstack.org/wiki/BlueprintsFor more information about working with gerrit, see:
https://docs.openstack.org/infra/manual/developers.html#development-workflowTo 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.
Please do not checkin the generated HTML files as a part of your
commit.