Improve Synthetics notifications page structure and clarity#34782
Improve Synthetics notifications page structure and clarity#34782git-thuerk-done merged 2 commits intomasterfrom
Conversation
Preview links (active after the
|
| | `hide_all` | Hides all additional content except for the custom message and event link. | | ||
| Datadog adds enriched content to notifications by default—test metadata, screenshots, failing step details, and notification handles. Use presets to control which content appears: | ||
|
|
||
| <table style="table-layout: fixed;"> |
There was a problem hiding this comment.
Curious why you converted the Markdown table to be HTML? We should prefer Markdown tables unless there is a good reason not to use them.
There was a problem hiding this comment.
It was word wrapping the "preset" column with Markdown for some reason
| ## Display custom notifications message | ||
|
|
||
| ### Notification presets |
There was a problem hiding this comment.
The old introductory paragraph for the "Display custom notifications" section was removed, so now this ## section jumps straight into the ### with no context. Consider either:
- Adding a one-line intro under "Display custom notifications message", or
- Promoting "Notification presets" to ## and removing the now-empty parent heading
There was a problem hiding this comment.
good catch, this was certainly a claude thing that I should have noticed it was minimizing too much information!
| </tr> | ||
| <tr> | ||
| <td style="width: 120px;"><code>hide_handles</code></td> | ||
| <td>All enriched data, but no <code>@notification</code> handles (for example, <code>@slack-channel</code>)</td> |
There was a problem hiding this comment.
Is this section saying that it will NOT show the @slack-channel channel? If yes, I'd recommend clarifying this in the example.
There was a problem hiding this comment.
For this table, let me know if this keeps the meaning:
| Preset | What it shows | Best for |
|---|---|---|
show_all (default) |
All enriched data, metadata, and handles | Email and ticketing channels where full context is useful |
hide_handles |
All enriched data, but no handles (for example, @slack-channel) |
Channels already notified at the monitor level to prevent duplicate alerts |
hide_all |
Custom message and event link only | Chat channels where you control the full message format |
There was a problem hiding this comment.
Yes I will make that more clear
iadjivon
left a comment
There was a problem hiding this comment.
Hi @git-thuerk-done , thanks for this PR! I've added some comments, let me know if you have any questions.
* Improve Synthetics notifications page structure and clarity * Update Synthetics notifications overview and preset descriptions
What does this PR do? What is the motivation?
[From Docs AI day]
Changes:
Merge instructions
Merge readiness:
Additional notes