Commit Graph

66 Commits

Author SHA1 Message Date
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
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
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
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
Rodrigo Petter Daniel b089281255
Docs: fix bullet lists for supported time interval (#67389)
* Docs: fix bullet lists for supported time interval

* Docs: run prettier
2023-07-18 09:28:50 +02: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
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
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
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
brendamuir 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
brendamuir d529636bc3
Docs: bit of restructuring (#70364)
* Docs: bit of restructuring

* corrects link

* fixes link

* updates

* fixes links

* fixes links

* fixes links

* fixes links

* fixes links
2023-06-20 11:43:12 +02:00
brendamuir 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
brendamuir 5a2e66676e
Docs:fixes alerting support escalations (#69770)
* Docs:fixes alerting support escalations

* updates recording rule text

* adds link

* fixes link

* Update docs/sources/alerting/alerting-rules/create-mimir-loki-managed-recording-rule.md

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

* Update docs/sources/alerting/alerting-rules/create-mimir-loki-managed-recording-rule.md

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

* fixes relref

* adds link to prometheus docs

* fixes relref

---------

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
2023-06-09 10:58:05 +02:00
brendamuir 3227d0b5fd
Docs: removes screenshots (#69634) 2023-06-06 13:01:54 +02:00
arun tvs 09eca5981b
Fix: Fixed a typo in reference.md (#69204)
* Update reference.md

Fixed typo:

`i` to `in`

* Ran prettier
2023-06-06 08:27:49 +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
Santiago 4629c79c7a
Docs: Fix minor mistakes and rephrase "Manage your alert notifications" entry (#68851)
* Docs: Fix minor mistakes and rephrase docs for alert notifications

* Update docs/sources/alerting/manage-notifications/_index.md

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

---------

Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
2023-05-23 11:15:02 -03:00
Matt Dodson 1c4bb9ca00
[feat] docs; update admonition syntax (#68842)
* [feat] docs; update admonition syntax

- Standardizes according to style conventions: https://grafana.com/docs/writers-toolkit/style-guide/style-conventions/#admonitions
- Prepares docs for better, uniform admonition style.

* Remove false positives and irregularities

* false positive removal

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

* Update docs/sources/developers/angular_deprecation/angular-plugins.md

* fix link errors

* Prettify some nested blockquotes

* remoe unnecessary admonition
2023-05-22 15:45:28 -05:00
Hamed Karbasi e446a60800
Docs: Update alert data model of webhook-notifier documentation (#67956)
* Add missed fields to webhook-notifier.md
2023-05-12 09:40:05 -04:00
brendamuir 6464ce0239
Docs: Adds preview notification template docs (#67903)
Adds preview notification template
2023-05-08 09:21:20 +02:00
Santiago a113d94bbb
Docs: Un-draft 'Configure Integrations' docs (#66699)
* Docs: Un-draft 'Configure Integrations' docs

* fix typo
2023-04-18 08:01:52 +02:00
Simon Crute a39190b613
Docs: Add the index function 2023-04-05 15:49:57 +03:00
Ashley Harrison e39c3b76dd
Navigation: Rename Alerts & incidents to Alerts & IRM (#65635)
update Alerts & incidents to Alerts & IRM
2023-03-31 09:40:06 +01:00
Santiago 7b92849508
Alerting: Add CustomDetails field in PagerDuty contact point (#64860)
* Alerting: Add CustomDetails for PagerDuty

* fix default value for 'severity' from 'error' to 'critical'

* minimal docs for notifiers, specifying config for PagerDuty

* replace notifier -> integration

* replace notifier -> integration
2023-03-29 10:35:01 -03:00
Isabel a5c5db3e91
docs: nav updates for alerting (#65300)
* navigation related updates - text only

* navigation related updates

* navigation related text updates

* navigation related text updates

* navigation related text and image updates
2023-03-23 13:26:16 -07:00
Jack Baldry ebb54aea8d
Fix website build errors both for Grafana and content mounted in Grafana Cloud (#64794)
* Fix reference to Grafana CLI

- Make relref for relative permalink
- Use relative path for unambiguous resolution

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

* Fix alerting relref anchor format

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

* Avoid ambiguous relref lookups by forcing relative resolution

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

* Remove reference to non-existent shared page

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

* Fix links broken in Grafana Cloud using absolute relrefs

By resolving the relref absolutely, it refers to the same location
regardless of mounted directory.

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

* Remove trailing slash for bundle independent resolution

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

* Fix typo

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

* For now, avoid Hugo checking cross repository /docs/grafana-cloud link

The path is unlikely to change in the short term and this makes CI
completely green for now.

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

* No need to specify path for in page anchors

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

* Fix prose

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

---------

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
Co-authored-by: Christopher Moyer <35463610+chri2547@users.noreply.github.com>
2023-03-15 17:06:31 +00:00
George Robinson 1898e76dd6
Docs: Last iteration on docs for images in notifications (#64392)
This commit includes some minor rephrasing to the Requirements and
Limitations of the Images in notification feature.
2023-03-09 09:59:25 +00:00
Gilles De Mey 6827f97b78
Docs: update the current documentation on notification policies (#64316)
Co-authored-by: Eve Meelan <81647476+Eve832@users.noreply.github.com>
2023-03-08 17:18:17 +01:00
George Robinson 9d9421154e
Docs: Update Images in notifications docs to be more readable and instructive (#64227) 2023-03-07 10:52:33 +00:00
Matt Dodson 0099b23291
Docs, update for american English spelling (#63331)
Docs, update for american english
2023-03-06 06:39:56 -06:00
George Robinson 18fec707fd
Docs: Fix numbering in templating docs (#63577) 2023-02-22 17:36:00 +00:00
George Robinson 740bcf64ce
Docs: Delete old templating notifications docs page (#63547) 2023-02-22 10:12:29 +00:00
George Robinson 85457156e3
Docs: Remove duplicate docs on images in notifications (#63474) 2023-02-20 12:58:04 -05:00
George Robinson 005f5ca1df
Alerting: Fix confusing comment about screenshots in default.ini and docs (#63346) 2023-02-20 09:59:45 +00:00
Santiago f43993d43f
Docs: Fix redaction error in notification policies docs (#63112)
fix redaction error in notification policies docs
2023-02-08 16:18:49 -03:00
Gilles De Mey 702fd0f9e8
Docs: Update wording / text and copy (#61868)
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
2023-01-30 15:26:21 +00:00
Armand Grillet 95f052bbd1
Add handleGrafanaManagedAlerts jsonData (#61874)
* Add handleGrafanaManagedAlerts jsonData

* Update following feedback
2023-01-26 10:48:51 +01:00
George Robinson d4256b352d
Docs: Rename Message templates to Notification templates (#59477)
This commit renames "Message templates" to "Notification templates"
in the user interface as it suggests that these templates cannot
be used to template anything other than the message. However, message
templates are much more general and can be used to template other fields
too such as the subject of an email, or the title of a Slack message.
2023-01-18 17:26:34 +00:00
gotjosh 8f72893076
Alerting: Document not supporting inhibition rules (#61313)
* Alerting: Document not supporting inhibition rules

* Update docs/sources/alerting/manage-notifications/create-silence.md

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

* Update docs/sources/alerting/manage-notifications/alertmanager.md

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

Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
2023-01-13 15:06:06 +01:00
George Robinson fa9f1c3a52
Docs: Re-order nav for Manage your alert notifications (#60897) 2023-01-11 08:44:01 +00:00
George Robinson 35ad9e23ce
Docs: Update weights for Customize notifications without changing the order of pages (#60898) 2023-01-10 11:07:00 +00:00
melGL fc91baa2f8
Alerting Docs: Clarify feature flag for Grafana Cloud users (#57637)
Docs: Clarify feature flag for Grafana Cloud

Images in Alerts requires a feature flag for hosted Grafana instances. This change directs users to contact Support for access to this feature.
2023-01-04 10:57:58 +00:00
George Robinson 1a442de094
Docs: Rephrase opening sentence for Customize notifications (#60560) 2022-12-21 10:51:02 +00:00
Santiago d070032065
Alerting: Fix incorrect links/aliases to template docs (#60597) 2022-12-20 22:38:01 +01:00
brendamuir 620cc52863
Fixes Alertmanager links (#60591) 2022-12-20 17:09:34 +00:00
George Robinson 5d4e35c3d5
Docs: Fix links in Using Go's templating language (#60564) 2022-12-20 12:30:43 +00:00