Skip to content
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

Open
wants to merge 9 commits into
base: develop
Choose a base branch
from

Conversation

homelessbirds
Copy link
Contributor

I had to create a new PR to replace 17342 because there were too many changes to that section/merge conflicts.

@homelessbirds homelessbirds self-assigned this Jun 28, 2024
Copy link

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).

@github-actions github-actions bot added this to Hero to triage in Docs PRs and Issues Jun 28, 2024
Copy link

netlify bot commented Jun 28, 2024

Deploy Preview for docs-website-netlify ready!

Name Link
🔨 Latest commit e929f0a
🔍 Latest deploy log https://app.netlify.com/sites/docs-website-netlify/deploys/668420ac8e8a490008604ac5
😎 Deploy Preview https://deploy-preview-17823--docs-website-netlify.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@homelessbirds homelessbirds added content requests related to docs site content from_tw Identifies issues/PRs from Tech Docs writers labels Jun 28, 2024
@homelessbirds homelessbirds moved this from Hero to triage to In progress in Docs PRs and Issues Jun 28, 2024
- 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/
Copy link
Contributor

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.
Copy link
Contributor

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....

Copy link
Contributor

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 :)

Copy link
Contributor Author

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!

@homelessbirds homelessbirds changed the title feat(alerts): created a new doc for the title template feat(alerts): title templates Jul 3, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content requests related to docs site content from_tw Identifies issues/PRs from Tech Docs writers
Projects
Development

Successfully merging this pull request may close these issues.

None yet

2 participants