-
Notifications
You must be signed in to change notification settings - Fork 1.2k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
feat(alerts): title templates #17823
base: develop
Are you sure you want to change the base?
Conversation
Hi @homelessbirds 👋 Thanks for your pull request! Your PR is in a queue, and a writer will take a look soon. We generally publish small edits within one business day, and larger edits within three days. We will automatically generate a preview of your request, and will comment with a link when the preview is ready (usually 10 to 20 minutes). |
✅ Deploy Preview for docs-website-netlify ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
- title: Custom incident descriptions | ||
path: /docs/alerts/create-alert/condition-details/alert-custom-incident-descriptions | ||
- title: Description template for alert conditions | ||
path: /docs/alerts/create-alert/condition-details/alert-custom-incident-descriptions/ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
it's not appearing in the left nav, so might need to remove trailing backslash
|
||
## Why use a title template? [#why-titles] | ||
|
||
An alert condition is the foundation for incident creation. Whether you're using our guided mode or crafting a condition from a chart or policy, using a unique title template is the final step to creating an alert condition. While this is optional, we recommend it. An alert condition defines a set of thresholds you want to monitor. If any of those thresholds are breached, an incident is created. Meaningful title templates help you pinpoint issues and resolve outages faster. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
To break up this content, all of which is extremely helpful + good to know, I might add bullet points here, maybe something like...
While this is optional, we recommend it:
- An alert condition defines...
- If any of those thresholds are breached...
*Meaningful title....
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
actually you use bullets a bit in this doc. maybe just a paragraph break? i think this is just for a skimmability fix :)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I edited it to make it easier to skim! good callout!
I had to create a new PR to replace 17342 because there were too many changes to that section/merge conflicts.