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:

b'https://gist.github.com/2c85567d0e6793bc2ed0060901457af0\n'

Change-Id: Ic8d520b02653b6b8378f39cc9be7a1054fa31704
This commit is contained in:
Flavio Percoco 2016-11-24 14:07:07 +01:00 committed by Karen Bradshaw
parent f30d53cda0
commit d12cd5cda2
3 changed files with 19 additions and 7 deletions

View File

@ -1,3 +1,12 @@
========================
Team and repository tags
========================
.. image:: http://governance.openstack.org/badges/os-api-ref.svg
:target: http://governance.openstack.org/reference/tags/index.html
.. Change things from this point on
os-api-ref
==========

View File

@ -3,13 +3,17 @@
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to os-api-ref's documentation!
========================================================
==============================================
Welcome to os-api-ref developer documentation!
==============================================
.. include:: readme.rst
.. include:: installation.rst
.. include:: usage.rst
.. include:: contributing.rst
.. toctree::
:maxdepth: 1
installation
usage
contributing
Indices and tables
==================

View File

@ -1 +0,0 @@
.. include:: ../../README.rst