update odlux documentation

update readthedocs to include new functionality / improve wording

fix missing help link for configurationApp

Issue-ID: SDNC-1093
Signed-off-by: Aijana Schumann <aijana.schumann@highstreet-technologies.com>
Change-Id: Ice8c93f55e076aeefb971c9febc6ec82785969f5

diff --git a/docs/guides/onap-user/connect.rst b/docs/guides/onap-user/connect.rst
index 6da7469..c93c1f9 100644 (file)
--- a/docs/guides/onap-user/connect.rst
+++ b/docs/guides/onap-user/connect.rst
@@ -9,9 +9,10 @@ The 'Connect' application on OpenDaylight provides up-to-date
 connectivity information about the wireless devices in the network. It
 automatically displays new Network Elements and their connection status.
 Usually, the Network Elements mount themselves. If necessary, they can
-be mounted manually by right-clicking on the element. For better
-understanding of alarms and status, a connection status log lists all
-the connection status changes of OpenDaylight mount points.
+be mounted manually by right-clicking on the element and selecting the
+'mount' action. For better understanding of alarms and status, a
+connection status log lists all the connection status changes of
+OpenDaylight mount points.
 
 Views
 -----
@@ -40,5 +41,5 @@ display information relevant to the selected element.
 Connection Status Log
 ~~~~~~~~~~~~~~~~~~~~~
 
-The log lists the connections status changes between SDN Controller and
+The log lists the connection status changes between SDN Controller and
 NetConf servers (devices).

diff --git a/docs/guides/onap-user/pnfConfig.rst b/docs/guides/onap-user/pnfConfig.rst
index 29e2296..2baa58f 100644 (file)
--- a/docs/guides/onap-user/pnfConfig.rst
+++ b/docs/guides/onap-user/pnfConfig.rst
@@ -18,9 +18,9 @@ The operator is notified about successfully configuring the device.
 Implementation
 --------------
 
-The application is implemented as OpenDaylight-DLUX web application
-using the RestConf northbound interface of the SDN controller. The key
-frameworks are: Typescript, React and material-ui.
+The application is implemented as ODLUX web application using the
+RestConf northbound interface of the SDN controller. The key frameworks
+are: Typescript, React and material-ui.
 
 Connection status information is updated automatically using a web
 socket for notifications from OpenDaylight to the browser.

diff --git a/docs/guides/onap-user/pnfFault.rst b/docs/guides/onap-user/pnfFault.rst
index 5e54547..4e3c9f5 100644 (file)
--- a/docs/guides/onap-user/pnfFault.rst
+++ b/docs/guides/onap-user/pnfFault.rst
@@ -15,8 +15,8 @@ Views
 
 The graphical user interface is separated into three views.
 
-Current Alarms
-~~~~~~~~~~~~~~
+Current Problem List
+~~~~~~~~~~~~~~~~~~~~
 
 Lists all current active faults in the network. In addition, it also
 lists alarms sent by the SDN controller itself, which detects connection
@@ -53,6 +53,6 @@ are stored. There is no logic implemented on the client side.
 An alarm status bar in the header of the web application informs the
 operator about the health status of the network.
 
-The OpenDaylight-DLUX web application uses web sockets to update the
-graphical user interface of the Problem Notifications (devices) and
-Connection Status Notifications (ODL) in real-time.
+The ODLUX web application uses web sockets to update the graphical user
+interface of the Alarm Notifications (devices) and Connection Status
+Notifications in real-time.

diff --git a/docs/guides/onap-user/pnfPerformance.rst b/docs/guides/onap-user/pnfPerformance.rst
index 2f37ac7..17e4a51 100644 (file)
--- a/docs/guides/onap-user/pnfPerformance.rst
+++ b/docs/guides/onap-user/pnfPerformance.rst
@@ -16,6 +16,11 @@ Performance history values
 
 After selecting a connected PNF supporting ONF-TR-532 and a physical
 interface, the application collects the received and centralized stored
-performance values for this interface. The data gets displayed as a line
-chart to visualize the data in a given time period and a corresponding
-table. If the table gets filtered, the chart updates itself.
+performance values for this interface.
+
+The values are visualized using two views: a line chart and a table,
+with the chart always shown first. To switch between them, toggle
+buttons can be used. The chart view offers a filter to quickly limit the
+shown values. To keep both views in sync, the filters of the chart and
+the table are connected. If one view is filtered, the other one gets
+updated in the background.

diff --git a/sdnr/wt/helpserver/provider/src/main/resources/help/meta.json b/sdnr/wt/helpserver/provider/src/main/resources/help/meta.json
index 53dbbfb..29a6787 100644 (file)
--- a/sdnr/wt/helpserver/provider/src/main/resources/help/meta.json
+++ b/sdnr/wt/helpserver/provider/src/main/resources/help/meta.json
@@ -46,7 +46,7 @@
                 },
                 "label": "Maintenance"
             },
-            "configApp": {
+            "configurationApp": {
                 "versions": {
                     "0.4.0": {
                         "date": "2018-02-24",
@@ -105,6 +105,21 @@
                     }
                 },
                 "label": "Mediator"
+            },
+            "eventLogApp": {
+                "versions": {
+                    "0.4.0": {
+                        "date": "2020-02-03",
+                        "path": "sdnr/pnfEventLog/README.md",
+                        "label": "EventLog"
+                    },
+                    "current": {
+                        "date": "2020-02-03",
+                        "path": "sdnr/pnfEventLog/README.md",
+                        "label": "EventLog"
+                    }
+                },
+                "label": "EventLog"
             }
         },
         "versions": {
@@ -197,5 +212,20 @@
             }
         },
         "label": "Abbreviations"
+    },
+    "general": {
+        "versions": {
+            "0.4.0": {
+                "date": "2018-02-24",
+                "path": "sdnr/general.md",
+                "label": "General Functionality"
+            },
+            "current": {
+                "date": "2018-02-24",
+                "path": "sdnr/general.md",
+                "label": "General Functionality"
+            }
+        },
+        "label": "General Functionality"
     }
 }
\ No newline at end of file

diff --git a/sdnr/wt/helpserver/provider/src/main/resources/help/sdnr/connect/README.md b/sdnr/wt/helpserver/provider/src/main/resources/help/sdnr/connect/README.md
index 663aed5..e15be5e 100644 (file)
--- a/sdnr/wt/helpserver/provider/src/main/resources/help/sdnr/connect/README.md
+++ b/sdnr/wt/helpserver/provider/src/main/resources/help/sdnr/connect/README.md
@@ -1,6 +1,6 @@
 # Connect
 
-The 'Connect' application on OpenDaylight provides up-to-date connectivity information about the wireless devices in the network. It automatically displays new Network Elements and their connection status. Usually, the Network Elements mount themselves. If necessary, they can be mounted manually by right-clicking on the element. For better understanding of alarms and status, a connection status log lists all the connection status changes of OpenDaylight mount points.
+The 'Connect' application on OpenDaylight provides up-to-date connectivity information about the wireless devices in the network. It automatically displays new Network Elements and their connection status. Usually, the Network Elements mount themselves. If necessary, they can be mounted manually by right-clicking on the element and selecting the 'mount' action. For better understanding of alarms and status, a connection status log lists all the connection status changes of OpenDaylight mount points.
 
 ## Views
 
@@ -17,4 +17,4 @@ By right-clicking on an element, an action menu opens. The menu allows to mount,
 
 ### Connection Status Log
 
-The log lists the connections status changes between SDN Controller and NetConf servers (devices).
+The log lists the connection status changes between SDN Controller and NetConf servers (devices).

diff --git a/sdnr/wt/helpserver/provider/src/main/resources/help/sdnr/pnfConfig/README.md b/sdnr/wt/helpserver/provider/src/main/resources/help/sdnr/pnfConfig/README.md
index 7bc27d1..3cdab3b 100644 (file)
--- a/sdnr/wt/helpserver/provider/src/main/resources/help/sdnr/pnfConfig/README.md
+++ b/sdnr/wt/helpserver/provider/src/main/resources/help/sdnr/pnfConfig/README.md
@@ -6,7 +6,7 @@ A separate window is available for modifying the configuration. All changes made
 
 ## Implementation
 
-The application is implemented as OpenDaylight-DLUX web application using the RestConf northbound interface of the SDN controller. The key frameworks are: Typescript, React and material-ui.
+The application is implemented as ODLUX web application using the RestConf northbound interface of the SDN controller. The key frameworks are: Typescript, React and material-ui.
 
 Connection status information is updated automatically using a web socket for notifications from OpenDaylight to the browser.
 

diff --git a/sdnr/wt/helpserver/provider/src/main/resources/help/sdnr/pnfFault/README.md b/sdnr/wt/helpserver/provider/src/main/resources/help/sdnr/pnfFault/README.md
index 2d9d35a..cfac06d 100644 (file)
--- a/sdnr/wt/helpserver/provider/src/main/resources/help/sdnr/pnfFault/README.md
+++ b/sdnr/wt/helpserver/provider/src/main/resources/help/sdnr/pnfFault/README.md
@@ -6,7 +6,7 @@ To operate a network, it is important to get an overview about the currently rai
 
 The graphical user interface is separated into three views.
 
-### Current Alarms
+### Current Problem List
 
 Lists all current active faults in the network. In addition, it also lists alarms sent by the SDN controller itself, which detects connection losses to the NetConf server (connectionLossOAM) or to a device via a mediator to a device (connectionLossNeOAM).
 
@@ -26,6 +26,6 @@ The server synchronizes with the current alarm lists of the devices. Based on ra
 
 An alarm status bar in the header of the web application informs the operator about the health status of the network.
 
-The OpenDaylight-DLUX web application uses web sockets to update the graphical user interface of the Problem Notifications (devices) and Connection Status Notifications (ODL) in real-time.
+The ODLUX web application uses web sockets to update the graphical user interface of the Alarm Notifications (devices) and Connection Status Notifications in real-time.
 
 

diff --git a/sdnr/wt/helpserver/provider/src/main/resources/help/sdnr/pnfPerformance/README.md b/sdnr/wt/helpserver/provider/src/main/resources/help/sdnr/pnfPerformance/README.md
index ec9f8d5..c217b5c 100644 (file)
--- a/sdnr/wt/helpserver/provider/src/main/resources/help/sdnr/pnfPerformance/README.md
+++ b/sdnr/wt/helpserver/provider/src/main/resources/help/sdnr/pnfPerformance/README.md
@@ -4,6 +4,11 @@ Performance Monitoring values measured by the devices are necessary to analyze a
 
 ## Performance history values
 
-After selecting a connected PNF supporting ONF-TR-532 and a physical interface, the application collects the received and centralized stored performance values for this interface. The data gets displayed as a line chart to visualize the data in a given time period and a corresponding table. If the table gets filtered, the chart updates itself.
+After selecting a connected PNF supporting ONF-TR-532 and a physical interface, the application collects the received and centralized stored performance values for this interface.
+
+The values are visualized using two views: a line chart and a table, with the chart always shown first. To switch between them, toggle buttons can be used. The chart view offers a filter to quickly limit the shown values. To keep both views in sync, the filters of the chart and the table are connected. If one view is filtered, the other one gets updated in the background.
+
+
+