Commit Graph

89 Commits

Author SHA1 Message Date
brendamuir
4720c99bd5
Alerting docs: Fix migrating alert links (#83141)
* Alerting docs: fixes migrating links

* Fixes underscores and stars

* Corrects numbering

* ran prettier

* Fix links

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

* Update docs/sources/alerting/set-up/migrating-alerts/_index.md

Co-authored-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-21 10:41:12 +01:00
Pepe Cano
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
Matthew Jacobson
118e4a50b7
Alerting: Remove start page of legacy upgrade preview (#82010)
Alerting: Remove start page of upgrade preview

Alerting upgrade page will now always show the summary table even before
upgrading any alerts or notification channels. There a few reasons for this:

- The information on the start page is redundant as it's now contained in the
documentation.
- Previously, if some unexpected issue prevented performing a full upgrade, a
user would have limited to no means to using the preview tool to help fix the
problem. This is because you could not see the summary table until the full
upgrade was performed at least once. Now, you can upgrade individual alerts and
notification channels from the beginning.
2024-02-15 17:34:00 -05:00
Pepe Cano
3909b4c14a
Alerting docs: update <GRAFANA VERSION> to <GRAFANA_VERSION> (#82324) 2024-02-13 09:21:50 +00:00
Pepe Cano
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
Matthew Jacobson
ce57166c9a
Alerting: GA alertingPreviewUpgrade and enable by default (#82038)
* Alerting: GA alertingPreviewUpgrade and enable by default
2024-02-08 18:59:25 +01:00
Wil.P
679d90be04
Patch 3 (#81937)
* Update _index.md

moved to the asked location

* ran prettier

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

---------

Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
2024-02-06 14:26:31 +01:00
brendamuir
95f90127ad
Alerting docs: rename provisioning files (#81722) 2024-02-01 17:50:29 +01:00
Sonia Aguilar
da1538ba82
Alerting: Update docs after moving action buttons im the alert list, and move t… (#81375)
Update docs after moving action buttons im the alert list, and move the loading spinner
2024-01-29 16:52:34 +01:00
Julien Duchesne
2e352ba4d6
Docs(alerting): Document the disable_provenance attribute (#81290)
We no longer need to pass a http header
2024-01-26 09:16:45 +01:00
Jean-Philippe Quéméner
25dd8d5ceb
Docs: add section about periodic state saving for alerting (#81244) 2024-01-25 17:05:58 +01:00
Matthew Jacobson
2607528b52
Alerting: Update legacy migration docs to include Upgrade Preview (#80628)
* Alerting: Update legacy migration docs to include Upgrade Preview
2024-01-23 14:09:52 -05:00
brendamuir
f9486ad2ee
Alerting docs: updates eval group and provisioning topics for support (#81066) 2024-01-23 14:24:12 +01:00
brendamuir
d50abe2ea2
Alerting docs: changes wrong label on configure alert state history doc (#80438) 2024-01-12 15:16:59 +01:00
Johannes Ehm
642391c9f9
Alerting: adds execErrState to the alerting file provisioning example as it is missing (#79002) 2024-01-10 12:49:38 +01:00
Gilles De Mey
d2b023076b
Alerting: Add support for TTL for pushover for Mimir Alertmanager (#78687) 2024-01-08 15:48:36 +01:00
annelaurefroment
f09353e094
Update _index.md (#79237)
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
2023-12-27 09:21:55 +00:00
brendamuir
9bd20db49f
Alerting docs: remaining descriptions and deletes legacy topics (#79387)
Alerting docs: remaining descriptions and deletes legacy cloud alerting topics
2023-12-12 15:08:28 +01:00
Matthew Jacobson
5a80962de9
Alerting: Add clean_upgrade config and deprecate force_migration (#78324)
* Alerting: Add clean_upgrade config and deprecate force_migration

Upgrading to UA and rolling back will no longer delete any data by default. 
Instead, each set of tables will remain unchanged when switching between 
legacy and UA. As such, the force_migration config has been deprecated 
and no extra configuration is required to roll back to legacy anymore.

If clean_upgrade is set to true when upgrading from legacy alerting to Unified
Alerting, grafana will first delete all existing Unified Alerting resources,
thus re-upgrading all organizations from scratch. If false or unset,
organizations that have previously upgraded will not lose their existing Unified
 Alerting data when switching between legacy and Unified Alerting.

 Similar to force_migration, it should be kept false when not needed as it may
 cause unintended data-loss if left enabled.

---------

Co-authored-by: Christopher Moyer <35463610+chri2547@users.noreply.github.com>
2023-11-30 11:01:11 -05:00
brendamuir
0e3c39c0e6
Docs: adds alerting provisioning updates (#78454)
* Docs: adds alerting provisioning updates

* prettier and changed passives
2023-11-21 13:55:39 +01:00
Arkadip Bhattacharya
b3bf38ad68
fix: ha_peer to ha_peers (#75724) 2023-11-20 14:27:00 +01:00
littlelionking
577b3f2fb2
Docs: Reduce location indentation to match time_interval_spec (#77291)
Reduce location indentation to match time_interval_spec

https://prometheus.io/docs/alerting/latest/configuration/#time_interval_spec

Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
2023-11-03 11:44:59 +01:00
George Robinson
ba384d29f6
Alerting: Fix order of the Alerting docs (#77084) 2023-10-24 19:31:03 +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
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
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
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
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
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
brendamuir
356d8872bd
Alerting docs: fix duplicate titles (#73680)
* Alerting docs: fix duplicate titles

* makes titles match
2023-08-23 14:34:54 +02: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
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
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
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
Alexander Weaver
128990dbb7
Docs: Consolidation and add call-outs for semantics in Alert Provisioning documentation (#68848)
* Provisioning landing page

* Move editing bit to view page

* Specify API vs File, and provide terraform example

* Improvements around notif policies

* Docs around contact points

* Use h2 instead of h1

* Address feedback

* Move text about policy granularity
2023-07-17 11:15:51 -05:00
Matthew Jacobson
8c6cdf51fc
Alerting: No longer silence paused alerts during legacy migration (#71596)
* Alerting: No longer silence paused alerts during legacy migration

Now that we migrate paused legacy alerts to paused UA alert rules, we no longer need to silence them.
2023-07-17 09:37:53 -04: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
Armand Grillet
3ec0558204
Clarify external AM limitation (#71179) 2023-07-07 17:13:11 +02:00
Gilles De Mey
536146de5f
Docs: Adding the right syntax highlighting in a few places (#71141)
Adding the right syntax highlighting in a few places
2023-07-07 09:15:39 +02:00
Gilles De Mey
6af12b1953
Docs: Set up alert state history (#71123)
Co-authored-by: Armand Grillet <2117580+armandgrillet@users.noreply.github.com>
2023-07-06 17:03:32 +02:00
Matthew Jacobson
00d5f7fed7
Alerting: Convert 'Both' type Prometheus queries to 'Range' in migration (#70781)
* Alerting: Convert 'Both' type Prometheus queries to 'Range' in migration
2023-06-28 14:02:57 -04:00
brendamuir
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
Andreas Deininger
95b1f3c875
Fixing typos (#70487) 2023-06-22 09:43:38 +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