openstack
/
openstack-chef-specs
Code Issues Proposed changes
RETIRED, OpenStack Chef Blueprint specs
46 Commits 1 Branch 0 Tags 600 KiB
Go to file
Jens Harbott a57a5f190b Update specs to build with Sphinx 2.0 
The oslosphinx theme is EOL and doesn't work with Sphinx 2.0, so we need
to switch to openstackdocstheme instead. This patch is following what
nova-specs did in [0], but of course all blame is to go on me, not them.

[0] https://review.opendev.org/648670

Change-Id: Iaf5bb355dae15ee3681b39d354f160951d19f47f
 		2019-08-07 13:29:56 +00:00
doc Update specs to build with Sphinx 2.0 2019-08-07 13:29:56 +00:00
specs Fixed the spelling error 2018-12-26 12:19:26 +00:00
.gitignore Filling in the initial layout for the repo. 2014-07-25 12:13:09 -05:00
.gitreview OpenDev Migration Patch 2019-04-19 19:36:22 +00:00
.zuul.yaml import zuul job settings from project-config 2018-08-31 07:38:06 -04:00
CONTRIBUTING.rst refactored for switch to specs.openstack.org 2015-08-04 11:54:01 +02:00
HACKING.rst Optimizing the safety of the http link site in HACKING.rst 2018-11-16 11:44:33 +08:00
LICENSE refactored for switch to specs.openstack.org 2015-08-04 11:54:01 +02:00
MAINTAINERS.md Updates the MAINTAINERS.md with current cores 2016-08-17 13:34:19 -07:00
README.rst Show team and repo badges on README 2016-11-25 17:12:20 +01:00
requirements.txt Update specs to build with Sphinx 2.0 2019-08-07 13:29:56 +00:00
setup.cfg Change openstack-dev to openstack-discuss 2018-12-09 04:09:30 +00:00
setup.py Filling in the initial layout for the repo. 2014-07-25 12:13:09 -05:00
tox.ini fix tox python3 overrides 2018-10-01 15:44:53 -04:00

README.rst

Team and repository tags

image

OpenStack-chef Specifications

This git repository is used to hold approved design specifications for additions to the openstack-chef project. Reviews of the specifications 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>/<cookbook>/

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. Use the Common cookbook directory for specifications that effect multiple cookbooks. Once the specification is approved and merged, the LaunchPad blueprint will be updated accordingly.

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:

http://blueprints.launchpad.net/openstack-chef

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:

http://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.