[DOCS-12837] Add monitor title/description guidelines#33663
Conversation
Preview links (active after the
|
f709642 to
ab27721
Compare
content/en/extend/integrations/create-an-integration-monitor-template.md
Outdated
Show resolved
Hide resolved
content/en/extend/integrations/create-an-integration-monitor-template.md
Outdated
Show resolved
Hide resolved
content/en/extend/integrations/create-an-integration-monitor-template.md
Outdated
Show resolved
Hide resolved
content/en/extend/integrations/create-an-integration-monitor-template.md
Outdated
Show resolved
Hide resolved
content/en/extend/integrations/create-an-integration-monitor-template.md
Outdated
Show resolved
Hide resolved
content/en/extend/integrations/create-an-integration-monitor-template.md
Outdated
Show resolved
Hide resolved
content/en/extend/integrations/create-an-integration-monitor-template.md
Outdated
Show resolved
Hide resolved
content/en/extend/integrations/create-an-integration-monitor-template.md
Outdated
Show resolved
Hide resolved
|
@dd-dominic adding you as a reviewer in case you have time this week to look at one last docs change 🥹 |
dd-dominic
left a comment
There was a problem hiding this comment.
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. |
There was a problem hiding this comment.
| - 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. |
@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.
|
|
@evazorro I think that looks fine! It's a shorter page than our other docs, so not too much going on. |
57711eb to
277a178
Compare

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: