aboutsummaryrefslogtreecommitdiffstats
path: root/docs/data-router/DataRouterUserGuide.rst
diff options
context:
space:
mode:
authorEmmett Cox <emmett.cox@ericsson.com>2018-09-17 10:25:09 +0100
committerEmmett Cox <emmett.cox@ericsson.com>2018-09-20 11:08:16 +0100
commit8dde0cc7824e32f1a829b1528fa0e61a5707098f (patch)
treee598401085707d6ed913f76b3e5a7171a5c8d4ca /docs/data-router/DataRouterUserGuide.rst
parent4e61cfafc9b10ca604b8e2c7ec0272246502fa82 (diff)
User guide documentation for data router
Change-Id: If28014e4f937c9036e22f2db7599fd8568f0c13f Signed-off-by: Emmett Cox <emmett.cox@ericsson.com> Issue-ID: DMAAP-552
Diffstat (limited to 'docs/data-router/DataRouterUserGuide.rst')
-rw-r--r--docs/data-router/DataRouterUserGuide.rst25
1 files changed, 25 insertions, 0 deletions
diff --git a/docs/data-router/DataRouterUserGuide.rst b/docs/data-router/DataRouterUserGuide.rst
new file mode 100644
index 00000000..8f7b9ef1
--- /dev/null
+++ b/docs/data-router/DataRouterUserGuide.rst
@@ -0,0 +1,25 @@
+===========================
+Data Router (DR) User Guide
+===========================
+
+Standalone Mode
+---------------
+
+Installation
+============
+
+1. Find the datarouter project on the gerrit website: https://gerrit.onap.org/r/#/admin/projects/dmaap/datarouter
+
+2. Clone the repo onto your server using the clone command found on the datarouter page on gerrit.
+
+3. cd into the docker-compose directory and run docker-compose up.
+
+Configurations
+==============
+
+Using the Data Router
+---------------------
+
+For information on how to use the Data Router refer to the Data Router API guide at:
+
+ :ref:`data_router_api_guide` \ No newline at end of file