openstack-ansible/doc/source/index.rst
Jesse Pretorius 03041378f2 Docs: Implement Manuals Theme and doc8 checks
This patch implements:

- The OpenStack Manuals documentation theme.
- Some minor content changes to the index pages to ensure
  that they render correctly.
- Adjustments to the tox/requirements configuration in order
  to implement doc8 checks to facilitate improved documentation
  checking for incoming patches.
- Adjustments to the sphinx configuration for easier
  maintenance.

Note:
The bug_title in the openstackdocstheme is not currently
customisable. A patch to implement the ability to do so
has been submitted: https://review.openstack.org/338299

Partially-Implements: blueprint osa-install-guide-overhaul
Change-Id: I8af1a7ce9008e70abad00be96614c9997f59596b
2016-07-10 00:30:22 +01:00

79 lines
2.5 KiB
ReStructuredText

===============================
OpenStack-Ansible Documentation
===============================
Abstract
~~~~~~~~
OpenStack-Ansible provides Ansible playbooks and roles for the deployment and
configuration of an OpenStack environment.
Documentation for each of the following releases is available.
Newton (unreleased)
~~~~~~~~~~~~~~~~~~~
OpenStack-Ansible Newton is currently in development. The
`Newton Series Timeline`_ and `Newton Series Release Notes`_ are available for
review.
.. toctree::
:maxdepth: 1
install-guide/index
upgrade-guide/index
developer-docs/index
.. toctree::
:hidden:
install-guide-revised-draft/index
.. _Newton Series Timeline: https://launchpad.net/openstack-ansible/trunk
.. _Newton Series Release Notes: http://docs.openstack.org/releasenotes/openstack-ansible/unreleased.html
Mitaka (Current stable release, security-supported)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
OpenStack-Ansible's Mitaka Series was first released with the 13.0.0 tag on
1 April 2016.
* `OpenStack-Ansible Mitaka Documentation`_
* `OpenStack-Ansible Mitaka Series Release Notes`_
* `OpenStack-Ansible Mitaka Series Timeline`_
.. _OpenStack-Ansible Mitaka Documentation: http://docs.openstack.org/developer/openstack-ansible/mitaka/
.. _OpenStack-Ansible Mitaka Series Timeline: https://launchpad.net/openstack-ansible/mitaka
.. _OpenStack-Ansible Mitaka Series Release Notes: http://docs.openstack.org/releasenotes/openstack-ansible/mitaka.html
Liberty: Security-supported (EOL: 2016-11-17)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
OpenStack-Ansible's Liberty Series was first released with the 12.0.0 tag
on 11 September 2015.
* `OpenStack-Ansible Liberty Documentation`_
* `OpenStack-Ansible Liberty Series Release Notes`_
* `OpenStack-Ansible Liberty Series Timeline`_
.. _OpenStack-Ansible Liberty Documentation: http://docs.openstack.org/developer/openstack-ansible/liberty/
.. _OpenStack-Ansible Liberty Series Release Notes: http://docs.openstack.org/releasenotes/openstack-ansible/liberty.html
.. _OpenStack-Ansible Liberty Series Timeline: https://launchpad.net/openstack-ansible/liberty
Kilo: End of Life (2016-07-05)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
OpenStack-Ansible's Kilo series was first released with the 11.0.0 tag on
30 April 2015.
* `OpenStack-Ansible Kilo Documentation`_
* `OpenStack-Ansible Kilo Series Timeline`_
.. _OpenStack-Ansible Kilo Documentation: http://docs.openstack.org/developer/openstack-ansible/kilo/
.. _OpenStack-Ansible Kilo Series Timeline: https://launchpad.net/openstack-ansible/kilo