Skip to content

[DOCS-12837] Add monitor title/description guidelines#33663

Merged
evazorro merged 7 commits intomasterfrom
eva/DOCS-12837-monitor-guidelines
Apr 7, 2026
Merged

[DOCS-12837] Add monitor title/description guidelines#33663
evazorro merged 7 commits intomasterfrom
eva/DOCS-12837-monitor-guidelines

Conversation

@evazorro
Copy link
Copy Markdown
Contributor

@evazorro evazorro commented Jan 5, 2026

What does this PR do? What is the motivation?

Adds back guidelines for technology partners on creating monitor templates (wording guidance for the title and description; removed in #32291). It's useful content for partners, plus the Docs team refers to these guidelines when reviewing integration submissions.

Merge instructions

Merge readiness:

  • Ready for merge

@evazorro evazorro requested a review from a team as a code owner January 5, 2026 20:55
@evazorro evazorro added the WORK IN PROGRESS No review needed, it's a wip ;) label Jan 5, 2026
@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Jan 5, 2026

Preview links (active after the build_preview check completes)

Modified Files

@evazorro evazorro force-pushed the eva/DOCS-12837-monitor-guidelines branch from f709642 to ab27721 Compare February 25, 2026 21:45
@evazorro evazorro removed the WORK IN PROGRESS No review needed, it's a wip ;) label Apr 3, 2026
Copy link
Copy Markdown
Contributor

@rtrieu rtrieu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

hi eva, left some suggestions to tighten things up a bit and for consistency with the UI. here to chat through any of this!

@evazorro evazorro requested a review from rtrieu April 3, 2026 20:29
@evazorro evazorro requested a review from dd-dominic April 6, 2026 14:43
@evazorro
Copy link
Copy Markdown
Contributor Author

evazorro commented Apr 6, 2026

@dd-dominic adding you as a reviewer in case you have time this week to look at one last docs change 🥹

Copy link
Copy Markdown
Contributor

@dd-dominic dd-dominic left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A condensed version of this exists in Step 4 of "Add your monitor to your integration" - so we should remove or replace that with this new content.

#### Write a display name for your monitor template

The display name helps users understand the underlying failure mode the alert is covering.
- Use the active voice and start with the resource or metric, followed by a verb.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- Use the active voice and start with the resource or metric, followed by a verb.
- Use active voice and start with the resource or metric, followed by a verb.

@evazorro
Copy link
Copy Markdown
Contributor Author

evazorro commented Apr 6, 2026

A condensed version of this exists in Step 4 of "Add your monitor to your integration" - so we should remove or replace that with this new content.

@dd-dominic Argh, good call. I tried out adding the tables inline within that step: what are your thoughts? If it makes the section too long, maybe I give up on adding them back to the doc and just put them in internal review docs somewhere.

image

@dd-dominic
Copy link
Copy Markdown
Contributor

@evazorro I think that looks fine! It's a shorter page than our other docs, so not too much going on.

@evazorro evazorro force-pushed the eva/DOCS-12837-monitor-guidelines branch from 57711eb to 277a178 Compare April 6, 2026 17:41
@evazorro evazorro requested a review from dd-dominic April 6, 2026 17:44
@evazorro evazorro merged commit 8d092a3 into master Apr 7, 2026
21 checks passed
@evazorro evazorro deleted the eva/DOCS-12837-monitor-guidelines branch April 7, 2026 14:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants