Commit Graph
48 Commits
Author SHA1 Message Date
Pepe Cano 3af72bdeee Alerting docs: fix Alertmanagers title (#88625) 2024-06-04 09:10:28 +02:00
Pepe Cano 2a8a6d755f Alerting: update Set evaluation behavior text (#88301)
* Alerting: update `Set evaluation behavior` text

* Update `Evaluation group` description for the `Evaluation group` modal view
2024-06-03 15:41:34 +02:00
Pepe Cano 3e57576770 Alerting docs: Contact points updates (#88582)
* Update `Intro>Notifications>Contact points`

* Mention `OnCall` integration
2024-06-03 11:01:54 +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
Pepe Canoandbrendamuir 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
Pepe Cano 51e27200a6 Alerting: add NeedHelpInfo for Configure No data and error handling (#88145) 2024-05-24 15:30:12 +02:00
Pepe Canoandbrendamuir 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
Pepe Cano 33db776c91 Alerting docs: fixes missing alt attributes (#88235)
* Fix missing `alt` text in images

* Fix `canonical` setting in AlertManager docs

* Fix `.`(dot) position in hyperlinks due to a temporary styling issue

* Revert "Fix `canonical` setting in AlertManager docs"

This reverts commit 65354b3642.
2024-05-23 18:07:52 +02:00
Pepe Cano 643018f94a Alerting docs: Fix Alertmanager canonical setting (#88236) 2024-05-23 17:57:22 +02:00
Pepe Cano a035040630 Alerting docs: update Intro/Queries and Conditions (#88164) 2024-05-22 15:34:07 +02:00
Pepe Cano fc11350554 Alerting docs: remove Namespaces/folders/groups doc from Alert rules Intro (#88146)
Alerting docs: remove Namespaces/folders/groups doc from Alert rules Intro
2024-05-21 22:43:36 +02:00
Pepe Cano f3be9d009e Alerting docs: Fix H3 headings in Configure Grafana alert rules. (#88040)
Configure Grafana alert rules: Fix `H3` headings
2024-05-20 10:41:27 +02:00
Pepe Canoandbrendamuir 8e5ce99f72 Update Configure no data and error handling and State & Health (#87985)
* Update `Configure no data and error handling` and State & Health

* 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>

* 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/alert-rule-evaluation/state-and-health.md

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

---------

Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
2024-05-20 09:39:30 +02:00
Pepe Cano 67f434dc73 Remove Single and multi-dimensional rule from Configure alert rules (#87951)
* Remove `Single and multi-dimensional rule` from `Configure alert rules`

* Do not change H3 titles
2024-05-20 09:34:00 +02:00
Pepe Cano 54eab4db59 Alerting docs: Relocate Resolved stale alert instances section (#87965)
Relocate `Resolved stale alert instances` section
2024-05-20 09:33:14 +02:00
Pepe Cano 608a3faacd Alerting docs: Last changes State and Health (#87920)
* Last changes `State and Health`

* Add additional explanation for `Keep last state`

* Minor clarification
2024-05-15 16:44:52 +02:00
Pepe Canoandbrendamuir 37d1d1c0a0 Alerting docs: Update State and health of alerts docs (#87846)
* Update `View alert state and history`

* first edit `State and Healths of alerts`

* Complete `State and health of alerts`

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

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

---------

Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
2024-05-15 10:49:16 +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
Pepe Cano 1b69d647be Alerting docs: update Comparison between alert rule types (#87252) 2024-05-06 17:32:33 +02:00
Pepe Cano 14789db1b7 Docs: add Provisioning section to Install on Kubernetes docs (#83875)
* Docs: add `Provisioning` section to `Install on Kubernetes` docs

* prefix k8s object names with `grafana-`

* Fix `suplying` typo
2024-04-23 18:24:25 +02:00
Pepe Cano 656918ce35 Alerting docs: simplify Supported data sources section (#85795) 2024-04-15 10:56:01 +02:00
0672bdf397 Alerting docs: add Template variable interpolation section in file provisioning (#84106)
* Alerting docs: add `Template variable interpolation` section in file provisioning

* Update docs/sources/alerting/set-up/provision-alerting-resources/file-provisioning/index.md

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

* Update docs/sources/alerting/set-up/provision-alerting-resources/file-provisioning/index.md

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

* Update docs/sources/alerting/set-up/provision-alerting-resources/file-provisioning/index.md

Co-authored-by: Matthew Jacobson <matthew.jacobson@grafana.com>

---------

Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
Co-authored-by: Matthew Jacobson <matthew.jacobson@grafana.com>
2024-04-08 17:34:26 +02:00
Pepe Cano 441118e506 Alerting docs: include hcl format in /alert-rules/:uid/export endpoint (#85432) 2024-04-08 16:01:18 +02:00
Pepe Cano d7ad7c6169 Alerting docs: update disable_provenance TF mute_timing (#85692) 2024-04-08 10:20:51 +02:00
Pepe Cano a56a842d5f Alerting docs: fix docs/shared API to render the current version (#85526) 2024-04-03 16:04:58 +02:00
Pepe Cano 2d6586952d Alerting: Add placeholder to the Email Contact Point Message (#84064) 2024-03-21 13:03:12 -04: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 60b9a1058a Docs: Specify Recorded queries is available in Grafana Cloud (#84716) 2024-03-21 09:17:27 +01:00
Pepe Cano a7c7a1ffed Alerting docs: Fix format issues in recent Slack tutorial (#84651)
* Alerting docs: Fix format issues in Slack tutorial

* Alerting docs: Include link to Slack docs

* Alerting docs: fix Slack `nested-policy` link
2024-03-18 13:18:57 +01:00
Pepe Cano 200ff7f9b4 Alerting docs: fix broken link (#84572) 2024-03-15 16:23:52 +01:00
Pepe Canoandbrendamuir 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
Pepe Cano e1d9aa5a7b Alerting docs: document HTTP API to create templates (#84055) 2024-03-14 09:01:13 +01:00
Pepe Cano 9c520acf9c Alerting: Minor changes to UI help text and descriptions (#84023) 2024-03-07 12:33:16 +01:00
Pepe Cano dbb55f291a Alerting docs: update the supported export template functionality (#83816) 2024-03-07 08:42:38 +01:00
Pepe CanoandJack Baldry ce827f9518 Configure Grafana docs: fix custom configuration file location (#83169)
* Configure Grafana docs: fix custom configuration file location

* Replace config file with `custom.ini`

---------

Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
2024-03-06 16:46:28 +01:00
Pepe Cano 2653bd8fab Alerting docs: update file provisioning guide (#83924) 2024-03-06 09:18:59 +01:00
Pepe Cano 019c9618f0 Alerting docs: improve visibility on the distinct options to edit provisioned resources (#83839)
Alerting docs: specify the distinct options to edit provisioned resources
2024-03-05 10:48:04 +01:00
Pepe Canoandbrendamuir 111df1bba0 Alerting docs: update the Terraform Provision guide (#83773)
* Alerting docs: update the Terraform Provision guide

* Fix incorrect links

* Update docs/sources/alerting/set-up/provision-alerting-resources/terraform-provisioning/index.md

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

* Update docs/sources/alerting/set-up/provision-alerting-resources/terraform-provisioning/index.md

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

* Update docs/sources/alerting/set-up/provision-alerting-resources/terraform-provisioning/index.md

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

---------

Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
2024-03-04 12:10:37 +01:00
Pepe Cano 244589d7ea Alerting docs: document mute-timings export endpoints (#83797) 2024-03-04 10:50:44 +01:00
Pepe Cano 9eb69b9213 Alerting docs: fix incorrect docs/reference link (#83809) 2024-03-04 10:20:10 +01:00
Pepe Cano 88f010a72a Alerting docs: remove admonition/notes related to old Grafana versions (#83669) 2024-02-29 12:55:52 +01:00
eb25b669c6 Alerting docs: update Alerting Provisioning (#83376)
* Minor updates to Provisioning Index page

* Add instructions to export other alerting resources

* Edit example provisioning a `template` via config file

* Add `Resource` column to the `Export API endpoints` table

* Sort the `export` endpoint on the table in `Alerting Provisioning HTTP API`

* Minor updates for clarity to `Use configuration files to provision` docs

* Add `More examples` in Terraform Provisioning docs

* File provisioning: rename `Useful Links` section to `More examples`

* Minor grammar change

* Update docs/sources/alerting/set-up/provision-alerting-resources/_index.md

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

* Update docs/sources/alerting/set-up/provision-alerting-resources/_index.md

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

* Update docs/sources/alerting/set-up/provision-alerting-resources/export-alerting-resources/index.md

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

* Update docs/sources/alerting/set-up/provision-alerting-resources/export-alerting-resources/index.md

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

* Update docs/sources/alerting/set-up/provision-alerting-resources/export-alerting-resources/index.md

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

* Update docs/sources/alerting/set-up/provision-alerting-resources/file-provisioning/index.md

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

* Update docs/sources/alerting/set-up/provision-alerting-resources/file-provisioning/index.md

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

* Update docs/sources/alerting/set-up/provision-alerting-resources/file-provisioning/index.md

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

* Update docs/sources/alerting/set-up/provision-alerting-resources/file-provisioning/index.md

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

* Update docs/sources/alerting/set-up/provision-alerting-resources/file-provisioning/index.md

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

* Update docs/sources/alerting/set-up/provision-alerting-resources/file-provisioning/index.md

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

* Update docs/sources/alerting/set-up/provision-alerting-resources/file-provisioning/index.md

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

* Update docs/sources/alerting/set-up/provision-alerting-resources/file-provisioning/index.md

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

* Update docs/sources/alerting/set-up/provision-alerting-resources/file-provisioning/index.md

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

* Update docs/sources/alerting/set-up/provision-alerting-resources/file-provisioning/index.md

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

* Update docs/sources/alerting/set-up/provision-alerting-resources/file-provisioning/index.md

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

* Update docs/sources/alerting/set-up/provision-alerting-resources/file-provisioning/index.md

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

* Update docs/sources/alerting/set-up/provision-alerting-resources/file-provisioning/index.md

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

* Update docs/sources/alerting/set-up/provision-alerting-resources/file-provisioning/index.md

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

* Update docs/sources/alerting/set-up/provision-alerting-resources/file-provisioning/index.md

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

* Update docs/sources/alerting/set-up/provision-alerting-resources/file-provisioning/index.md

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

* Update docs/sources/alerting/set-up/provision-alerting-resources/file-provisioning/index.md

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

* Address requested changes to `Export` docs

* export: Minor grammar change

* Update docs/sources/alerting/set-up/provision-alerting-resources/export-alerting-resources/index.md

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

* Fix `doc-validator` issue with relative link

* Use patch fixed version of doc-validator that better supports docs/reference destinations

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

---------

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
2024-02-27 16:22:24 +01:00
Pepe Cano 9c42826c30 Alerting docs: fix broken link and apply the Writer toolkit guideline to other links (#83209)
* Fix `/docs/reference` cannot be used within admonitions

* Remove `relref` links to apply Writers toolkit guidelines
2024-02-22 11:31:59 +01:00
Pepe Cano 5b918f555c Alerting docs: correct notification-policies link (#83099) 2024-02-20 13:50:31 +01:00
Pepe CanoandJack Baldry 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
Pepe Cano 3909b4c14a Alerting docs: update <GRAFANA VERSION> to <GRAFANA_VERSION> (#82324) 2024-02-13 09:21:50 +00:00
Pepe Canoandbrendamuir 9c92329bee Alerting docs: Provision alerting resources updates (#82221)
* Alert provisioning: initial restructuring

* Fix products labels

* Restructure `Import and export Grafana Alerting resources`

* Change URL to `export-alerting-resources`

* Complete `Export alerting resources`

* Export alerting resources

* Update `configuration files` provisioning

* Terraform Provisioning

* Change to `Provision/Import/Export` terms and some notes

* Replace `config` to `configuration`

* Set (menu)Title `Export alerting resources`

* Minor change on note about `Export Alerting endpoints`

* Fix `doc-validator` issues

* Fix grammar

* Update docs/sources/alerting/set-up/provision-alerting-resources/terraform-provisioning/index.md

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

* Update docs/sources/alerting/set-up/provision-alerting-resources/terraform-provisioning/index.md

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

* Fix numbered lists and `Note:` without admonition

* Convert text-based notes (`Note:`) to `admonition` blocks

* Replace text-based `Note:` with adminitions

* Remove `file-provisioning` grafana-cloud links

* Update `Export alerting resources` intro

* nitpicky format order

---------

Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
2024-02-12 10:27:18 +01:00