summaryrefslogtreecommitdiffstats
path: root/docs/sections/services/restconf
diff options
context:
space:
mode:
authorHansen, Tony (th1395) <th1395@att.com>2023-05-23 21:27:17 +0000
committerHansen, Tony (th1395) <th1395@att.com>2023-05-31 21:01:29 +0000
commit663df2c1b8d9176094a62b00b7e80de096180621 (patch)
tree849841dc428fcfba07d9c39494f95ccd1f25da8a /docs/sections/services/restconf
parentbcd436a1be4fbe2c8ad7ce074d86b94b8ff44f4e (diff)
clean up some sphinx warnings
Change-Id: I8c2d925e8b27b4740227af0be3ab5d6f7153ec38 Signed-off-by: Hansen, Tony (th1395) <th1395@att.com> Issue-ID: DCAEGEN2-3399 Signed-off-by: Hansen, Tony (th1395) <th1395@att.com> Signed-off-by: Vijay Venkatesh Kumar <vv770d@att.com> Signed-off-by: Hansen, Tony (th1395) <th1395@att.com>
Diffstat (limited to 'docs/sections/services/restconf')
-rw-r--r--docs/sections/services/restconf/development_info.rst6
-rw-r--r--docs/sections/services/restconf/functionality.rst6
-rw-r--r--docs/sections/services/restconf/index.rst6
3 files changed, 13 insertions, 5 deletions
diff --git a/docs/sections/services/restconf/development_info.rst b/docs/sections/services/restconf/development_info.rst
index 31e2ddbe..8c194e5e 100644
--- a/docs/sections/services/restconf/development_info.rst
+++ b/docs/sections/services/restconf/development_info.rst
@@ -1,9 +1,13 @@
+.. This work is licensed under a
+ Creative Commons Attribution 4.0 International License.
+ http://creativecommons.org/licenses/by/4.0
+
Compiling RestConf Collector
=============================
RestconfCollector is a sub-project of dcaegen2/colletcors/ (https://gerrit.onap.org/r/dcaegen2/collectors/restconf).
To build the Restconf Collector component, run the following maven command from within **collectors/restconf** directory
-`mvn clean install`
+`mvn clean install`
Maven GroupId:
diff --git a/docs/sections/services/restconf/functionality.rst b/docs/sections/services/restconf/functionality.rst
index 15d42068..4cfe2569 100644
--- a/docs/sections/services/restconf/functionality.rst
+++ b/docs/sections/services/restconf/functionality.rst
@@ -1,3 +1,7 @@
+.. This work is licensed under a
+ Creative Commons Attribution 4.0 International License.
+ http://creativecommons.org/licenses/by/4.0
+
Functionality
=============
@@ -9,5 +13,5 @@ RestconfCollector interaction with an external controller.
.. image:: ../../images/rcc_diag_interact.png
-For more details about the Restconfcollector, visit
+For more details about the Restconfcollector, visit
* https://wiki.onap.org/pages/viewpage.action?pageId=60891182
diff --git a/docs/sections/services/restconf/index.rst b/docs/sections/services/restconf/index.rst
index 66564e90..9b0240e7 100644
--- a/docs/sections/services/restconf/index.rst
+++ b/docs/sections/services/restconf/index.rst
@@ -2,20 +2,20 @@
.. http://creativecommons.org/licenses/by/4.0
==================
-RestConf Collector
+RestConf Collector
==================
Overview
========
Restconf collector is a microservice in ONAP DCAE. It subscribes to external controllers
-and receives event data. After receiving event data it may modify it as per usecase's requirement and
+and receives event data. After receiving event data it may modify it as per usecase's requirement and
produce a DMaaP event. This DMaap event usually consumed by VES mapper.
Restconf Collector can subscribe multiple events from multiple controllers.
.. toctree::
:maxdepth: 1
- ./installation
+ ./installation-helm
./functionality
./development_info