Commit Graph

47 Commits

Author SHA1 Message Date
Pepe Cano 5c1b263664
docs(alerting): simplify Intro to Grafana Alerting docs (#106944)
* docs(alerting): improve `Intro > Alert rule evaluation` docs

* Update Introduction to Grafana Alerting

* Simplify `Intro > Alert rules` and related docs

* minor copy change phrasing GMA and DS differences

* fix vale error
2025-06-26 12:25:32 +00:00
Pepe Cano 21fe9480a1
docs(alerting): Configure Grafana IRM (#103549)
* docs(alerting): Configure Grafana IRM

* update `PagerDuty`
2025-04-07 18:51:49 +02:00
Pepe Cano 2b4e1f3c51
Alerting docs: clarify that `silences` and `mute timings` do not interrupt alert evaluation (#100414)
* Alerting docs: clarify that `silences` and `mute timings` do not interrupt alert evaluation

* replace `ad-hoc` word
2025-02-12 11:12:40 +01:00
Pepe Cano ff2f612412
Alerting docs: Introduction - brief overview of notification messages. (#95987)
* Intro: simplify `Architecture`. Add a new guideline

* Define `Notification policies` as an advanced option

* Intro: include about "Notification messages"

* Minor copy changes
2024-11-07 16:35:27 +01:00
antonio 0df5a6aefc
alerting: docs / highlight tutorial in landing page (#92805) 2024-09-02 16:40:16 +02:00
Pepe Cano 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
Pepe Cano 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
Jack Baldry 410e3b17e9
[docs/sources/alerting] Replace docs/reference shortcode with ref URIs (#88079) 2024-05-21 15:43:21 +03:00
antonio f24eb3165b
alerting: adding links to get-started tutorial (#87811)
* alerting: adding links to get-started tutorial

* Update index.md

* Update create-grafana-managed-rule.md

* Update _index.md

* Update _index.md

* Update docs/sources/alerting/alerting-rules/create-grafana-managed-rule.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>

* pretty

---------

Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
2024-05-15 08:57:12 +02:00
Pepe Cano 7dd05998fd
Alerting docs: Update and restructure `Introduction/Alert rule evaluation` (#87331)
* Migrate and update `Alert rule evaluation`

* Minor change

* Update internal links to new URLs
2024-05-06 17:33:14 +02:00
brendamuir fd30ceed3e
Alerting docs: vale fixes (#86972)
* Alerting docs: vale fixes

* ran prettier
2024-04-26 12:17:06 +02:00
Pepe Cano 856e410480
Alerting docs: Update `Alert rules` intro and `Introduction` pages (#84772)
undefined
2024-03-21 11:06:49 +01:00
Pepe Cano 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
brendamuir 5950dc3279
Alerting docs: adds top-level landing page tiles (#83825)
* Alerting docs: adds top-level landing page tiles

* updated description

* update frontmatter

* ran prettier

* Update docs/sources/alerting/_index.md

Co-authored-by: Jack Baldry <jack.baldry@grafana.com>

* Update docs/sources/alerting/_index.md

Co-authored-by: Jack Baldry <jack.baldry@grafana.com>

* Update docs/sources/alerting/_index.md

Co-authored-by: Jack Baldry <jack.baldry@grafana.com>

* Update docs/sources/alerting/_index.md

Co-authored-by: Jack Baldry <jack.baldry@grafana.com>

* Update docs/sources/alerting/_index.md

Co-authored-by: Jack Baldry <jack.baldry@grafana.com>

* Update docs/sources/alerting/_index.md

Co-authored-by: Jack Baldry <jack.baldry@grafana.com>

* Update docs/sources/alerting/_index.md

Co-authored-by: Jack Baldry <jack.baldry@grafana.com>

---------

Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
2024-03-06 12:24:02 +01:00
brendamuir 3901077f39
Alerting docs: changes weights and titles (#83519)
* Alerting docs: changes weights and titles

* language improvements to intro topic

* corrects rulle spelling

* adds alert instance info

* updates admonition note
2024-02-28 10:10:19 +02:00
Pepe Cano 5b918f555c
Alerting docs: correct `notification-policies` link (#83099) 2024-02-20 13:50:31 +01:00
Pepe Cano 3909b4c14a
Alerting docs: update `<GRAFANA VERSION>` to `<GRAFANA_VERSION>` (#82324) 2024-02-13 09:21:50 +00:00
brendamuir 4d375aa5d4
Alerting docs: Adds Alerting descriptions for fundamentals section (#79383)
Adds Alerting descriptions for fundamentals section
2023-12-12 11:26:36 +01:00
George Robinson ba384d29f6
Alerting: Fix order of the Alerting docs (#77084) 2023-10-24 19:31:03 +01:00
George Robinson 272a901e5e
Alerting: Improve order of docs pages (#76998) 2023-10-24 10:50:19 +01:00
George Robinson 32f48ee64a
Alerting: Fix link in docs (#76982) 2023-10-23 16:53:31 -05:00
George Robinson e94e283cc6
Alerting: Improve Introduction to Alerting docs (#76591) 2023-10-23 13:03:20 +03:00
Jack Baldry 37ef4e940f
Add canonical URLs to all alerting pages (#71830)
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
2023-07-18 11:29:00 +01:00
Jack Baldry 7eb17bccca
Explicitly set all front matter labels in the source files (#71548)
* Set every page to have defaults of 'Enterprise' and 'Open source' labels

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Set administration pages to have of 'Cloud', 'Enterprise', and 'Open source' labels

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Set administration/enterprise-licensing pages to have 'Enterprise' labels

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Set administration/organization-management pages to have 'Enterprise' and 'Open source' labels

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Set administration/provisioning pages to have 'Enterprise' and 'Open source' labels

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Set administration/recorded-queries pages to have labels cloud,enterprise

* Set administration/roles-and-permissions/access-control pages to have labels cloud,enterprise

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Set administration/stats-and-license pages to have labels cloud,enterprise

* Set alerting pages to have labels cloud,enterprise,oss

* Set breaking-changes pages to have labels cloud,enterprise,oss

* Set dashboards pages to have labels cloud,enterprise,oss

* Set datasources pages to have labels cloud,enterprise,oss

* Set explore pages to have labels cloud,enterprise,oss

* Set fundamentals pages to have labels cloud,enterprise,oss

* Set introduction/grafana-cloud pages to have labels cloud

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Fix introduction pages products

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Set panels-visualizations pages to have labels cloud,enterprise,oss

* Set release-notes pages to have labels cloud,enterprise,oss

* Set search pages to have labels cloud,enterprise,oss

* Set setup-grafana/configure-security/audit-grafana pages to have labels cloud,enterprise

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Set setup-grafana/configure-security/configure-authentication pages to have labels cloud,enterprise,oss

* Set setup-grafana/configure-security/configure-authentication/enhanced-ldap pages to have labels cloud,enterprise

* Set setup-grafana/configure-security/configure-authentication/saml pages to have labels cloud,enterprise

* Set setup-grafana/configure-security/configure-database-encryption/encrypt-secrets-using-hashicorp-key-vault pages to have labels cloud,enterprise

* Set setup-grafana/configure-security/configure-request-security pages to have labels cloud,enterprise,oss

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Set setup-grafana/configure-security/configure-team-sync pages to have labels cloud,enterprise

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Set setup-grafana/configure-security/export-logs pages to have labels cloud,enterprise

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Set troubleshooting pages to have labels cloud,enterprise,oss

* Set whatsnew pages to have labels cloud,enterprise,oss

* Apply updated labels from review

Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com>

---------

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com>
2023-07-18 09:10:12 +01:00
Jack Baldry 01f6b8e90c
Use docs/reference style links for all Alerting links (#71124)
* Replace all alerting links with docs/reference style links

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Fix broken docs/reference style link

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Update all alerting links to go to Grafana Cloud resources when the page is published in Grafana Cloud

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Prettier

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Replace another link

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

---------

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
2023-07-10 11:51:29 +01:00
brendamuir d8ffc6be5e
Docs: fixes minor errors (#70458)
* Docs: fixes minor errors

* adds links

* remove trailing slash

---------

Co-authored-by: Chris Moyer <chris.moyer@grafana.com>
2023-06-21 11:53:24 -05:00
brendamuir cd8e5dc140
Docs: rearrange content order (#70425)
* Docs: rearrange content order

* more rearranging

* fixes relrefs

* fixes links
2023-06-21 11:30:52 +02:00
Gilles De Mey b10daa12b3
Docs: Add separate fundamentals topic on notification policies (#69174)
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
2023-05-31 15:19:33 +03:00
Jack Baldry 6c4cf4f8b9
Enable doc-validator for alerting directories (#68964)
* Enable doc-validator for alerting directories

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Adds missing description frontmatter

* Fix some more links

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Fix some more links

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Fixes anchors

---------

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
2023-05-24 14:12:30 +01:00
brendamuir c742503d2c
Docs: Updates intro alerting topics (#66958)
* Updates intro alerting topics

* taking out cortex

* Adds choice table for alert rules type

* updates with Vikas feedback
2023-04-21 13:24:43 +02:00
brendamuir e243db6e6b
Docs: fixes intro title (#65174)
fixes intro title
2023-03-22 12:53:40 +01:00
brendamuir 89c65e22d3
Docs: fix numbering and rename topic (#65093)
* Docs: fix numbering and rename topic

* fixes typo

* removes full stops

* deletes :
2023-03-21 13:37:00 +01:00
Jack Baldry c1c48dd610
Use relative aliases for all non-current Grafana aliases (#60062)
* Use relative aliases for all non-current Grafana aliases

Prevents non-latest documentation "stealing" the page away from latest
and through permanent redirects for latest pages that no longer exist.

The redirected pages are indexed by search engines but our robots.txt
forbids them crawling the non-latest page.

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Remove aliases from shared pages

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Rewrite all current latest aliases to be next

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Fix typo in latest alias

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Remove all current page aliases

find docs/sources -type f -name '*.md' -exec sed -z -i 's#\n *- /docs/grafana/next/[^\n]*\n#\n#' {} \;
find docs/sources -type f -name '*.md' -exec sed -Ez -i 's#\n((aliases:\n *-)|aliases:\n)#\n\2#' {} \;

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Prettier

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
2022-12-09 12:36:04 -04:00
brendamuir bd6ac793a0
Docs: adds explore content for alerting (#58573) 2022-11-10 12:35:24 +00:00
brendamuir 1d53a6f57e
Docs: Change GA to Alerting (#57811)
* Docs: Change GA to Alerting

* typos
2022-10-28 10:28:02 +01:00
brendamuir 5edd511461
Docs: fixes alerting links (#57805)
* Docs: fixes alerting links

* fixes grafana relrefs to alerting

* changing GA to Alerting
2022-10-28 10:01:43 +01:00
brendamuir ebdc13ed86
Docs alerting: copy edit terraform provisioning (#55978)
* Docs alerting: copy edit terraform provisioning

* changes intro sentence for explore
2022-09-29 10:19:16 +02:00
brendamuir c0c4409abc
Docs: adds set up section with alertmanager, provisioning sections (#55291)
* Docs: adding setup, provisioning docs

* add set up, alertmanager

* Adds link to provisioning from set up page

* renames topics in set up section

* fixes alertmanager link

* removing article for alertmanager

* first connection to oncall

* updating armands intro text

* getting rid of blank line
2022-09-16 17:22:20 +01:00
brendamuir ab774b47fb
Docs: create new explore page for concepts (#55161)
* Docs: create new explore page for concepts

* Updates weighting of explore section to appear at top

* Weight for fundamentals page
2022-09-14 12:16:59 +01:00
brendamuir e0e76f0252
Fixes term Grafana Alerting (#50404) 2022-06-08 13:35:37 +02:00
Christopher Moyer a568d421f8
Docs: Setup refactor (#49739)
* builds out refactored setup topics

* Automatically fix some relrefs with mv-manager

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Use refs for tutorials content which is outside of this repository

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Manually fix complicated relrefs

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* consolidates team sync and db encryption topics

* Fix relrefs

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* updates setup index file

* Convert TOML to YAML

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Add current alias for new alerting content

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Add current aliases to new setup-grafana and configure-security pages

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Update docs/sources/setup-grafana/configure-grafana/_index.md

Co-authored-by: Torkel Ödegaard <torkel@grafana.com>

* moves saml docs, updates order in TOC

* Manually fix relrefs

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* added usage insights topics, adjusted weights

* corrected relrefs

* Fix relrefs broken in rebase

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
Co-authored-by: Torkel Ödegaard <torkel@grafana.com>
2022-06-02 11:57:22 -05:00
Christopher Moyer 8c84d62e3d
Docs: combines all SAML topics into one topic (#49443)
* combines all SAML topics

* resolves merge conflicts

* makes prettier
2022-05-27 07:42:51 -05:00
Jack Baldry b84294dd27
Convert TOML front matter to YAML (#49690)
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
2022-05-26 11:06:25 -04:00
JitaC a968a43e0c
Docs: Move alert rule section to alerting fundamentals section (#49657)
* initial commit

* Added links to alert rules, and fixes one broken alerting relref.
2022-05-25 18:53:05 -04:00
JitaC 6397b34f8b
Docs: Move labels and annotations topic to alerting fundamentals section (#49283)
* Moved annotation and labels topic to fundamentals and added label matching to the same section

* Cosmetic updates to "How label matching works topic"

* Few more changes to annotations and label section. Also added stem sentence to silences topics.

* Fixed one more broken relref.

* Update docs/sources/alerting/fundamentals/_index.md

Co-authored-by: Christopher Moyer <35463610+chri2547@users.noreply.github.com>

Co-authored-by: Christopher Moyer <35463610+chri2547@users.noreply.github.com>
2022-05-19 19:17:57 -04:00
Jack Baldry 51dfcd7d37
Add current alias to all files (#48635)
* Add aliases to all files

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Prettify front matter

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
2022-05-17 08:24:11 -07:00
achatterjee-grafana 082cfbdb06
Docs: Refactor alerting documentation (part 1) (#48664)
* Initial commit

* Moved files, ad fixed broken relrefs.

* Fixed other broken relrefs

* More changes.

* Fixing broken relrefs

* More changes.

* Fixed last of the broken links

* More re-org.

* Added aliases and some weight adjustments

* More aliases.

* Fix fundamentals topic.

* Fixed remaining metadata issues

* Ran prettier
2022-05-04 08:22:11 -04:00