openstack
/
openstack-ansible-specs
Code Issues Proposed changes
Design Specifications for OpenStack-Ansible
167 Commits 1 Branch 0 Tags 2.4 MiB
Python 100%
Go to file
Jean-Philippe Evrard 588fe711cc Improve user experience by simplifying the guides 
We should as much as possible simplify the deploy guide, and
if possible, reduce the amount of duplicate documentation.

I think this spec shows a few areas of improvements we could set
in place to streamline the user experience.

Change-Id: If884c7a56f9bc97a89973ae98840b5783fb88b88
 		2018-01-19 14:19:39 +00:00
doc/source Fix linter issue 2017-11-22 08:01:50 -06:00
specs Improve user experience by simplifying the guides 2018-01-19 14:19:39 +00: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 2017-06-22 15:20:30 +00:00
.gitreview Update .gitreview for project rename 2015-09-11 20:58:14 +00:00
.testr.conf Initial commit for OS-Ansible-Deployment specs 2015-03-17 14:19:19 -05:00
LICENSE Initial commit for OS-Ansible-Deployment specs 2015-03-17 14:19:19 -05:00
README.rst Show team and repo badges on README 2016-11-25 16:32:07 +01:00
requirements.txt Updated from global requirements 2017-09-16 23:21:01 +00:00
setup.cfg Changed the home-page link 2016-10-06 06:34:37 +00:00
setup.py Updated from global requirements 2017-03-02 11:52:34 +00:00
tox.ini Implement doc8 checks 2016-09-28 12:21:11 +01: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.