3cc2c1509b
docs(alerting): fix annotation names for panel links in alerts ( #103471 )
2025-04-08 07:09:48 +02:00
64b65ffc72
docs(alerting): minor enhancements to intro concepts and example ( #102023 )
...
* docs(alerting): minor enhancements to intro concepts and example
* Update docs/sources/alerting/fundamentals/alert-rules/annotation-label.md
Co-authored-by: Johnny Kartheiser <140559259+JohnnyK-Grafana@users.noreply.github.com>
---------
Co-authored-by: Johnny Kartheiser <140559259+JohnnyK-Grafana@users.noreply.github.com>
2025-03-12 22:04:26 +01:00
8fe36e1c83
Alerting docs: clarify $labels and query labels ( #97350 )
...
* Alerting docs: clarify `$labels` and query labels
* fix mispell
2024-12-03 15:57:17 +01:00
facca37f4d
Alerting docs: Update Create alert rules from panels ( #95566 )
...
* Alerting docs: Update `Create alert rules from panels`
* Remove screenshots except when the panel displays alert status
* Further changes sync with Brenda
* minor changes
* Relocate admonition
* Specify `dashboardUId` and `panelId` must be set together
* Update docs/sources/alerting/alerting-rules/link-alert-rules-to-dashboards.md
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
* change title
* change URL
* fix spell error
---------
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
2024-11-05 10:00:59 +01:00
8a0c920106
Alerting docs: fix alertname label name ( #95665 )
2024-11-04 09:25:06 +01:00
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
8072286daf
Alerting docs: Update Labels and Annotations to detail use cases ( #95213 )
...
* Alerting docs: Update `Labels and Annotations` to detail use cases
* 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-10-23 08:50:56 +02:00
e7a9a9c161
Alerting docs: fixes alt text errors ( #91336 )
2024-08-05 09:18:36 +02:00
09d833fef9
Alerting docs: vale errors for labels and annotations ( #89957 )
...
* Alerting docs: vale errors for labels and annotations
* Update docs/sources/alerting/fundamentals/alert-rules/annotation-label.md
Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
* Update docs/sources/alerting/fundamentals/alert-rules/annotation-label.md
Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
---------
Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
2024-07-04 14:20:00 +02:00
5481399c53
Docs: landing page for OSS/Enterprise ( #89030 )
...
* Docs: landing page for OSS/Enterprise
* adds alt text for image in alerting
* Update docs/sources/_index.md
Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
* Update docs/sources/_index.md
Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
* Update docs/sources/_index.md
Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
* changes according to jacks feedback
* more fixes
* ran prettier
* adds upgrade tile
* adds better description
---------
Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
2024-06-11 14:36:14 +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
410e3b17e9
[docs/sources/alerting] Replace docs/reference shortcode with ref URIs ( #88079 )
2024-05-21 15:43:21 +03:00
7067e37971
alerting:labels-annotations elaboration ( #86663 )
...
* alerting:labels-annotations elaboration
* applied suggestions
* applied suggestions 2
* modified intro, and labels sections
* 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>
* 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>
* 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>
* pretty
---------
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
2024-04-23 15:07:29 +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
