openstack-ansible/README.rst
Doug Hellmann cd45e710d9 add links to readme for release announce script
The release announcement script expects to find links in this format
in order to include them in emails when announcing new releases.

Change-Id: I26f8c9792b6ff1f85b923bcdc4737ac59373ad17
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
2019-02-22 13:22:39 -05:00

67 lines
2.9 KiB
ReStructuredText

========================
Team and repository tags
========================
.. image:: https://governance.openstack.org/tc/badges/openstack-ansible.svg
:target: https://governance.openstack.org/tc/reference/tags/index.html
.. Change things from this point on
OpenStack-Ansible
#################
OpenStack-Ansible is an `official OpenStack project`_ which aims to deploy
production environments from source in a way that makes it scalable while
also being simple to operate, upgrade, and grow.
For an overview of the mission, repositories and related Wiki home page,
please see the formal `Home Page`_ for the project.
For those looking to test OpenStack-Ansible using an All-In-One (AIO) build,
please see the `Quick Start`_ guide.
For more detailed Installation and Operator documentation, please see the
`Deployment Guide`_.
If OpenStack-Ansible is missing something you'd like to see included, then
we encourage you to see the `Developer Documentation`_ for more details on
how you can get involved.
Developers wishing to work on the OpenStack-Ansible project should always
base their work on the latest code, available from the master GIT repository
at `Source`_.
If you have some questions, or would like some assistance with achieving your
goals, then please feel free to reach out to us on the
`OpenStack Mailing Lists`_ (particularly openstack-discuss)
or on IRC in ``#openstack-ansible`` on the `freenode network`_.
OpenStack-Ansible Roles
#######################
OpenStack-Ansible offers separate role repositories for each individual role
that OpenStack-Ansible supports. For individual role configuration options,
see the `Role Documentation`_.
An individual role's source code can be found at:
https://git.openstack.org/cgit/openstack/openstack-ansible-<ROLENAME>.
.. _official OpenStack project: https://governance.openstack.org/tc/reference/projects/index.html
.. _Home Page: https://governance.openstack.org/tc/reference/projects/openstackansible.html
.. _Deployment Guide: https://docs.openstack.org/project-deploy-guide/openstack-ansible/latest
.. _Quick Start: https://docs.openstack.org/openstack-ansible/latest/user/aio/quickstart.html
.. _Developer Documentation: https://docs.openstack.org/openstack-ansible/latest/contributor/index.html
.. _Source: https://git.openstack.org/cgit/openstack/openstack-ansible
.. _OpenStack Mailing Lists: http://lists.openstack.org/
.. _freenode network: https://freenode.net/
.. _Role Documentation: https://docs.openstack.org/project-deploy-guide/openstack-ansible/draft/configure.html#advanced-service-configuration
Resources
#########
* License: Apache License, Version 2.0
* Documentation: https://docs.openstack.org/openstack-ansible/latest/
* Source: https://git.openstack.org/cgit/openstack/openstack-ansible
* Bugs: https://bugs.launchpad.net/openstack-ansible
* Release notes: https://docs.openstack.org/releasenotes/openstack-ansible/