From d12cd5cda21549e21f2f0769152aff5c4d52e724 Mon Sep 17 00:00:00 2001
From: Flavio Percoco <flaper87@gmail.com>
Date: Thu, 24 Nov 2016 14:07:07 +0100
Subject: [PATCH] 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
---
 README.rst            |  9 +++++++++
 doc/source/index.rst  | 16 ++++++++++------
 doc/source/readme.rst |  1 -
 3 files changed, 19 insertions(+), 7 deletions(-)
 delete mode 100644 doc/source/readme.rst

diff --git a/README.rst b/README.rst
index f60da7e..62a40f2 100644
--- a/README.rst
+++ b/README.rst
@@ -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
 ==========
 
diff --git a/doc/source/index.rst b/doc/source/index.rst
index b2b8c79..61922c5 100644
--- a/doc/source/index.rst
+++ b/doc/source/index.rst
@@ -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
 ==================
diff --git a/doc/source/readme.rst b/doc/source/readme.rst
deleted file mode 100644
index a6210d3..0000000
--- a/doc/source/readme.rst
+++ /dev/null
@@ -1 +0,0 @@
-.. include:: ../../README.rst