Update Release Note
[clamp.git] / docs / index.rst
index c654c81..38044ab 100644 (file)
@@ -1,6 +1,6 @@
 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
 .. http://creativecommons.org/licenses/by/4.0
-.. Copyright 2017 AT&T Intellectual Property. All rights reserved.
+.. Copyright © 2017 AT&T Intellectual Property. All rights reserved.
 
 CLAMP - Closed Loop Automation Management Platform
 ==================================================
@@ -31,9 +31,10 @@ CLAMP offers the following API:
 Consumed APIs
 -------------
 CLAMP uses the API's exposed by the following ONAP components:
-* SDC : REST based interface exposed by the SDC, Distribution of service to DCAE
-* DCAE: REST based interface exposed by DCAE, Common Controller Framework, DCAE microservices onboarded (TCA, Stringmatch, Holmes (optional))
-* Policy: REST based interface (the Policy team provide a "jar" to handle the communication), both XACML and Drools PDP, APIs to App-C/VF-C/SDN-C
+
+- SDC : REST based interface exposed by the SDC, Distribution of service to DCAE
+- DCAE: REST based interface exposed by DCAE, Common Controller Framework, DCAE microservices onboarded (TCA, Stringmatch, Holmes (optional))
+- Policy: REST based interface (the Policy team provide a "jar" to handle the communication), both XACML and Drools PDP, APIs to App-C/VF-C/SDN-C
 
 
 Delivery
@@ -69,6 +70,7 @@ CLAMP uses logback framework to generate logs. The logback.xml file cand be foun
 With the default log settings, all logs will be generated into console and into root.log file under the CLAMP root folder. The root.log file is not allowed to be appended, thus restarting the CLAMP will result in cleaning of the old log files.
 
 
+.. _index-clamp-installation:
 
 Installation
 ------------
@@ -131,11 +133,12 @@ Administration
 
 A user can access CLAMP UI at the following URL : http://localhost:8080/designer/index.html.
 (in this URL 'localhost' must be replaced by the actual host where CLAMP has been installed if it is not your current localhost)
-.. code-block::
+
+.. code-block:: html
+
     Default username : admin
     Default password : password
 
-
 Human Interfaces
 ----------------
 .. Basic info on the interface type, ports/protocols provided over, etc.
@@ -164,6 +167,6 @@ The following actions are done using the UI:
 
 * Control (start/stop) the operation of the control loop in DCAE
 
-Please refer to the `Using ONAP <https://wiki.onap.org/display/DW/Control+Loop+Design>` for more details
+
 
 HealthCheck API - serve to verify CLAMP status (see offered API's section)