From: sai-neetha Date: Fri, 8 Oct 2021 04:39:21 +0000 (+0200) Subject: Update Configuration app readTheDocs documentation X-Git-Tag: 1.3.0~28 X-Git-Url: https://gerrit.onap.org/r/gitweb?a=commitdiff_plain;h=refs%2Fchanges%2F49%2F124749%2F3;p=ccsdk%2Ffeatures.git Update Configuration app readTheDocs documentation Update Configuration App readTheDocs documentation Issue-ID: CCSDK-3295 Signed-off-by: sai-neetha Change-Id: Id1022d983179cf10e5724309b50052de5e339b9b Signed-off-by: sai-neetha --- diff --git a/docs/guides/onap-user/pnfConfig.rst b/docs/guides/onap-user/pnfConfig.rst index 2baa58f85..b2637e56a 100644 --- a/docs/guides/onap-user/pnfConfig.rst +++ b/docs/guides/onap-user/pnfConfig.rst @@ -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 -------------- 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 3cdab3b3d..62bf90736 100644 --- 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 @@ -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.