Update all links to use docs/reference style (#2456 )

# What this PR does

The `docs/reference` shortcode supports contextual destinations and
version inference.

`<ONCALL VERSION>` is inferred to match the version of the documentation
set. For example, the inferred version for the page
/docs/grafana/oncall/latest/get-started/ is "latest". It can also be
overriden using front matter.
Given the same page, but with the additional front matter
`oncall_version: next`, the variable is substituted with "next" rather
than "latest".

Contextual destinations are achieved using repeated labels in the
shortcode inner text. The format is [<LABEL>]: "<PAGE PATH PREFIX> ->
<HUGO REFERENCE>".

- _`<LABEL>`_ matches the reference style link label used in the rest of
the text.
- _`<PAGE PATH PREFIX>`_ is matched against the page during the
production build. If the match is successful, the destination that is
used is _`<HUGO REFERENCE>`_. The first matching prefix is used, not the
longest matching prefix.

## Which issue(s) this PR fixes

- Broken links due to ambiguous relref resolution. Any relref parameter
that does not start with either `/`, `./`, or `../` can resolve
ambiguously and is resulting in broken link behavior on the current
site.
- Broken links in Grafana Cloud. We mount OnCall documentation in
Grafana Cloud. In https://github.com/grafana/website/pull/13872 the
location will become /docs/grafana-cloud/alerting-and-irm/oncall. This
PR is intended to be merged alongside that PR.

---------

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
Co-authored-by: Joey Orlando <joey.orlando@grafana.com>

2023-07-13 14:38:35 +00:00

2.1 KiB

Raw Blame History

aliases

canonical

keywords

title

weight

../notify/

/docs/oncall/latest/notify/

https://grafana.com/docs/oncall/latest/notify/

Grafana Cloud

Alerts

Notifications

on-call

amixr

oncall

slack

Notify people

800

Notify people

Grafana OnCall directly supports the export of alert notifications to some popular messaging applications like Slack and Telegram. You can use [outgoing webhooks][outgoing-webhooks] for applications that aren't directly supported.

To configure supported messaging apps, see the following topics:

Configure user notification policies

Notification policies are a configurable set of notification steps that determine how you're notified of alert in OnCall. Users with the Admin or Editor role are able to receive notifications. Users can verify phone numbers and email addresses in the Users tab of Grafana OnCall.

Default Notifications dictate how a user is notified for most escalation thresholds.
Important Notifications are labeled in escalation chains. If an escalation event is marked as an important notification, it will bypass Default Notification settings and notify the user by the method specified.

NOTE: You cannot add users or manage permissions in Grafana OnCall. User settings are found on the organizational level of your Grafana instance in Configuration > Users.

To configure a users notification policy:

Navigate to the Users tab of Grafana OnCall and search for or select a user.
Click Edit to the right of a user to open the User Info window.
Verify that there is a valid and verified phone number, along with ChatOps accounts in order to receive notifications via those methods.
Click Add notification step and use the dropdowns to specify the notification method and frequency. Notification steps will be followed in the order they are listed.

{{% docs/reference %}} [outgoing-webhooks]: "/docs/oncall/ -> /docs/oncall//outgoing-webhooks" [outgoing-webhooks]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/alerting-and-irm/oncall/outgoing-webhooks" {{% /docs/reference %}}

2.1 KiB Raw Blame History

Notify people

Configure user notification policies

2.1 KiB

Raw Blame History