Commit Graph

544 Commits

Author SHA1 Message Date
George Robinson 5118ac9abd
Update documentation for timezones in mute timings (#77370) 2023-10-30 17:28:01 +01:00
George Robinson ba384d29f6
Alerting: Fix order of the Alerting docs (#77084) 2023-10-24 19:31:03 +01:00
George Robinson 2c2d8bcc74
Alerting: Feedback on docs (#77068) 2023-10-24 16:53:26 +01:00
George Robinson 1cb1d174fd
Alerting: Fix confusion around what can and cannot be customized in notifications (#77032)
* Alerting: Fix confusion around what can and cannot be customized in notifications

* Small fix

* Second small fix
2023-10-24 12:41:08 +01:00
George Robinson 272a901e5e
Alerting: Improve order of docs pages (#76998) 2023-10-24 10:50:19 +01:00
George Robinson 0fc9da1422
Alerting: Improve documentation on high availability (#76434) 2023-10-24 10:15:38 +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
George Robinson 622ecbb722
Alerting: Improve the docs for grouping and timers (#76589) 2023-10-23 09:48:24 +01:00
George Robinson 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
Sonia Aguilar a26318714f
Alerting: Update docs with the new create alert menu option in panels (#76825)
* Update docs with the new create alert menu option in panels

* fix errors

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

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

---------

Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
2023-10-23 10:21:34 +02:00
Alexander Weaver 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
Jack Baldry f6d2c11be9
Fix typo in link label (#76443) 2023-10-12 13:37:26 +01:00
Marin N 150d4d68ad
Update _index.md (#75359)
* Update _index.md

* Update _index.md

Run through Prettier

* Update _index.md

ran Prettier again

* Prettier

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>
2023-10-07 12:47:03 +02:00
Jack Baldry 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
Joseph Perez 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
tonypowa 6d08050f84
alerting: docs : expand new nested policy instructions (#75616)
added some clarifications to new nested pol
2023-09-28 18:31:24 +02:00
brendamuir 23a873b33f
Alerting docs: fixes next and latest link errors (#75437)
* Alerting docs: fixes next and latest link errors

* fixes bracket

* more link fixes

* fixes numbering

* prettier

* Fix build errors, a broken link, and use more appropriate destination for Grafana Cloud OnCall links

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

* fixes for jacks feedback

* fixes note

---------

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
2023-09-26 16:15:32 +02:00
Jack Baldry 3ab31c345e
Fix migrating alerts aliases (#74898)
* Add comments to indicate which page I believe each alias is intending to redirect

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

* Remove difference-old-new redirect from migrating-alerts page since an alternative page exists

The alternative page is `docs/sources/alerting/difference-old-new.md`.

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

* Add comment to show intended absolute path redirect

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

* Remove `unified-alerting/difference-old-new/` redirect because it already exists in `docs/sources/alerting/difference-old-new.md`.

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

* Remove `unified-alerting/` alias since the absolute URL already redirects to `/docs/grafana/latest/alerting/`

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

* Fix `/docs/grafana/<GRAFANA VERSION>/alerting/migrating-alerts/` redirect

The following example uses `latest` as _`GRAFANA VERSION`_ for simplicity and readability.

The desire is the following redirect:

```
src: /docs/grafana/latest/alerting/migrating-alerts/
dst: /docs/grafana/latest/alerting/set-up/migrating-alerts/
```

`dst` is the Hugo pretty URL for the current page (`docs/sources/alerting/set-up/migrating-alerts/_index.md`).

When constructing Hugo aliases we are working from the page's containing directory and not the page itself.
The path element `.` represents that directory.
For example:

```
 page: /docs/grafana/latest/alerting/set-up/migrating-alerts/
alias: ./
  dst: /docs/grafana/latest/alerting/set-up/
```

The path element `..` represents the parent directory of the page's containing directory.
For example:

```
 page: /docs/grafana/latest/alerting/set-up/migrating-alerts/
alias: ../
  dst: /docs/grafana/latest/alerting/
```

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

---------

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
2023-09-26 11:29:29 +01:00
brendamuir f229758af0
Alerting docs: fixes numeric data link take 2 (#75166) 2023-09-20 19:02:34 +02:00
brendamuir 55a4d9b38e
Alerting docs: fixes numeric data link (#75155) 2023-09-20 14:09:17 +02:00
brendamuir c999979bc5
Alerting docs: removes cloud link (#75142)
* Alerting docs: removes cloud link

* removes link sentence
2023-09-20 12:17:54 +02:00
Jack Baldry 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
brendamuir 0451e59134
Alerting docs: removes cloud notes (#74897) 2023-09-14 12:03:26 +02:00
brendamuir 5de5ad288b
Alerting docs: Meta monitoring for cloud (#74797)
* Alerting docs: splits meta monitoring content cloud and oss

* adds structure

* commit

* updates menutitle to monitor

* deletes cloud specific topic

* adds comment to aliases

* Update aliases to correctly redirect the commented URLs

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

* changes weighting

* adds intro text under heading

---------

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
2023-09-13 15:32:43 +02:00
Jack Baldry de9b658b7f
Fix contact points aliases and add additional for `/docs/grafana/<GRAFANA_VERSION>/alerting/contact-points/` (#74673)
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
2023-09-13 10:33:22 +01:00
Jack Baldry ac314855eb
Remove set-up-cloud page as it has been moved to the website repository (#74755)
* Page has been moved to the website repository

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

* Update .codespellignore to ignore 'Operator Windrose' and fix typo

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

---------

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
2023-09-13 00:37:48 +03:00
brendamuir ab963a8558
Alerting docs: quick corrections to oncall integration (#74758)
* Alerting docs: quick corrections to oncall integration

* corrects spelling errors
2023-09-12 19:46:03 +02:00
brendamuir 5c31c7096c
Docs: Alerting - On call integration (#74719)
* Alerting docs: adds oncall integration docs and release note

* adds oncall integ to structure

* corrects link

* updates links

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

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

* updates metamonitoring link

* update to product name

* Update docs/sources/alerting/alerting-rules/manage-contact-points/configure-oncall.md

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

* Update docs/sources/alerting/alerting-rules/manage-contact-points/configure-oncall.md

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

* Modify reference links to ensure that `doc-validator` ignores them

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

* breaks up sentence

---------

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
2023-09-12 16:46:13 +02:00
Jennifer Villa 09137da78c
Update metamonitoring docs for alerting (#74559)
* Update _index.md

Update to metamonitoring docs

* Update _index.md
2023-09-11 09:59:37 +02:00
Yuri Tseretyan 99fd7b8141
Alerting: Update provisioning to validate user-defined UID on create (#73793)
* add ValidateUID to util
* provisioning to validate UID on rule creation

---------

Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
Co-authored-by: Alexander Weaver <weaver.alex.d@gmail.com>
2023-09-08 15:09:35 -04:00
brendamuir b22cfcd336
Docs alerting: meta monitoring topics (#74440)
* Docs alerting: adds insights logs and updates metamonitoring topic

* updates meta monitoring

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

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

* Update docs/sources/alerting/monitor/meta-monitoring/_index.md

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

* removes alias

* Update docs/sources/alerting/monitor/meta-monitoring/_index.md

Co-authored-by: Jennifer Villa <jvilla2013@gmail.com>

* Update docs/sources/alerting/monitor/meta-monitoring/_index.md

Co-authored-by: Jennifer Villa <jvilla2013@gmail.com>

* Update docs/sources/alerting/monitor/meta-monitoring/_index.md

Co-authored-by: Jennifer Villa <jvilla2013@gmail.com>

* Update docs/sources/alerting/monitor/meta-monitoring/_index.md

Co-authored-by: Jennifer Villa <jvilla2013@gmail.com>

* updates numbering

* adds codeblock

* updates

* Update docs/sources/alerting/monitor/meta-monitoring/_index.md

Co-authored-by: George Robinson <george.robinson@grafana.com>

* Update docs/sources/alerting/monitor/meta-monitoring/_index.md

Co-authored-by: George Robinson <george.robinson@grafana.com>

---------

Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
Co-authored-by: Jennifer Villa <jvilla2013@gmail.com>
Co-authored-by: George Robinson <george.robinson@grafana.com>
2023-09-07 15:08:11 +02:00
Neo Jiang 1ed6071f95
Docs: Fix a typo issue (#74498)
Update _index.md

Fix typo issue
2023-09-07 10:13:34 +02:00
brendamuir bccb5869a5
Alerting docs: link fixes and a note for expressions (#74317)
* Alerting docs: link fixes and a note for expressions

* changes format of note

* fixes extra space

* Update docs/sources/alerting/alerting-rules/create-grafana-managed-rule.md

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

* update prometheus link

---------

Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
2023-09-04 13:45:17 +02:00
George Robinson 439270f6cb
Rename Google Hangouts to Google Chat (#74162)
* Rename Google Hangouts to Google Chat

* Fix prettier
2023-08-31 16:09:22 +03:00
George Robinson 164161b41a
Docs: Update docs on comparisions with $values (#74156) 2023-08-31 10:32:09 +01:00
lwandz13 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
brendamuir 356d8872bd
Alerting docs: fix duplicate titles (#73680)
* Alerting docs: fix duplicate titles

* makes titles match
2023-08-23 14:34:54 +02:00
Isabel 5988da1aa8
Docs: Data source picker everywhere updates (v10.1) (#73347)
* Added text about the updated data source picker

* Reformatted and reworded new language and removed from Correlations
2023-08-17 11:46:51 -04:00
Jean-Philippe Quéméner 44b94eca19
docs(alerting): add section about running redis for HA (#73153) 2023-08-11 13:57:00 +02:00
arunkg2787 cda78c6fe8
Update _index.md (#72562)
Fixes # https://github.com/grafana/support-escalations/issues/6887

Configure HA: Added ha_peer_Timeout global config in the unified alerting
2023-08-09 17:53:57 +02:00
brendamuir 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
brendamuir c6ab1ddb70
Docs: adds new alert rule creation flow (#72257)
* Docs: adds new alert rule creation flow

* updates configure alerting topic

* Adds grafana-managed process

* adds data source-managed and recording rule

* takes out anchor
2023-07-25 22:01:22 +02:00
Matthew Jacobson cfb1656968
Alerting: Add notification policy provisioning file export (#70009)
* Alerting: Add notification policy provisioning file export

- Add provisioning API endpoint for exporting notification policies.
- Add option in notification policy view ellipsis dropdown for exporting.
- Update various provisioning documentation.
2023-07-24 17:56:53 -04:00
brendamuir 43f7309272
Docs: updates to recording rules (#72218) 2023-07-24 20:35:55 +02:00
brendamuir 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
Matthew Jacobson 13121d3234
Alerting: Add contact point provisioning file export (#71692)
* Add contact point provisioning file export apis

* Regenerate api

* docs

* frontend

* add mock to tests

* Fix missing row-level export button on viewer role w/ prov. read

* Address review comments

---------

Co-authored-by: Gilles De Mey <gilles.de.mey@gmail.com>
2023-07-20 14:35:56 -04:00
Clément Duveau 62c6e04d70
Docs: fix broken links (#71911)
* Fix different broken links and missing pages

* Pin version in docs link for release announcements

* fixing validator error

---------

Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com>
2023-07-20 12:39:59 -04:00
brendamuir 58729a331f
Docs: adds aliases to fix 404s (#71926)
* Docs: adds aliases to fix 404s

* fixes alias

* updates alias re jack
2023-07-19 13:48:31 +02: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