After the 2016 Austin summit, there was a discussion and a consensus surrounding the current state of the OpenStack-Ansible Installation Guide.
A blueprint and spec were previously created with the intention of improving the documentation that pushed the summit discussion.
Currently, the OpenStack-Ansible install guide has minimal installation information, and a lot of configuration information. This specification proposes a more formalized plan to separate this information and streamline the installation guide to make it easier and quicker to install OpenStack.
The OpenStack-Ansible Installation Guide contains information that does not necessarily pertain to that of an installation guide structure. It has accumulated a lot of configuration information and reference information that reduces the user’s focus and simplicity to install OpenStack.
The current installation guide also does not follow the openstack-manuals documentation conventions.
The main focus of the installation guide is reorganising and developing content so a deployer makes very few decisions and minimal configuration to deploy an OpenStack test environment and production environment.
The proposed changes are: * Clearly define reference architecture and develop use case configuration
examples in an appendix.
information to the developer docs.
<http://specs.openstack.org/openstack/docs-specs/specs/newton/project-specific-installguides.html>`_ and publish to docs.openstack.org
These changes will hopefully improve the end user experience, by providing a more structured and better flow of information to install OpenStack.
Move existing content over to the roles first, then developers must submit any new documentation to the role repositories.
The testing will be conducted by the community once a draft is available. OpenStack-Ansible users will be asked to follow the new installation guide to install OpenStack and evaluate if the information provided is accurate, clear, and concise.
This is a documentation change, N/A.