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

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.

Acceptance / Success Criteria

None
100% Done
Loading...

Lucidchart Diagrams

Activity

Marcel Fuhrmann January 25, 2024 at 8:44 PM

Closing because all sub issues are solved/closed.

Marcel Fuhrmann September 8, 2021 at 9:33 AM

Is this issue here and https://issues.opennms.org/browse/NMS-13243 more or less the same? So maybe a duplicate?

Marcel Fuhrmann September 8, 2021 at 9:31 AM

What about the provisioning policies? I would suggest moving them to the reference section, too.

Fixed

Details

Assignee

Reporter

HB Backlog Status

Internal Priority

High High

Doc Backlog Status

Doc Backlog Grooming Date

Components

Priority

Epic Name

PagerDuty

Created August 24, 2021 at 2:20 PM
Updated January 25, 2024 at 8:44 PM
Resolved January 25, 2024 at 8:44 PM