121 Commits

Author SHA1 Message Date
656918ce35 Alerting docs: simplify Supported data sources section (#85795) 2024-04-15 10:56:01 +02:00
856e410480 Alerting docs: Update Alert rules intro and Introduction pages (#84772)
undefined
2024-03-21 11:06:49 +01:00
c5b04b5674 Alerting: Add docs for "Keep Last State" feature (#84676)
Add initial docs for "Keep Last State" feature
2024-03-20 13:11:16 -04:00
06b8eb6279 Alerting docs: update Supported data sources (#84495)
* Alerting docs: update `Supported data sources`

* Update docs/sources/alerting/fundamentals/alert-rules/_index.md

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

---------

Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
2024-03-15 10:00:51 +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
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
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
5b918f555c Alerting docs: correct notification-policies link (#83099) 2024-02-20 13:50:31 +01:00
b6098f2dde Alerting docs: clean up Cloud links (#83073)
* Use fixed `/docs/grafana-cloud/alerting-and-irm` URLs for cloud references

* Fix `docs/grafana-cloud/` data sources links

* Fix `docs/grafana-cloud/` Panel & Visualization links

* Fix `/docs/grafana-cloud/` link to Dashboard page

* Set root directory `docs/reference` for non-cloud pages

* Fix `admonition` cannot use a  `docs/reference` relative link

* Update `doc-validator`

https://github.com/grafana/technical-documentation/releases/tag/doc-validator%2Fv4.1.0

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

---------

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
2024-02-20 11:49:39 +01:00
3909b4c14a Alerting docs: update <GRAFANA VERSION> to <GRAFANA_VERSION> (#82324) 2024-02-13 09:21:50 +00:00
899e06b439 Alerting docs: changes alerting rules to alert rules (#82049)
* Alerting docs: changes alerting rules to alert rules

* ran prettier
2024-02-07 11:04:13 +01:00
030a68bbf7 Alerting docs: recovery threshold (#81069)
* Alerting docs: recovery threshold

* ran prettier

* Adds note that only available in oss

* ran prettier
2024-01-25 10:28:32 +01:00
5576731332 Docs: Update variables-label-annotation.md (#81134)
Update variables-label-annotation.md

Additional closing bracket was removed
2024-01-24 12:36:50 +02:00
f9486ad2ee Alerting docs: updates eval group and provisioning topics for support (#81066) 2024-01-23 14:24:12 +01:00
084a3c6b7f Update notifications.md (#80868)
Added clarity about the order policies are evaluated
2024-01-19 16:15:15 +01:00
524debbe53 Docs: adds docs on aggregation functions for alerting (#78893)
* Docs: adds docs on aggregation functions for alerting

* ran prettier
2023-12-20 10:18:08 +01:00
4d375aa5d4 Alerting docs: Adds Alerting descriptions for fundamentals section (#79383)
Adds Alerting descriptions for fundamentals section
2023-12-12 11:26:36 +01:00
58d0c51cf4 Alerting: Add note to the docs that GMA rules are evaluated concurrently (#78902) 2023-12-01 18:32:48 +01:00
1b2a621533 Docs: adds docs on excluding labels (#78806)
* Docs: adds docs on excluding labels

* run prettier

* Update docs/sources/alerting/fundamentals/annotation-label/labels-and-label-matchers.md

Co-authored-by: Gilles De Mey <gilles.de.mey@gmail.com>

* adds table for display

* ran prettier

---------

Co-authored-by: Gilles De Mey <gilles.de.mey@gmail.com>
2023-11-30 10:26:22 +01:00
ba384d29f6 Alerting: Fix order of the Alerting docs (#77084) 2023-10-24 19:31:03 +01:00
2c2d8bcc74 Alerting: Feedback on docs (#77068) 2023-10-24 16:53:26 +01:00
272a901e5e Alerting: Improve order of docs pages (#76998) 2023-10-24 10:50:19 +01:00
0fc9da1422 Alerting: Improve documentation on high availability (#76434) 2023-10-24 10:15:38 +01:00
32f48ee64a Alerting: Fix link in docs (#76982) 2023-10-23 16:53:31 -05:00
e94e283cc6 Alerting: Improve Introduction to Alerting docs (#76591) 2023-10-23 13:03:20 +03:00
622ecbb722 Alerting: Improve the docs for grouping and timers (#76589) 2023-10-23 09:48:24 +01:00
e743aa54b8 Alerting: Improve the docs on templating labels and annotations (#76593)
The previous version of this page I wrote with the expectation that
readers would first learn the templating language and then write
their templates. This doesn't seem to have worked out as well as I
had expected, and so I've rewritten the documentation to explain
the language using relevant and useful examples instead.
2023-10-23 09:43:13 +01:00
0592fe7edb Alerting: Add support for msteams contact point in external Alertmanagers (#76392)
* Add support for msteams contact point in external AMs

* Update docs
2023-10-13 10:43:42 -05:00
4432c4c75c Fix developer links and newly discovered spelling errors (#75875)
* Fix developer links

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

* Fix newly discovered spelling errors

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

---------

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
2023-10-03 13:49:27 +01:00
0e2b741fc3 Docs: Remove old plugin docs, fix URLs to go to new dev portal (#75325)
* Remove old plugin docs, add redirects to new dev portal

* Restore plugin.schema.json file

* Update docs/sources/administration/plugin-management/index.md

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

* More updates

* Cleanup links

* Update docs/sources/alerting/fundamentals/evaluate-grafana-alerts.md

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

* fix codeowners

* Change reference links to inline links to avoid 404s

* Update docs/sources/datasources/_index.md

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

* Update docs/sources/datasources/mysql/_index.md

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

* Update docs/sources/datasources/postgres/_index.md

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

* Update docs/sources/fundamentals/timeseries-dimensions/index.md

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

* Update docs/sources/fundamentals/dashboards-overview/index.md

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

* Update docs/sources/fundamentals/dashboards-overview/index.md

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

* Update docs/sources/panels-visualizations/configure-standard-options/index.md

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

* Update docs/sources/panels-visualizations/query-transform-data/transform-data/index.md

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

* Remove grafana.com from 2 URLs

* Fix 1 more reference link

* Prettier fix

---------

Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
2023-09-29 07:43:48 +01:00
9decb889e5 Fix Grafana Cloud data source alerting link 404 (#73240)
* Add datasources link for Grafana Cloud

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

* Use inferred labels to reduce typing

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

---------

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
2023-09-18 10:49:16 +01:00
1ed6071f95 Docs: Fix a typo issue (#74498)
Update _index.md

Fix typo issue
2023-09-07 10:13:34 +02:00
439270f6cb Rename Google Hangouts to Google Chat (#74162)
* Rename Google Hangouts to Google Chat

* Fix prettier
2023-08-31 16:09:22 +03:00
164161b41a Docs: Update docs on comparisions with $values (#74156) 2023-08-31 10:32:09 +01:00
b654e5642c Docs: change headings on 2 data source pages for SEO (#73792)
* changed grafana alerting titles and headings

* changed H1 heading for SEO
2023-08-25 08:48:09 -05:00
356d8872bd Alerting docs: fix duplicate titles (#73680)
* Alerting docs: fix duplicate titles

* makes titles match
2023-08-23 14:34:54 +02:00
bf5fa18137 Docs: updates to alert rule docs (#72313)
* Docs: updates to alert rule docs

* removes steps

* edits to numbering

* description parameter edit

* fixing description frontmatter
2023-07-26 09:18:13 +02:00
43f7309272 Docs: updates to recording rules (#72218) 2023-07-24 20:35:55 +02:00
43fb14ef8c Docs: updates alerting rules docs (#72190)
* Docs: updates alerting rules docs

* Docs: adds queries and conditions topic
2023-07-24 15:57:41 +02:00
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
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
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
5159317ee7 Docs: adds evaluation doc (#70757)
* Docs: adds evaluation doc

* Adds note on classic condition

* fixes link

* fixes link

* fixes link

* fixes data source

* link fix

* fixes rbac link

* adds aliases
2023-06-28 10:38:59 +02:00
f436364f9b Docs: adds queries and conditions doc (#70674)
* Docs: adds queries and conditions doc

* fixes link

* fixes link

* fix link

* fixes typo

* corrects relref

---------

Co-authored-by: Chris Moyer <chris.moyer@grafana.com>
2023-06-26 09:28:39 -05:00
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
cd8e5dc140 Docs: rearrange content order (#70425)
* Docs: rearrange content order

* more rearranging

* fixes relrefs

* fixes links
2023-06-21 11:30:52 +02:00
701c6b6f07 Docs: fixes various links (#70384)
* Docs: fixes various links

* bit more moving

* corrects link

* fixes links

* fixes links from move

* fix links

* fix links

* fixes links

* fixes links

* fix typo

* fixes typo

* fix notif policy link

* fix link
2023-06-20 21:49:57 +02:00
c0dfaa626c Docs: Adds fixes for external PRs (#69997)
* Adds fixes for external PRs

* fixes typo

* capitalizes alertmanager
2023-06-13 14:17:50 +02:00
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
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