From 63d0120ae255d778a9a8328ec8e7bc5418eb3e99 Mon Sep 17 00:00:00 2001
From: David Moreau Simard <dmsimard@redhat.com>
Date: Wed, 6 Mar 2019 17:39:52 -0500
Subject: [PATCH] Include ansible-role-ara's README in the docs

We don't have proper documentation for the role other than the README
right now, let's at least use that.

Change-Id: I27bd0dccce2ffb61c4d6d0adb3e400836141af3c
---
 doc/source/ansible-role-ara.rst |  1 +
 doc/source/index.rst            |  5 +++++
 doc/source/installation.rst     | 10 ++++++++++
 roles/ara/README.rst            | 12 ++++++------
 4 files changed, 22 insertions(+), 6 deletions(-)
 create mode 100644 doc/source/ansible-role-ara.rst

diff --git a/doc/source/ansible-role-ara.rst b/doc/source/ansible-role-ara.rst
new file mode 100644
index 00000000..f3eadbbe
--- /dev/null
+++ b/doc/source/ansible-role-ara.rst
@@ -0,0 +1 @@
+.. include:: ../../roles/ara/README.rst
diff --git a/doc/source/index.rst b/doc/source/index.rst
index 3c90bf80..37ee05a8 100644
--- a/doc/source/index.rst
+++ b/doc/source/index.rst
@@ -13,3 +13,8 @@ Table of Contents
     API authentication and security <api-security>
     API usage with built-in clients <api-usage>
     Architecture and workflows <architecture>
+
+.. toctree::
+   :maxdepth: 1
+
+    ansible-role-ara <ansible-role-ara>
diff --git a/doc/source/installation.rst b/doc/source/installation.rst
index f8e22f8d..117d9319 100644
--- a/doc/source/installation.rst
+++ b/doc/source/installation.rst
@@ -3,6 +3,9 @@
 Installing ARA
 ==============
 
+Manually with pip
+-----------------
+
 ARA should work on any Linux distributions as long as python3 is available.
 
 It is recommended to use a python `virtual environment <https://docs.python.org/3/tutorial/venv.html>`_
@@ -13,3 +16,10 @@ in order to avoid conflicts with your Linux distribution python packages::
 
     # Install ARA 1.0 from source
     ~/.ara/venv/bin/pip install git+https://git.openstack.org/openstack/ara@feature/1.0
+
+Using ansible-role-ara
+----------------------
+
+An Ansible role is available to install and configure ARA.
+
+For more details, refer to the role documentation: :ref:`ansible-role-ara`.
diff --git a/roles/ara/README.rst b/roles/ara/README.rst
index 7c99e305..36536773 100644
--- a/roles/ara/README.rst
+++ b/roles/ara/README.rst
@@ -8,12 +8,12 @@ deployment topologies.
 It is currently tested and supported against Ubuntu 18.04 and Fedora 29.
 
 Role Variables
-==============
+--------------
 
-See ``defaults/main.yaml``.
+See `defaults/main.yaml <https://github.com/openstack/ara/blob/feature/1.0/roles/ara/defaults/main.yaml>`_.
 
 TL;DR
-=====
+-----
 
 Playbook that runs the role with defaults::
 
@@ -39,7 +39,7 @@ What the role ends up doing by default:
 - Collects static files (``ara-manage collectstatic``) into ``~/.ara/www``
 
 About deployment topologies
-===========================
+---------------------------
 
 This Ansible role is designed to support different opinionated topologies that
 can be selected with role variables.
@@ -62,7 +62,7 @@ with apache, mod_wsgi and postgresql.
 Or any combination of any of those.
 
 Example playbooks
-=================
+-----------------
 
 Install ARA and set up the API to be served by a persistent gunicorn service::
 
@@ -96,7 +96,7 @@ Install ARA and set up the API to be served by nginx in front of gunicorn::
         - ara
 
 Copyright
-=========
+---------
 
 ::