Update Configuration app readTheDocs documentation 49/124749/3
authorsai-neetha <sai-neetha.phulmali@highstreet-technologies.com>
Fri, 8 Oct 2021 04:39:21 +0000 (06:39 +0200)
committerDan Timoney <dtimoney@att.com>
Tue, 19 Oct 2021 18:08:52 +0000 (18:08 +0000)
Update Configuration App readTheDocs documentation

Issue-ID: CCSDK-3295
Signed-off-by: sai-neetha <sai-neetha.phulmali@highstreet-technologies.com>
Change-Id: Id1022d983179cf10e5724309b50052de5e339b9b
Signed-off-by: sai-neetha <sai-neetha.phulmali@highstreet-technologies.com>
docs/guides/onap-user/pnfConfig.rst
sdnr/wt/helpserver/provider/src/main/resources/help/sdnr/pnfConfig/README.md

index 2baa58f..b2637e5 100644 (file)
@@ -5,16 +5,27 @@
 Configuration
 =============
 
-The application shows the actual values of all attributes of the
-ONF-TR-532 for a selected physical network function (PNF). Each view of
-a functional element is divided into capabilities, configuration,
-status, current problem, current performance and history performance
-information according to TR-532.
+The application rely on yang-specifications provided by the device. It
+is Generic and generated user interface, generated by yang specs and
+capabilites of a device. Each view of a functional element is divided
+into capabilities, configuration, status, current problem, current
+performance and history performance information according to TR-532.
 
 A separate window is available for modifying the configuration. All
 changes made are sent to the device in a single NetConf bulk request.
 The operator is notified about successfully configuring the device.
 
+Features
+--------
+
+Read yang specifications and generate related User interface out of it
+
+-  Provide yang description as tool tip for fields
+
+-  Consider specified type for input fields
+
+-  Provide read and write access
+
 Implementation
 --------------
 
index 3cdab3b..62bf907 100644 (file)
@@ -1,9 +1,19 @@
 # Configuration
 
-The application shows the actual values of all attributes of the ONF-TR-532 for a selected physical network function (PNF). Each view of a functional element is divided into capabilities, configuration, status, current problem, current performance and history performance information according to TR-532.
+The application rely on yang-specifications provided by the device. It is Generic and generated user interface, generated by yang specs and capabilites of a device. Each view of a functional element is divided into capabilities, configuration, status, current problem, current performance and history performance information according to TR-532.
 
 A separate window is available for modifying the configuration. All changes made are sent to the device in a single NetConf bulk request. The operator is notified about successfully configuring the device.
 
+### Features
+
+Read yang specifications and generate related User interface out of it
+
+  - Provide yang description as tool tip for fields
+
+  - Consider specified type for input fields
+  
+  - Provide read and write access
+
 ## Implementation
 
 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.