Design Specifications for OpenStack-Ansible
Go to file
Andreas Jaeger a73df5a05f Cleanup py27 support
Make a few cleanups:
- Remove python 2.7 stanza from setup.py
- Remove obsolete sections from setup.cfg
- Switch to using sphinx-build, fix doc warnings
- Cleanup doc/source/conf.py to remove now obsolete content.
- Use newer openstackdocstheme version
- Remove install_command from tox.ini, the default is fine

Change-Id: I23a2d62a8853f01e8574ef37b5ee1ac2ee09acd0
2020-04-10 11:21:00 +02:00
doc/source Cleanup py27 support 2020-04-10 11:21:00 +02:00
specs Cleanup py27 support 2020-04-10 11:21:00 +02:00
tests Cleaned up specs directory 2015-07-24 08:33:20 -05:00
tools Initial commit for OS-Ansible-Deployment specs 2015-03-17 14:19:19 -05:00
.gitignore Updated from OpenStack Ansible Tests 2018-10-02 14:56:35 +00:00
.gitreview OpenDev Migration Patch 2019-04-19 19:36:19 +00:00
.testr.conf Initial commit for OS-Ansible-Deployment specs 2015-03-17 14:19:19 -05:00
.zuul.yaml import zuul job settings from project-config 2018-08-21 13:21:27 +00:00
LICENSE Initial commit for OS-Ansible-Deployment specs 2015-03-17 14:19:19 -05:00
README.rst Update links in README 2018-03-03 12:19:04 +08:00
requirements.txt Cleanup py27 support 2020-04-10 11:21:00 +02:00
setup.cfg Cleanup py27 support 2020-04-10 11:21:00 +02:00
setup.py Cleanup py27 support 2020-04-10 11:21:00 +02:00
tox.ini Cleanup py27 support 2020-04-10 11:21:00 +02:00

README.rst

Team and repository tags

image

OS-Ansible-Deployment Specifications

This git repository is used to hold approved design specifications for additions to the OS-Ansible-Deployment 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/openstack-ansible

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.