Merge "Document Updates and Bug Fixes"

10 files changed, 44 insertions, 109 deletions

diff --git a/docs/architecture.rst b/docs/architecture.rst
index 8daa0d3b..ae29f9e0 100644
--- a/docs/architecture.rst
+++ b/docs/architecture.rst
@@ -4,15 +4,7 @@
 Architecture
 ============
 
-.. note::
-   * This section is used to describe a software component from a high level
-     view of capability, common usage scenarios, and interactions with other
-     components required in the usage scenarios.  
-   
-   * The architecture section is typically: provided in a platform-component
-     and sdk collections; and referenced from developer and user guides.
-   
-   * This note must be removed after content has been added.
+` See ONAP Wiki <https://wiki.onap.org/display/DW/MUSIC-Multi-site+State+Coordination+Service>`_
 
 
 Capabilities
diff --git a/docs/configuration.rst b/docs/configuration.rst
index 085f9c66..609b33e0 100644
--- a/docs/configuration.rst
+++ b/docs/configuration.rst
@@ -4,24 +4,25 @@
 Configuration
 =============
 
-.. note::
-   * This section is used to describe the options a software component offers for configuration.
+See the following pages for Configuration Information:
 
-   * Configuration is typically: provided for platform-component and sdk projects;
-     and referenced in developer and user guides.
-   
-   * This note must be removed after content has been added.
+.. toctree::
+   :maxdepth: 1
 
+   Single-Site Install <single>
+   Muili-Site Install <multi>
+   Authentication <authentication>
 
 
-Example ...
 
-You can provide the following in ``basic.conf``
+.. Example ...
 
-``host=ADDRESS``
-  The address of the host
+.. You can provide the following in ``basic.conf``
 
-``port=PORT``
-  The port used for signaling
+.. ``host=ADDRESS``
+..   The address of the host
 
-  Optional. Default: ``8080``
+.. ``port=PORT``
+..   The port used for signaling
+
+..   Optional. Default: ``8080``
diff --git a/docs/consumedapis.rst b/docs/consumedapis.rst
deleted file mode 100644
index c2af4c20..00000000
--- a/docs/consumedapis.rst
+++ /dev/null
@@ -1,16 +0,0 @@
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.
-.. http://creativecommons.org/licenses/by/4.0
-
-Consumed APIs
-=============
-
-.. note::
-   * This section is used to reference APIs that a software component depends on
-     and uses from other sources.  
-   
-   * Consumed APIs should be a specific link to the offered APIs from another component
-     or external source.
-
-   * This note must be removed after content has been added.
-
-
diff --git a/docs/delivery.rst b/docs/delivery.rst
deleted file mode 100644
index f3f083a7..00000000
--- a/docs/delivery.rst
+++ /dev/null
@@ -1,44 +0,0 @@
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.
-.. http://creativecommons.org/licenses/by/4.0
-
-Delivery
-========
-
-.. note::
-   * This section is used to describe a software component packaging.
-     For a run-time component this might be executable images, containers, etc.
-     For an SDK this might be libraries.
-
-   * This section is typically provided for a platform-component and sdk;
-     and referenced in developer and user guides
-   
-   * This note must be removed after content has been added.
-
-Example use of a block diagram.
-
-.. blockdiag::
-   
-
-   blockdiag layers {
-   orientation = portrait
-   a -> m;
-   b -> n;
-   c -> x;
-   m -> y;
-   m -> z;
-   group l1 {
-	color = blue;
-	x; y; z;
-	}
-   group l2 {
-	color = yellow;
-	m; n; 
-	}
-   group l3 {
-	color = orange;
-	a; b; c;
-	}
-
-   }
-
-
diff --git a/docs/index.rst b/docs/index.rst
index 3ef97755..437a50d8 100755
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -8,17 +8,17 @@ Music Developer Documentation
 .. toctree::
    :maxdepth: 1
 
-   Single-SIte Install <single>
-   Muili-Site Install <multi>
+   installation
    setup
    release-notes
-
+   architecture 
+   logging
+   configuration
+   
    
 ..   architecture
-..   configuration
 ..   consumedapis
 ..   delivery
 ..   index
-..   installation 
-..   logging
+..    
 ..   offeredapis
diff --git a/docs/installation.rst b/docs/installation.rst
index be64a63b..0f591eb7 100644
--- a/docs/installation.rst
+++ b/docs/installation.rst
@@ -4,17 +4,17 @@
 Installation
 ============
 
-.. note::
-   * This section is used to describe how a software component is acquired and installed.
-   
-   * This section is typically: provided for a platform-component and application; and
-     referenced in user guides.
 
-   * This note must be removed after content has been added.
+.. toctree::
+   :maxdepth: 1
 
-Environment
------------
+   Single-Site Install <single>
+   Muili-Site Install <multi>
 
 
-Steps
------
+.. Environment
+.. -----------
+
+
+.. Steps
+.. -----
diff --git a/docs/logging.rst b/docs/logging.rst
index 39eabfba..b1d3a186 100644
--- a/docs/logging.rst
+++ b/docs/logging.rst
@@ -4,14 +4,8 @@
 Logging
 =======
 
-.. note::
-   * This section is used to describe the informational or diagnostic messages emitted from 
-     a software component and the methods or collecting them.
-   
-   * This section is typically: provided for a platform-component and sdk; and
-     referenced in developer and user guides
-   
-   * This note must be removed after content has been added.
+Log file produced will be in /opt/app/music/logs/MUSIC/music.log,error.log,debug.log
+Log files are in EELF format. 
 
 
 Where to Access Information
@@ -20,3 +14,6 @@ Where to Access Information
 
 Error / Warning Messages
 ------------------------
+
+
+
diff --git a/docs/release-notes.rst b/docs/release-notes.rst
index aead6632..766fb123 100644
--- a/docs/release-notes.rst
+++ b/docs/release-notes.rst
@@ -13,6 +13,11 @@ Version: 2.5.4
 
 **New Features**
 
+MUSIC provides a service with recipes that individual ONAP components and microservice can use for 
+    - state replication across multiple geo-distributed sites
+    - flexible fine-grained consistency management of state
+    - policy driven state-ownership across replicas of the service 
+
 
 **Bug Fixes**
 
diff --git a/docs/setup.rst b/docs/setup.rst
index 208c779b..8406361f 100644
--- a/docs/setup.rst
+++ b/docs/setup.rst
@@ -6,7 +6,7 @@ Setup for Developing MUSIC
 
    Single-Site Install <single>
    Muili-Site Install <multi>
-   Authentication
+   Authentication <authentication>
 
 MUSIC is to be installed in a single Dir on a vm. 
 
@@ -47,4 +47,4 @@ Continue by selecting the link to the setup you are doing.
 
    Single-Site Install <single>
    Muili-Site Install <multi>
-   Authentication
+   Authentication <authentication>
diff --git a/docs/single.rst b/docs/single.rst
index 08c5e315..060f02b4 100644
--- a/docs/single.rst
+++ b/docs/single.rst
@@ -15,7 +15,7 @@ Instructions
 - Ensure you have OpenJDK 8 on your machine.
 - Download Apache Cassandra 3.0, install into /opt/app/music and follow these instructions http://cassandra.apache.org/doc/latest/getting_started/installing.html till and including Step
 - By the end of this you should have Cassandra working.
-- Download Apache Zookeeper 3.4.6, install into /opt/app/music and follow these instructions https://zookeeper.apache.org/doc/trunk/zookeeperStarted.html pertaining to the standalone operation. By the end of this you should have Zookeeper working.
+- Download Apache Zookeeper 3.4.6, install into /opt/app/music and follow these instructions https://zookeeper.apache.org/doc/r3.4.6/zookeeperStarted.html pertaining to the standalone operation. By the end of this you should have Zookeeper working.
 - Download the Version 8.5 Apache Tomcat and install it using these instructions https://tomcat.apache.org/download-80.cgi (this is for version 8.5).
 - Create a music.properties file and place it in /opt/app/music/etc/. Here is a sample of the file: