HelpServer

Owned by Herbert Eiselt
Last updated: Jun 12, 2019
1 min read

Provides pages for web clients. See UX Help.

Help content is additonally used by ReadTheDocs help text generation.

Implementation

Reference ux help - helpserver

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 beginning 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"
    },

    :