Provides SDN-R related help information.
Help App provides an application and a status element in the title bar.
- All available ux applications need to provide a help content page.
- The status bar help button uses a specific path, containing the appId as reference to the app related Help context.
- The helpserver bundle provides the web service for ux help
Implementation
A json file describes the dependency between specific app and related help content.
The path sdnr/nodes/appId identifies the app.
Path example for "Fault App" with Id: "faultApp": sdnr/nodes/faultApp
Example of meta.json that is part of helpserver
{
"sdnr": {
"nodes": {
"connect": {
"versions": {
"0.4.0": {
"date": "2018-02-24",
"path": "sdnr/connect/README.md",
"label": "Connect"
},
"current": {
"date": "2018-02-24",
"path": "sdnr/connect/README.md",
"label": "Connect"
}
},
"label": "Connect"
},
"pnfFault": {
"versions": {
"0.4.0": {
"date": "2018-02-24",
"path": "sdnr/pnfFault/README.md",
"label": "Fault"
},
"current": {
"date": "2018-02-24",
"path": "sdnr/pnfFault/README.md",
"label": "Fault"
}
},
"label": "Fault"
},