openstack
/
openstack-chef-specs
Code Issues Proposed changes
RETIRED, OpenStack Chef Blueprint specs
48 Commits 1 Branch 0 Tags 599 KiB
Go to file
Andreas Jaeger 4472d399c1 Cleanup py27 support and docs 
Make a few cleanups:
- Remove obsolete sections from setup.cfg
- Switch to using sphinx-build; fix warnings found:
  convert unreferenced footnote into normal link
- Cleanup doc/source/conf.py to remove now obsolete content.
- Use newer openstackdocstheme version, update some other versions as
  needed
- Remove install_command from tox.ini, the default is fine; cleanup
  for python3 only

Change-Id: If18af73f3886ad32622801193f7f7ae53458b50c
 		2020-04-19 12:44:34 +00:00
doc Cleanup py27 support and docs 2020-04-19 12:44:34 +00:00
specs Cleanup py27 support and docs 2020-04-19 12:44:34 +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 Replacing the HTTP protocal with HTTPS 2019-08-08 09:47:22 +00:00
requirements.txt Cleanup py27 support and docs 2020-04-19 12:44:34 +00:00
setup.cfg Cleanup py27 support and docs 2020-04-19 12:44:34 +00:00
setup.py Filling in the initial layout for the repo. 2014-07-25 12:13:09 -05:00
tox.ini Cleanup py27 support and docs 2020-04-19 12:44:34 +00: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:

https://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:

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.