openstack-ansible/README.rst
Flavio Percoco 689648bde5 Show team and repo badges on README
This patch adds the team's and repository's badges to the README file.
The motivation behind this is to communicate the project status and
features at first glance.

For more information about this effort, please read this email thread:

http://lists.openstack.org/pipermail/openstack-dev/2016-October/105562.html

To see an example of how this would look like check:

https://gist.github.com/f5529c703d2b222ed29964225fe22b8f

Change-Id: Id8e0cd69cad166290587931735a485008f1311da
2016-11-25 15:58:44 +01:00

47 lines
2.1 KiB
ReStructuredText

========================
Team and repository tags
========================
.. image:: http://governance.openstack.org/badges/openstack-ansible.svg
:target: http://governance.openstack.org/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
`Install 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-operators or openstack-dev)
or on IRC in ``#openstack-ansible`` on the `freenode network`_.
.. _official OpenStack project: http://governance.openstack.org/reference/projects/index.html
.. _Home Page: http://governance.openstack.org/reference/projects/openstackansible.html
.. _Install Guide: http://docs.openstack.org/developer/openstack-ansible/install-guide/index.html
.. _Quick Start: http://docs.openstack.org/developer/openstack-ansible/developer-docs/quickstart-aio.html
.. _Developer Documentation: http://docs.openstack.org/developer/openstack-ansible/developer-docs/index.html
.. _Source: http://git.openstack.org/cgit/openstack/openstack-ansible
.. _OpenStack Mailing Lists: http://lists.openstack.org/
.. _freenode network: https://freenode.net/