Fixed
Details
Assignee
Marcel FuhrmannMarcel FuhrmannReporter
Bonnie RobinsonBonnie RobinsonHB Backlog Status
DBInternal Priority
High HighDoc Backlog Status
DBDoc Backlog Grooming Date
Sep 22, 2021Components
Priority
MinorEpic Name
Move content to reference section
Details
Details
Assignee
Marcel Fuhrmann
Marcel FuhrmannReporter
Bonnie Robinson
Bonnie RobinsonHB Backlog Status
DB
Internal Priority
High High
Doc Backlog Status
DB
Doc Backlog Grooming Date
Sep 22, 2021
Components
Priority
Epic Name
Move content to reference section
PagerDuty
PagerDuty
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
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.