Commit Graph

41 Commits

Author SHA1 Message Date
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
George Robinson
d7b555c405
Docs: Remove old message templates documentation (#60548) 2022-12-20 08:23:42 +00:00
George Robinson
f6aea16894
Docs: Templating notifications (#60109)
* Docs: Templating notifications

* Feedback

* More feedback

* Edit template notifications

* More edits

* Fix typo

Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
Co-authored-by: Armand Grillet <2117580+armandgrillet@users.noreply.github.com>
2022-12-19 15:01:18 +00:00
George Robinson
342b0f3668
Alerting: Rename contact point type to receiver in the user interface (#59589)
This commit renames contact point type to integration in the user interface
as "New contact point type" suggests that you are creating a new type,
when instead you are just creating a new integration of a pre-determined type,
such as email or Slack. You can also have two or more integrations of the same
type, something which is not apparent from the current text.

This change will also make it easier to explain the difference between
a contact point integration, and how to configure an integration of a certain type,
such as email.
2022-12-14 20:50:36 +00:00
Jack Baldry
c1c48dd610
Use relative aliases for all non-current Grafana aliases (#60062)
* Use relative aliases for all non-current Grafana aliases

Prevents non-latest documentation "stealing" the page away from latest
and through permanent redirects for latest pages that no longer exist.

The redirected pages are indexed by search engines but our robots.txt
forbids them crawling the non-latest page.

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

* Remove aliases from shared pages

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

* Rewrite all current latest aliases to be next

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

* Fix typo in latest alias

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

* Remove all current page aliases

find docs/sources -type f -name '*.md' -exec sed -z -i 's#\n *- /docs/grafana/next/[^\n]*\n#\n#' {} \;
find docs/sources -type f -name '*.md' -exec sed -Ez -i 's#\n((aliases:\n *-)|aliases:\n)#\n\2#' {} \;

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

* Prettier

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

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
2022-12-09 12:36:04 -04:00
George Robinson
311e1e56f2
Docs: Reference Alertmanagers in Notifications docs and move Alertmanager docs (#59673) 2022-12-02 09:41:01 +00:00
George Robinson
0af3515e95
Docs: Improve docs for images in notifications (#59033) 2022-11-28 14:11:00 +00:00
George Robinson
2f878acd9d
Alerting: Add Troubleshooting to Images in notifications docs (#58955) 2022-11-21 11:21:59 +00:00
George Robinson
4da97aef7d
Alerting: Fix metric in Images in Notifications docs (#58954) 2022-11-18 16:28:00 +00:00
gotjosh
d748979048
Alerting: Implement the Webex notifier (#58480)
* Alerting: Implement the Webex notifier

Closes https://github.com/grafana/grafana/issues/11750

Signed-off-by: gotjosh <josue.abreu@gmail.com>
2022-11-11 17:27:13 +00:00
brendamuir
f1b6660b54
Docs: fixes alias (#58060)
* Docs: fixes alias

* adds file ext
2022-11-02 17:00:26 -04:00
brendamuir
f34dd29ac4
Docs: adds view notification errors topic (#57820) 2022-10-28 12:44:23 +01:00
brendamuir
5edd511461
Docs: fixes alerting links (#57805)
* Docs: fixes alerting links

* fixes grafana relrefs to alerting

* changing GA to Alerting
2022-10-28 10:01:43 +01:00
brendamuir
f9d2801249
Docs: alerting refactor (#57804)
* Docs: alerting refactor

* fixes broken relrefs
2022-10-28 09:58:39 +02:00
brendamuir
998093a280
Docs: more refactoring for alerting (#57741)
* docs: more refactoring alerting

* performance limitations

* typo

* fix relrefs
2022-10-27 13:21:02 +01:00
brendamuir
279ac50d59
Docs: refactors notifications in alerting (#57734)
* Refactors noticifacations section

* adds hover over error icon detail
2022-10-27 11:19:03 +01:00
brendamuir
596b4fecb0
Docs: Refactors notifications in alerting (#57653)
* Refactors notifications in alerting

* Fixes broken links

* adds headings

* fixes broken links

* Adds line space and intro sentences
2022-10-26 19:07:49 +01:00