DOC: Service Monitors - Not obvious that monitor section of service setup is required and can be missed during service setup

Description

In the documentation for the page sequence monitor service, the monitor section is documented with the service definition, however it can easily be overlooked by the massive amount of text on the screen, which is bad if this section is overlooked since the monitor section is required in order for the service to function properly.

Below is an example:

There isn't any obvious mention of this section being required by the service definition.

An example of a much briefer service definition with the same type of monitor definition:

The numbered bullet points in the above example are nice and could help bring out detail for some of the larger examples that don’t have any obvious context.  For instance, the page monitor service can be made up of many different components, but additional context/examples for each section would be helpful.  Numbering each section of a page sequence even if it's a kind of delineation between sections and/or hints on what to put where.

Adding a statement in the intro for services that the monitor section is a requirement and then reiterating this in each section of a service as a reminder of sorts, would be helpful to make sure this section isn’t missed in a service definition.

Acceptance / Success Criteria

None

Attachments

2

Activity

Show:

Bonnie Robinson February 17, 2023 at 4:56 PM

Closing issue, as all but one of the subtasks is complete. That subtask is in the Horizon backlog, as it requires developer input, and may not be a high priority.

Fixed

Details

Assignee

Reporter

Doc Backlog Status

Estimated Days

Story Points

Components

Sprint

Priority

PagerDuty

Created December 16, 2022 at 3:27 PM
Updated February 17, 2023 at 4:56 PM
Resolved February 17, 2023 at 4:56 PM