Design Specifications for OpenStack-Ansible
Go to file
sonpn13 2b72a22f77 PDF Documentation Build tox target
Change-Id: I54e3d3d6fbe0b753597703b6e61f884703c4e7e7
Signed-off-by: sonpn13 <sonpn13@viettel.com.vn>
Story: 2006105
Task: 35341
2022-04-27 09:53:18 -04:00
doc PDF Documentation Build tox target 2022-04-27 09:53:18 -04:00
specs Duplicate word deleted in ipv6-project-support.rst 2022-01-04 11:34:47 +00:00
.gitignore Updated from OpenStack Ansible Tests 2019-08-20 03:07:32 +00:00
.gitreview OpenDev Migration Patch 2019-04-19 19:36:19 +00: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 Switch to newer openstackdocstheme version 2020-06-03 17:42:20 +02:00
setup.cfg setup.cfg: Replace dashes with underscores 2021-04-30 09:59:18 +08:00
setup.py Cleanup py27 support 2020-04-10 11:21:00 +02:00
tox.ini PDF Documentation Build tox target 2022-04-27 09:53:18 -04: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.