Uploaded image for project: 'OpenNMS'
  1. OpenNMS
  2. NMS-13522

Streamline documentation to move most reference material to the reference section.

    XMLWordPrintable

    Details

    • Type: Epic
    • Status: Open (View Workflow)
    • Priority: Minor
    • Resolution: Unresolved
    • Affects Version/s: None
    • Fix Version/s: None
    • Component/s: Documentation
    • Security Level: Default (Default Security Scheme)
    • Labels:
      None
    • Epic Name:
      Move content to reference section
    • HB Backlog Status:
      DB
    • Internal Priority:
      High High
    • Doc Backlog Status:
      DB

      Description

      In an effort to streamline and restructure the documentation, a lot of the tabular lists of information would be more appropriate in the reference section. The "Operation" section could be more of a "cookbook" in the following structure:

      Topic title
      Brief overview (what it is, why it's important)
      User-focussed example/recipe (e.g., How to monitor databases)
      Sample
      Link to the reference section where the full list of parameters is available.

      Note: The corresponding reference section should have the same title, for ease of organization and better user experience. For example, the "Streaming Telemetry" section of the Operation docs would have a corresponding "Streaming Telemetry" section in the Reference docs.

      Where applicable, we could eventually do a "simple, intermediate, complex" example/recipe for each topic.

        Attachments

          Issue Links

            Activity

              People

              Assignee:
              fuhrmann Marcel Fuhrmann
              Reporter:
              Bonnie Bonnie Robinson
              Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

                Dates

                Created:
                Updated:
                Doc Backlog Grooming Date:

                  Git Integration