aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorDan Timoney <dtimoney@att.com>2019-02-05 17:34:40 +0000
committerGerrit Code Review <gerrit@onap.org>2019-02-05 17:34:40 +0000
commitd9715aa832e972456ac02c3059d520456bc977d0 (patch)
tree06943c1d58023988772a38137ebe83636be2127f /docs
parent7727f3dd84ce4ca2af5c3e589651ef57e3813fa9 (diff)
parent8d9676bfd67efa459b0be30cb56e8eadcb4fbb94 (diff)
Merge "Fixed errors as per DOC8 standard"
Diffstat (limited to 'docs')
-rw-r--r--docs/index.rst22
-rw-r--r--docs/microserviceslist.rst13
2 files changed, 24 insertions, 11 deletions
diff --git a/docs/index.rst b/docs/index.rst
index 2c7d9ab9..2a7239d4 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -9,17 +9,17 @@ CCSDK APPS DOCUMENTATION REPOSITORY
Introduction:
=============
-APPS repository which contains all micro services for CCSDK module.
-Also these are application that are intended to run outside of OpenDaylight
-container.Modular feature implementation that is reusable across all controllers.
+ APPS repository which contains all micro services for CCSDK module.
+ Also these are application that are intended to run outside of OpenDaylight
+ container.Modular feature implementation that is reusable across all controllers.
Microservices:
=============
-Controller BluePrints Studio Processor
-Blueprints processor
-NetworkElementNameGen (NENG)
-Vlan Tag API
+ Controller BluePrints Studio Processor
+ Blueprints processor
+ NetworkElementNameGen (NENG)
+ Vlan Tag API
Installation:
@@ -27,12 +27,12 @@ Installation:
Steps
-----
-To compile this code:
+ To compile this code:
-1. Make sure your local Maven settings file ($HOME/.m2/settings.xml) contains
-references to the ONAP repositories and OpenDaylight repositories.
+ 1. Make sure your local Maven settings file ($HOME/.m2/settings.xml) contains
+ references to the ONAP repositories and OpenDaylight repositories.
-2. To compile all of CCSDK apps code
+ 2. To compile all of CCSDK apps code
- git clone https://(LFID)@gerrit.onap.org/r/a/ccsdk/apps
- cd apps ; mvn clean install ; cd ..
diff --git a/docs/microserviceslist.rst b/docs/microserviceslist.rst
new file mode 100644
index 00000000..bdcee023
--- /dev/null
+++ b/docs/microserviceslist.rst
@@ -0,0 +1,13 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.
+.. Copyright (C) 2019 IBM.
+
+Microservices:
+---------------
+.. toctree::
+ :maxdepth: 1
+
+ Controller BluePrints Studio Processor
+ Blueprints processor
+ NetworkElementNameGen (NENG)
+ Vlan Tag API