Update documentation file & sonar plugin

[dmaap/datarouter.git] / docs / index.rst

diff --git a/docs/index.rst b/docs/index.rst
index 77b53fb..f7dae49 100644 (file)
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -2,13 +2,26 @@
 .. http://creativecommons.org/licenses/by/4.0\r
 .. Copyright © 2017 AT&T Intellectual Property. All rights reserved.\r
 \r
-Message Router (MR)\r
-====================\r
+============================================\r
+Data Router (DR) API Guide\r
+============================================\r
+Introduction\r
+------------------\r
+\r
+The DataRouter(DR)provisioning API is an HTTPS-based,REST-like API for creating and managing DR feeds and subscriptions. The Data Routing System project is intended to provide a common framework by which data producers can make data available to data consumers and a way for potential consumers to find feeds with the data they require.\r
+\r
+\r
+HTTP Service APIs\r
+------------------\r
+\r
+DMaaP Message Router utilizes an HTTP REST API to service all transactions. HTTP and REST standards are followed so\r
+clients as varied as CURL, Java applications and even Web Browsers will\r
+work to interact with the Data Router.\r
 \r
 \r
 \r
 .. toctree::\r
-   :maxdepth: 2\r
+   :maxdepth: 3\r
    \r
    data-router/data-router\r
 \r