From dd198b384877ad42605375f198335368c6ff2fff Mon Sep 17 00:00:00 2001
From: Dougal Matthews <dougal@redhat.com>
Date: Thu, 2 Oct 2014 12:14:09 +0100
Subject: [PATCH] Update the README and Documentation Index

This adds a simpler but more up-to-date descrption of what Tuskar is.

Change-Id: Ic91837560d4660ade9f94990c9e2a5ac911642b5
---
 README.rst           | 20 ++++++-----------
 doc/source/index.rst | 51 ++++++++++++++------------------------------
 2 files changed, 23 insertions(+), 48 deletions(-)

diff --git a/README.rst b/README.rst
index 6b2ae5f2..948f2e6d 100644
--- a/README.rst
+++ b/README.rst
@@ -4,23 +4,16 @@ Tuskar
 
 What is Tuskar?
 ---------------
-Tuskar gives administrators the ability to control how and where
-OpenStack services are deployed across the datacenter. Using Tuskar,
-administrators divide hardware into "resource classes" that allow
-predictable elastic scaling as cloud demands grow. This resource
-orchestration allows Tuskar users to ensure SLAs, improve performance,
-and maximize utilization across the datacenter.
 
-Tuskar services are available via a RESTful API and management console
-through which administrators are able to classify their hardware and
-define their datacenters. In addition, Tuskar components provide
-administrators with performance monitoring, health statistics, and
-usage metrics, aiding in capacity planning and hardware procurement
-decisions.
+Tuskar is a management service for planning TripleO deployments.
+
+Interested in seeing the full Tuskar and Tuskar UI setup? `Watch
+the demo. <https://www.youtube.com/watch?v=--WWdJXmf8o>`_
 
 For additional information, take a look at the `Tuskar
 documentation <http://git.openstack.org/cgit/openstack/tuskar/tree/docs/index.rst>`_.
 
+
 Installation Information
 ------------------------
 
@@ -43,10 +36,11 @@ Interested in contributing?  Take a look at
 `CONTRIBUTING.rst <doc/source/CONTRIBUTING.rst>`_
 for details on how to do so.
 
+
 Contact Us
 ----------
 
 Join us on IRC (Internet Relay Chat)::
 
     Network: Freenode (irc.freenode.net/tuskar)
-    Channel: #tuskar
+    Channel: #tripleo and #tuskar
diff --git a/doc/source/index.rst b/doc/source/index.rst
index 8d673a8a..305025fd 100644
--- a/doc/source/index.rst
+++ b/doc/source/index.rst
@@ -2,40 +2,32 @@
 Tuskar
 ======
 
-Tuskar gives administrators the ability to control how and where
-OpenStack services are deployed across the datacenter. Using Tuskar,
-administrators divide hardware into "resource classes" that allow
-predictable elastic scaling as cloud demands grow. This resource
-orchestration allows Tuskar users to ensure SLAs, improve performance,
-and maximize utilization across the datacenter.
+Tuskar is a management service for planning TripleO deployments.
+
+Interested in seeing the full Tuskar and Tuskar UI setup? `Watch
+the demo. <https://www.youtube.com/watch?v=--WWdJXmf8o>`_
 
-Tuskar services are available via a RESTful API and management console
-through which administrators are able to classify their hardware and
-define their datacenters. In addition, Tuskar components provide
-administrators with performance monitoring, health statistics, and
-usage metrics, aiding in capacity planning and hardware procurement
-decisions.
 
 High-Level Overview
 ===================
 
 *TODO* Add project overview
 
-Interested in seeing Tuskar in action? `Watch a
-demo! <https://www.youtube.com/watch?v=VEY035-Lyzo>`_
-
 -  *TODO* feature examples
 -  *TODO* link to high-level portion of FAQ
--  `Recommended reading <docs/recommended-reading.rst>`_
+-  :doc:`Recommended reading <recommended-reading>`
 
 Related Projects
 ----------------
 
--  `tuskar-ui <http://git.openstack.org/cgit/openstack/tuskar-ui>`_ - Built on top
-   of Horizon, tuskar-ui provides dashboard access to Tuskar functionality.
--  `python-tuskarclient <http://git.openstack.org/cgit/openstack/python-tuskarclient>`_
-   - A Python client for the Tuskar API, python-tuskarclient is utilized
-   by tuskar-ui.
+-  `tuskar-ui <http://git.openstack.org/cgit/openstack/tuskar-
+   ui>`_ - tuskar-ui provides dashboard access to Tuskar
+   functionality as a Horizon plugin. See the `Tuskar UI
+   documentation <http://tuskar-ui.readthedocs.org/en/latest/>`_
+-  `python-tuskarclient <http://git.openstack.org/cgit/openstack
+   /python-tuskarclient>`_ - A Python client for the Tuskar API,
+   python-tuskarclient is
+   utilized by tuskar-ui.
 
 Developer Information
 =====================
@@ -44,7 +36,7 @@ Install and Contribute
 ----------------------
 
 .. toctree::
-  :maxdepth: 1
+  :maxdepth: 2
 
   CONTRIBUTING
   install
@@ -54,26 +46,15 @@ API version 2
 -------------
 
 .. toctree::
-  :maxdepth: 1
+  :maxdepth: 2
 
   api/curl-v2
 
-HEAT Integration
-----------------
-
--  *TODO* How HEAT update works
--  *TODO* Generation of the HEAT template
-
-Other
------
-
--  *TODO* link to developer portion of FAQ
-
 Contact Us
 ==========
 
 Join us on IRC (Internet Relay Chat)::
 
     Network: Freenode (irc.freenode.net/tuskar)
-    Channel: #tuskar
+    Channel: #tripleo and #tuskar