diff --git a/README.rst b/README.rst index 3501161a..905a7bae 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. `_ For additional information, take a look at the `Tuskar documentation `_. + Installation Information ------------------------ @@ -42,10 +35,11 @@ Contributing Interested in contributing? Take a look at `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 d4f9ae3b..fd4277c9 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. `_ -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! `_ - - *TODO* feature examples - *TODO* link to high-level portion of FAQ -- `Recommended reading `_ +- :doc:`Recommended reading ` Related Projects ---------------- -- `tuskar-ui `_ - Built on top - of Horizon, tuskar-ui provides dashboard access to Tuskar functionality. -- `python-tuskarclient `_ - - A Python client for the Tuskar API, python-tuskarclient is utilized - by tuskar-ui. +- `tuskar-ui `_ - tuskar-ui provides dashboard access to Tuskar + functionality as a Horizon plugin. See the `Tuskar UI + documentation `_ +- `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 install contributing @@ -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