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
--- a/docs/guides/onap-user/connect.rst
+++ b/docs/guides/onap-user/connect.rst
@@ -9,9 +9,10 @@
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 @@
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
--- a/docs/guides/onap-user/pnfConfig.rst
+++ b/docs/guides/onap-user/pnfConfig.rst
@@ -18,9 +18,9 @@
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
--- a/docs/guides/onap-user/pnfFault.rst
+++ b/docs/guides/onap-user/pnfFault.rst
@@ -15,8 +15,8 @@
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 @@
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
--- a/docs/guides/onap-user/pnfPerformance.rst
+++ b/docs/guides/onap-user/pnfPerformance.rst
@@ -16,6 +16,11 @@
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.