813632dff1
Alerting Docs: Update Alert rule and Notification Templating ( #94069 )
...
* Update links to the new location of the Templates intro page
* Set alert rule template structure
* Update the `Template notifications` structure/sidebar
* Move examples to examples pages
* Update menu titles and URL paths
* WIP reference
* added intro to examples.md
* reference page section intros
* examples title
* Template
* Continue Alert Template Reference
* example sections
* Almost finish with Reference page
* weight pages
* WIP - template variables Intro
* Edits Alert rule templates + Differences with notification templates
* examples-draft-2
* how to map annotations to notif templates
* examples v2
* moved example
* Continue Template annotations and labels
* Preview annotation templates
* Complete `Template annotations and labels`
* Update `Differences with notification templates`
* Polish a bit `Differences with notification tempaltes`
* added logic examples to `Examples`
* Finish sharing Template language
* Minor: set `anchor` link
* Minor edit
* Minor edit
* Minor changes
* Template language changes
* Document missing functions for alert rule templates
* 'Examples' v3
* `Examples` v3.1
* `Examples` v3.2
* added context/intro to `Examples`
* added a how to section to `Examples`
* moved legacy info in `Examples`
* added examples, sections in `Examples`
* formatting
* examples v5
* examples v5.1
* Complete update to `Notification template reference`
* Update `$values` description
* moved steps to `index`
* fixed urls
* removed section in `examples`
* added refs
* fixed urls
* refs fix
* blended the use case into the explanation
* Notification template reference: Minor readibility changes
* Edit `$value` in Alert rule template reference
* Edit `Manage notification templates
* links to ref and lang pages
* Minor copy changes
* Edit Template annotation overview + Prepare Template notifications overview
* `Select` vs `Choose`
* Template Overview
* Fix `heading` does not match `title`
* examples v6
* examples v6.1
* Fix spell errors
* Run `prettier --write` to fix md format errors
* examples v7
* examples v7.1
* examples v7.2
* examples v7.4
* examples v7.5
* examples v7.6
* all pretty, no pity
* Update alert rule examples
* Complete `Labels and annotations template examples`
* Minor changes
* Use `.` notation instead of `index` in examples
* rename `extendeddata` to `notificationdata`
* Complete Notification examples
* minor changes
* Set `go` language when displaying template examples
* Revert "minor changes"
This reverts commit f647c55c8718a4b5c5ab51b3ef88ef0605de3c84.
* Update example and admonition for consistency
* Update docs/sources/alerting/alerting-rules/templates/_index.md
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
* Update docs/sources/alerting/alerting-rules/templates/_index.md
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
* Update docs/sources/alerting/alerting-rules/templates/_index.md
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
* Update docs/sources/alerting/alerting-rules/templates/_index.md
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
* Update docs/sources/alerting/configure-notifications/template-notifications/manage-notification-templates.md
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
* Update docs/sources/alerting/configure-notifications/template-notifications/manage-notification-templates.md
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
* Update docs/sources/shared/alerts/template-language.md
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
* Update docs/sources/shared/alerts/template-language.md
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
* Update docs/sources/alerting/configure-notifications/template-notifications/manage-notification-templates.md
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
* Update docs/sources/alerting/alerting-rules/templates/_index.md
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
* Update docs/sources/alerting/alerting-rules/templates/_index.md
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
* Update docs/sources/alerting/alerting-rules/templates/_index.md
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
* Update docs/sources/alerting/alerting-rules/templates/_index.md
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
* Update docs/sources/alerting/alerting-rules/templates/_index.md
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
* Update docs/sources/alerting/alerting-rules/templates/_index.md
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
* Update docs/sources/alerting/configure-notifications/template-notifications/_index.md
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
* Update docs/sources/alerting/alerting-rules/templates/_index.md
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
* Update docs/sources/alerting/alerting-rules/templates/_index.md
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
* Update docs/sources/alerting/alerting-rules/templates/_index.md
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
* Update docs/sources/alerting/alerting-rules/templates/_index.md
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
* Update docs/sources/alerting/alerting-rules/templates/_index.md
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
* Update docs/sources/alerting/alerting-rules/templates/_index.md
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
* Update docs/sources/alerting/alerting-rules/templates/language.md
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
* Update docs/sources/alerting/alerting-rules/templates/_index.md
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
* Update docs/sources/alerting/alerting-rules/templates/_index.md
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
* Update docs/sources/alerting/alerting-rules/templates/_index.md
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
* Update docs/sources/alerting/alerting-rules/templates/examples.md
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
* Update docs/sources/alerting/alerting-rules/templates/examples.md
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
* Update docs/sources/alerting/configure-notifications/template-notifications/examples.md
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
* Update docs/sources/alerting/alerting-rules/templates/examples.md
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
* Update docs/sources/alerting/configure-notifications/template-notifications/examples.md
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
* Update docs/sources/alerting/configure-notifications/template-notifications/manage-notification-templates.md
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
* Update docs/sources/alerting/configure-notifications/template-notifications/manage-notification-templates.md
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
* Update docs/sources/alerting/configure-notifications/template-notifications/manage-notification-templates.md
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
* Update docs/sources/alerting/configure-notifications/template-notifications/manage-notification-templates.md
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
* Update docs/sources/alerting/configure-notifications/template-notifications/manage-notification-templates.md
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
* use `add` instead of `enrich`
* fix prettier content errors
* minor copy change
* Specify which Alert properties are exclusive to Grafana-managed alerts
* Use `Monitor` instead of `Meta monitoring`
* Be more detailed about notifation template limitations
---------
Co-authored-by: tonypowa <tonypowa@gmail.com>
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
2024-10-23 12:43:28 +02:00
38ad0d3ebf
Alerting docs: relocate Intro>Notifications>Templates ( #94057 )
...
* Alerting docs: relocate `Intro>Notifications>Templates`
* Rename to `Templates`
2024-10-01 12:08:47 +02:00
405887eebf
Alerting Docs: Update the introduction to Templates ( #93935 )
...
* Intro/Templates: update Intro and Template annotations sections
* Template labels section + adjustements
* Template notifications
* Use diagram for `meta_image`
2024-09-30 11:31:18 +02:00
dc9dfb4c4b
Typo fix in Templates documentation ( #91348 )
...
fix typo
2024-08-05 16:54:48 +02:00
c168f2acec
Alerting docs: Update View alert groups ( #89461 )
...
* Alerting docs: Update `View alert groups`
Rename to `View the status of notifications` and extend on this topic
* Update docs/sources/alerting/manage-notifications/view-alert-groups.md
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
* Update docs/sources/alerting/manage-notifications/view-alert-groups.md
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
* Update docs/sources/alerting/manage-notifications/view-alert-groups.md
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
* Use `1` always for numbered list
* refer to `grouping settings of notification policies`
* Update `View notification errors` with latest instructions
---------
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
2024-07-01 11:35:12 +02:00
d0cf8956e2
Alerting docs: update Introduction page ( #89155 )
...
* Update Introduction page
* Update `How alerting works` image
* Update docs/sources/alerting/fundamentals/_index.md
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
* Update docs/sources/alerting/fundamentals/_index.md
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
* Fix `alt` attribute
* alert instance are sent `in` notifications
* Clarify `Notification policies`
* Clarify Notification Policy responsibilities
* Edit existing image captions
* change `configure a contact point` to `choose a contact point`
* Update image `caption/alt`
---------
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
2024-06-18 09:44:56 +02:00
0cc67bb93d
alerting: notes on label matchers ( #89269 )
...
* alerting: notes on label matchers
* routing clarification
* Update docs/sources/alerting/alerting-rules/templating-labels-annotations.md
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
* Update docs/sources/alerting/fundamentals/notifications/templates.md
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
---------
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
2024-06-18 09:22:23 +02:00
35fba3833b
Alerting docs: fix example ( #89132 )
...
* Fix matching label example
* Update some wording
* Update docs/sources/alerting/fundamentals/notifications/notification-policies.md
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
* Update docs/sources/alerting/fundamentals/notifications/group-alert-notifications.md
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
* Minor Timing options summary clarification
* Clarify `Disable grouping`
---------
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
2024-06-13 10:08:15 +02:00
57c9207a74
Alerting docs: Update Timing Options ( #89036 )
...
* first wip
* Complete changes
* Update docs/sources/alerting/fundamentals/notifications/group-alert-notifications.md
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
* Update docs/sources/alerting/fundamentals/notifications/group-alert-notifications.md
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
* Update docs/sources/alerting/fundamentals/notifications/group-alert-notifications.md
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
* Update docs/sources/alerting/fundamentals/notifications/group-alert-notifications.md
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
* Update docs/sources/alerting/fundamentals/notifications/group-alert-notifications.md
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
* Update docs/sources/alerting/fundamentals/notifications/group-alert-notifications.md
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
* Update docs/sources/alerting/fundamentals/notifications/group-alert-notifications.md
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
* Update docs/sources/alerting/fundamentals/notifications/group-alert-notifications.md
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
* Update docs/sources/alerting/fundamentals/notifications/group-alert-notifications.md
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
* Update docs/sources/alerting/fundamentals/notifications/group-alert-notifications.md
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
* Edit sentence refering the previous example
---------
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
2024-06-12 10:46:00 +02:00
ee75fc3852
Alerting docs: update Introduction > Notification policies ( #88656 )
...
* Alerting docs: Notification policies and grouping
* Update docs/sources/alerting/fundamentals/notifications/group-alert-notifications.md
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
* Update docs/sources/alerting/fundamentals/notifications/group-alert-notifications.md
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
* Update docs/sources/alerting/fundamentals/notifications/group-alert-notifications.md
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
* Update docs/sources/alerting/fundamentals/notifications/notification-policies.md
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
* Update docs/sources/alerting/fundamentals/notifications/notification-policies.md
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
* Change `alt` text in a diagram
* Clarify `siblings` and `child` policies
* Fix spelling error
* minor change
* Rewrite routing
* Update docs/sources/alerting/fundamentals/notifications/notification-policies.md
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
* Update docs/sources/alerting/fundamentals/notifications/notification-policies.md
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
* Rewrite Routing
* extend routing
* Minor `Group by` example
* Clarify how Grafana groups alerts by the alert rule
* Skip bold style for `group` options
---------
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
2024-06-10 12:06:46 +02:00
b6145fcb4c
Alerting docs: delete screensbots ( #88608 )
...
* Alerting docs: delete screensbots
* deletes screenshot 2
2024-06-03 13:42:58 +02:00
3e57576770
Alerting docs: Contact points updates ( #88582 )
...
* Update `Intro>Notifications>Contact points`
* Mention `OnCall` integration
2024-06-03 11:01:54 +02:00
68c44f1dd9
Alerting docs: Update Alertmanager docs ( #88567 )
...
* Remove alertmanager page and set redirects
* Update internal alertmanager links
* Update `Alertmanager` docs
* Change heading to `Configure Alertmanagers`
2024-06-03 11:00:52 +02:00
81af1d2208
Alerting docs: update Introduction > Notifications ( #88530 )
...
* Update Notifications intro page
* Update intro image
* Update docs/sources/alerting/fundamentals/notifications/_index.md
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
---------
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
2024-05-31 17:28:15 +02:00
3d7fc8c927
Alerting docs: Update Intro - alert rule labels and annotations ( #88230 )
...
* Update `Labels & Annotations`
* Complete labels and annotations
* Update docs/sources/alerting/fundamentals/alert-rules/annotation-label.md
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
* Update docs/sources/alerting/fundamentals/alert-rules/annotation-label.md
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
* Update docs/sources/alerting/fundamentals/alert-rules/annotation-label.md
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
---------
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
2024-05-24 10:09:35 +02:00
643018f94a
Alerting docs: Fix Alertmanager canonical setting ( #88236 )
2024-05-23 17:57:22 +02:00
410e3b17e9
[docs/sources/alerting] Replace docs/reference shortcode with ref URIs ( #88079 )
2024-05-21 15:43:21 +03:00
1ddbcc3f61
alerting/notifications: links ( #87122 )
...
* added links to each section
* ref fix
* ref fix2
* link fix
2024-04-30 16:34:18 +02:00
9203f84bc8
docs / alerting / fundamentals / templates ( #86983 )
...
* docs / alerting / fundamentals / templates
* renamed and adjusted front matter
* pretty
* frontmatter
* admonition fix
* admo
* restructuring
* Update docs/sources/alerting/fundamentals/notifications/templates.md
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
* Update docs/sources/alerting/fundamentals/notifications/templates.md
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
* Update docs/sources/alerting/fundamentals/notifications/templates.md
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
* Update docs/sources/alerting/fundamentals/notifications/templates.md
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
* Update docs/sources/alerting/fundamentals/notifications/templates.md
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
* amended admonition
---------
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
2024-04-30 12:06:25 +02:00
fd30ceed3e
Alerting docs: vale fixes ( #86972 )
...
* Alerting docs: vale fixes
* ran prettier
2024-04-26 12:17:06 +02:00
42778de2b4
alerting>intro>templates ( #86850 )
...
* alerting>intro>templates
* restored alias url
* numbering
* diagram
* Update docs/sources/alerting/fundamentals/notifications/message-templating.md
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
* formatting
* figure fix
* Brenda edits
* Brenda edit 2
* new diagram
* new diagram2
---------
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
2024-04-25 17:01:23 +02:00
856e410480
Alerting docs: Update Alert rules intro and Introduction pages ( #84772 )
...
undefined
2024-03-21 11:06:49 +01:00
ec42b2a361
Alerting docs: restructure Introduction ( #84248 )
...
* Rename `Data sources` title
* Relocate and rename `Introduction/Notification templates`
* Rename `alert-rules/alert-instances` to `alert-rules/multi-dimensional-alerts`
* Move `fundamentals/high-availability` to `setup/enable-ha`
* Fix 404 high-availability alerting link on Setup HA Grafana docs
* Move alert manager/contact poitns/notification templates within Notifications
* Remove `Alerting on numeric data`
* Restructure Introduction v2
* Continue Intro restructuring
* Update docs/sources/alerting/fundamentals/alert-rules/_index.md
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
* Complete contact point TODO
* Alias: alertManager
* Aliases `annotation-label` + content changes
* Aliases to `templating-labels-annotations`
* Aliases to `queries-conditions`
* Rename `rule-evaluation.md` file
* Aliases: `contact points`
* Aliases to `message-templating`
* Aliases to `alert-rules`
* Update links to new URL slugs
* Remove duplicated alias
* Remove trailing slash for external heading links
* Remove trailing slash in heading links to other grafana pages
* Change URL directory slug `fundamentals/notifications`
* rename title `Configure High Availability`
* Content changes
* Update docs/sources/alerting/fundamentals/alert-rules/_index.md
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
* Update docs/sources/alerting/set-up/configure-alert-state-history/index.md
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
* Update docs/sources/alerting/set-up/configure-high-availability/_index.md
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
* Update docs/sources/alerting/set-up/configure-alert-state-history/index.md
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
* Update docs/sources/alerting/set-up/configure-high-availability/_index.md
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
* Update docs/sources/alerting/set-up/configure-high-availability/_index.md
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
* Update docs/sources/alerting/set-up/configure-high-availability/_index.md
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
* Update docs/sources/alerting/fundamentals/alert-rules/_index.md
Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
* Fix broken link reference
* Fix `queries-and-conditions`
* Fix `alert-rule-evaluation` ref link
* Fix aliases + inline doc comments
* Fix broken link
---------
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
2024-03-14 16:58:18 +01:00
311e1e56f2
Docs: Reference Alertmanagers in Notifications docs and move Alertmanager docs ( #59673 )
2022-12-02 09:41:01 +00:00
8ed2426e8e
Docs: Improve documentation for notifications ( #59504 )
2022-12-01 09:57:45 +00:00
