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

1.4 KiB

Raw Blame History

aliases

canonical

keywords

title

weight

inbound-email/

https://grafana.com/docs/oncall/latest/integrations/available-integrations/configure-inbound-email/

Grafana Cloud

Alerts

Notifications

on-call

Inbound Email

500

Inbound Email integration for Grafana OnCall

Inbound Email integration will consume emails from dedicated email address and make alert groups from them.

Configure Inbound Email integration for Grafana OnCall

You must have an Admin role to create integrations in Grafana OnCall.

In the Integrations tab, click + New integration to receive alerts.
Select Inbound Email from the list of available integrations.
Get your dedicated email address in the Integration email section and use it to send your emails.

Grouping and auto-resolve

Alert groups will be grouped by email subject and auto-resolved if the email message text equals "OK". This behaviour can be modified via [custom templates][jinja2-templating].

Alerts from Inbound Email integration have the following payload:

{
   "subject": "<your_email_subject>",
   "message": "<your_email_message>",
   "sender": "<your_email_sender_address>"
}

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

1.4 KiB Raw Blame History

Inbound Email integration for Grafana OnCall

Configure Inbound Email integration for Grafana OnCall

Grouping and auto-resolve

1.4 KiB

Raw Blame History