Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[v10.3.x] Replace docs/reference shortcode with ref URIs #88050

Closed
wants to merge 3 commits into from

Conversation

jdbaldry
Copy link
Member

You can use ref URIs in admonitions (or any shortcodes) because they are inline and not subject to the issues noted in the admonition shortcode.

The ref URIs perform the same pattern matching as docs/reference but don't require the use of reference-style links and the destinations are ordinary (full) URLs that can include version substitution. Unlike docs/reference, the implementation doesn't use relref so you don't have to be careful with omitting trailing slashes and the links will follow redirects.

Documentation: https://grafana.com/docs/writers-toolkit/write/links/#link-from-source-content-thats-used-in-multiple-projects

To check the links, refer to the deploy preview in https://github.com/grafana/website/pull/19630.

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

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
@grafana-delivery-bot grafana-delivery-bot bot added this to the 10.3.x milestone May 20, 2024
Copy link
Contributor

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remaining comments which cannot be posted as a review comment to avoid GitHub Rate Limit

doc-validator

docs/sources/alerting/fundamentals/annotation-label/_index.md|54 col 81| The link to the project page 'ref:variables-label-annotation' is invalid.
Links to project pages must use a Hugo relref shortcode like {{< relref "./path/to/page" >}}.

Links to project assets must be made from a bundle (index.md or _index.md file).
The asset must be contained within the bundle directory, it must have an extension, and must not have the extension .md.
docs/sources/alerting/fundamentals/annotation-label/how-to-use-labels.md|37 col 28| The link to the project page 'ref:alerting-rules' is invalid.
Links to project pages must use a Hugo relref shortcode like {{< relref "./path/to/page" >}}.

Links to project assets must be made from a bundle (index.md or _index.md file).
The asset must be contained within the bundle directory, it must have an extension, and must not have the extension .md.
docs/sources/alerting/fundamentals/annotation-label/how-to-use-labels.md|59 col 122| The link to the project page 'ref:unified-alerting-reserved-labels' is invalid.
Links to project pages must use a Hugo relref shortcode like {{< relref "./path/to/page" >}}.

Links to project assets must be made from a bundle (index.md or _index.md file).
The asset must be contained within the bundle directory, it must have an extension, and must not have the extension .md.
docs/sources/alerting/fundamentals/annotation-label/variables-label-annotation.md|299 col 68| The link to the project page 'ref:explore' is invalid.
Links to project pages must use a Hugo relref shortcode like {{< relref "./path/to/page" >}}.

Links to project assets must be made from a bundle (index.md or _index.md file).
The asset must be contained within the bundle directory, it must have an extension, and must not have the extension .md.
docs/sources/alerting/fundamentals/annotation-label/variables-label-annotation.md|395 col 66| The link to the project page 'ref:explore' is invalid.
Links to project pages must use a Hugo relref shortcode like {{< relref "./path/to/page" >}}.

Links to project assets must be made from a bundle (index.md or _index.md file).
The asset must be contained within the bundle directory, it must have an extension, and must not have the extension .md.
docs/sources/alerting/fundamentals/data-source-alerting.md|109 col 3| The link to the project page 'ref:aws-cloudwatch' is invalid.
Links to project pages must use a Hugo relref shortcode like {{< relref "./path/to/page" >}}.

Links to project assets must be made from a bundle (index.md or _index.md file).
The asset must be contained within the bundle directory, it must have an extension, and must not have the extension .md.
docs/sources/alerting/fundamentals/data-source-alerting.md|110 col 3| The link to the project page 'ref:azure-monitor' is invalid.
Links to project pages must use a Hugo relref shortcode like {{< relref "./path/to/page" >}}.

Links to project assets must be made from a bundle (index.md or _index.md file).
The asset must be contained within the bundle directory, it must have an extension, and must not have the extension .md.
docs/sources/alerting/fundamentals/data-source-alerting.md|111 col 3| The link to the project page 'ref:elasticsearch' is invalid.
Links to project pages must use a Hugo relref shortcode like {{< relref "./path/to/page" >}}.

Links to project assets must be made from a bundle (index.md or _index.md file).
The asset must be contained within the bundle directory, it must have an extension, and must not have the extension .md.
docs/sources/alerting/fundamentals/data-source-alerting.md|112 col 3| The link to the project page 'ref:google-cloud-monitoring' is invalid.
Links to project pages must use a Hugo relref shortcode like {{< relref "./path/to/page" >}}.

Links to project assets must be made from a bundle (index.md or _index.md file).
The asset must be contained within the bundle directory, it must have an extension, and must not have the extension .md.
docs/sources/alerting/fundamentals/data-source-alerting.md|113 col 3| The link to the project page 'ref:graphite' is invalid.
Links to project pages must use a Hugo relref shortcode like {{< relref "./path/to/page" >}}.

Links to project assets must be made from a bundle (index.md or _index.md file).
The asset must be contained within the bundle directory, it must have an extension, and must not have the extension .md.
docs/sources/alerting/fundamentals/data-source-alerting.md|114 col 3| The link to the project page 'ref:influxdb' is invalid.
Links to project pages must use a Hugo relref shortcode like {{< relref "./path/to/page" >}}.

Links to project assets must be made from a bundle (index.md or _index.md file).
The asset must be contained within the bundle directory, it must have an extension, and must not have the extension .md.
docs/sources/alerting/fundamentals/data-source-alerting.md|115 col 3| The link to the project page 'ref:loki' is invalid.
Links to project pages must use a Hugo relref shortcode like {{< relref "./path/to/page" >}}.

Links to project assets must be made from a bundle (index.md or _index.md file).
The asset must be contained within the bundle directory, it must have an extension, and must not have the extension .md.
docs/sources/alerting/fundamentals/data-source-alerting.md|116 col 3| The link to the project page 'ref:microsoft-sql-server-(mssql)' is invalid.
Links to project pages must use a Hugo relref shortcode like {{< relref "./path/to/page" >}}.

Links to project assets must be made from a bundle (index.md or _index.md file).
The asset must be contained within the bundle directory, it must have an extension, and must not have the extension .md.
docs/sources/alerting/fundamentals/data-source-alerting.md|117 col 3| The link to the project page 'ref:mysql' is invalid.
Links to project pages must use a Hugo relref shortcode like {{< relref "./path/to/page" >}}.

Links to project assets must be made from a bundle (index.md or _index.md file).
The asset must be contained within the bundle directory, it must have an extension, and must not have the extension .md.
docs/sources/alerting/fundamentals/data-source-alerting.md|118 col 3| The link to the project page 'ref:open-tsdb' is invalid.
Links to project pages must use a Hugo relref shortcode like {{< relref "./path/to/page" >}}.

Links to project assets must be made from a bundle (index.md or _index.md file).
The asset must be contained within the bundle directory, it must have an extension, and must not have the extension .md.
docs/sources/alerting/fundamentals/data-source-alerting.md|119 col 3| The link to the project page 'ref:postgresql' is invalid.
Links to project pages must use a Hugo relref shortcode like {{< relref "./path/to/page" >}}.

Links to project assets must be made from a bundle (index.md or _index.md file).
The asset must be contained within the bundle directory, it must have an extension, and must not have the extension .md.
docs/sources/alerting/fundamentals/data-source-alerting.md|120 col 3| The link to the project page 'ref:prometheus' is invalid.
Links to project pages must use a Hugo relref shortcode like {{< relref "./path/to/page" >}}.

Links to project assets must be made from a bundle (index.md or _index.md file).
The asset must be contained within the bundle directory, it must have an extension, and must not have the extension .md.
docs/sources/alerting/fundamentals/data-source-alerting.md|121 col 3| The link to the project page 'ref:jaeger' is invalid.
Links to project pages must use a Hugo relref shortcode like {{< relref "./path/to/page" >}}.

Links to project assets must be made from a bundle (index.md or _index.md file).
The asset must be contained within the bundle directory, it must have an extension, and must not have the extension .md.
docs/sources/alerting/fundamentals/data-source-alerting.md|122 col 3| The link to the project page 'ref:zipkin' is invalid.
Links to project pages must use a Hugo relref shortcode like {{< relref "./path/to/page" >}}.

Links to project assets must be made from a bundle (index.md or _index.md file).
The asset must be contained within the bundle directory, it must have an extension, and must not have the extension .md.
docs/sources/alerting/fundamentals/data-source-alerting.md|123 col 3| The link to the project page 'ref:tempo' is invalid.
Links to project pages must use a Hugo relref shortcode like {{< relref "./path/to/page" >}}.

Links to project assets must be made from a bundle (index.md or _index.md file).
The asset must be contained within the bundle directory, it must have an extension, and must not have the extension .md.
docs/sources/alerting/fundamentals/data-source-alerting.md|124 col 3| The link to the project page 'ref:testdata' is invalid.
Links to project pages must use a Hugo relref shortcode like {{< relref "./path/to/page" >}}.

Links to project assets must be made from a bundle (index.md or _index.md file).
The asset must be contained within the bundle directory, it must have an extension, and must not have the extension .md.
docs/sources/alerting/fundamentals/data-source-alerting.md|128 col 3| The link to the project page 'ref:grafana-data-sources' is invalid.
Links to project pages must use a Hugo relref shortcode like {{< relref "./path/to/page" >}}.

Links to project assets must be made from a bundle (index.md or _index.md file).
The asset must be contained within the bundle directory, it must have an extension, and must not have the extension .md.
docs/sources/alerting/fundamentals/evaluate-grafana-alerts.md|43 col 35| The link to the project page 'ref:set-up-grafana-monitoring' is invalid.
Links to project pages must use a Hugo relref shortcode like {{< relref "./path/to/page" >}}.

Links to project assets must be made from a bundle (index.md or _index.md file).
The asset must be contained within the bundle directory, it must have an extension, and must not have the extension .md.
docs/sources/alerting/fundamentals/high-availability/_index.md|40 col 120| The link to the project page 'ref:configure-high-availability' is invalid.
Links to project pages must use a Hugo relref shortcode like {{< relref "./path/to/page" >}}.

Links to project assets must be made from a bundle (index.md or _index.md file).
The asset must be contained within the bundle directory, it must have an extension, and must not have the extension .md.
docs/sources/alerting/fundamentals/high-availability/_index.md|44 col 1| The link to the project page 'ref:configure-high-availability' is invalid.
Links to project pages must use a Hugo relref shortcode like {{< relref "./path/to/page" >}}.

Links to project assets must be made from a bundle (index.md or _index.md file).
The asset must be contained within the bundle directory, it must have an extension, and must not have the extension .md.
docs/sources/alerting/fundamentals/notification-policies/notifications.md|41 col 45| The link to the project page 'ref:labels-and-label-matchers' is invalid.
Links to project pages must use a Hugo relref shortcode like {{< relref "./path/to/page" >}}.

Links to project assets must be made from a bundle (index.md or _index.md file).
The asset must be contained within the bundle directory, it must have an extension, and must not have the extension .md.
docs/sources/alerting/manage-notifications/_index.md|48 col 1| The link to the project page 'ref:create-silence' is invalid.
Links to project pages must use a Hugo relref shortcode like {{< relref "./path/to/page" >}}.

Links to project assets must be made from a bundle (index.md or _index.md file).
The asset must be contained within the bundle directory, it must have an extension, and must not have the extension .md.
docs/sources/alerting/manage-notifications/_index.md|50 col 1| The link to the project page 'ref:mute-timings' is invalid.
Links to project pages must use a Hugo relref shortcode like {{< relref "./path/to/page" >}}.

Links to project assets must be made from a bundle (index.md or _index.md file).
The asset must be contained within the bundle directory, it must have an extension, and must not have the extension .md.
docs/sources/alerting/manage-notifications/_index.md|52 col 1| The link to the project page 'ref:declare-incident-from-firing-alert' is invalid.
Links to project pages must use a Hugo relref shortcode like {{< relref "./path/to/page" >}}.

Links to project assets must be made from a bundle (index.md or _index.md file).
The asset must be contained within the bundle directory, it must have an extension, and must not have the extension .md.
docs/sources/alerting/manage-notifications/_index.md|54 col 1| The link to the project page 'ref:view-state-health' is invalid.
Links to project pages must use a Hugo relref shortcode like {{< relref "./path/to/page" >}}.

Links to project assets must be made from a bundle (index.md or _index.md file).
The asset must be contained within the bundle directory, it must have an extension, and must not have the extension .md.
docs/sources/alerting/manage-notifications/_index.md|56 col 1| The link to the project page 'ref:view-alert-rules' is invalid.
Links to project pages must use a Hugo relref shortcode like {{< relref "./path/to/page" >}}.

Links to project assets must be made from a bundle (index.md or _index.md file).
The asset must be contained within the bundle directory, it must have an extension, and must not have the extension .md.
docs/sources/alerting/manage-notifications/images-in-notifications.md|47 col 66| The link to the project page 'ref:image-rendering' is invalid.
Links to project pages must use a Hugo relref shortcode like {{< relref "./path/to/page" >}}.

Links to project assets must be made from a bundle (index.md or _index.md file).
The asset must be contained within the bundle directory, it must have an extension, and must not have the extension .md.
docs/sources/alerting/manage-notifications/images-in-notifications.md|49 col 50| The link to the project page 'ref:paths' is invalid.
Links to project pages must use a Hugo relref shortcode like {{< relref "./path/to/page" >}}.

Links to project assets must be made from a bundle (index.md or _index.md file).
The asset must be contained within the bundle directory, it must have an extension, and must not have the extension .md.
docs/sources/alerting/manage-notifications/images-in-notifications.md|83 col 24| The link to the project page 'ref:image-rendering' is invalid.
Links to project pages must use a Hugo relref shortcode like {{< relref "./path/to/page" >}}.

Links to project assets must be made from a bundle (index.md or _index.md file).
The asset must be contained within the bundle directory, it must have an extension, and must not have the extension .md.
docs/sources/alerting/manage-notifications/mute-timings.md|40 col 79| The link to the project page 'ref:datasources/alertmanager' is invalid.
Links to project pages must use a Hugo relref shortcode like {{< relref "./path/to/page" >}}.

Links to project assets must be made from a bundle (index.md or _index.md file).
The asset must be contained within the bundle directory, it must have an extension, and must not have the extension .md.
docs/sources/alerting/manage-notifications/mute-timings.md|40 col 177| The link to the project page 'ref:fundamentals/alertmanager' is invalid.
Links to project pages must use a Hugo relref shortcode like {{< relref "./path/to/page" >}}.

Links to project assets must be made from a bundle (index.md or _index.md file).
The asset must be contained within the bundle directory, it must have an extension, and must not have the extension .md.
docs/sources/alerting/manage-notifications/template-notifications/_index.md|54 col 94| The link to the project page 'ref:using-go-templating-language' is invalid.
Links to project pages must use a Hugo relref shortcode like {{< relref "./path/to/page" >}}.

Links to project assets must be made from a bundle (index.md or _index.md file).
The asset must be contained within the bundle directory, it must have an extension, and must not have the extension .md.
docs/sources/alerting/manage-notifications/template-notifications/_index.md|62 col 1| The link to the project page 'ref:use-notification-templates' is invalid.
Links to project pages must use a Hugo relref shortcode like {{< relref "./path/to/page" >}}.

Links to project assets must be made from a bundle (index.md or _index.md file).
The asset must be contained within the bundle directory, it must have an extension, and must not have the extension .md.
docs/sources/alerting/manage-notifications/template-notifications/_index.md|66 col 1| The link to the project page 'ref:reference' is invalid.
Links to project pages must use a Hugo relref shortcode like {{< relref "./path/to/page" >}}.

Links to project assets must be made from a bundle (index.md or _index.md file).
The asset must be contained within the bundle directory, it must have an extension, and must not have the extension .md.
docs/sources/alerting/manage-notifications/template-notifications/use-notification-templates.md|44 col 2| The link to the project page 'ref:using-go-templating-language' is invalid.
Links to project pages must use a Hugo relref shortcode like {{< relref "./path/to/page" >}}.

Links to project assets must be made from a bundle (index.md or _index.md file).
The asset must be contained within the bundle directory, it must have an extension, and must not have the extension .md.
docs/sources/alerting/manage-notifications/template-notifications/use-notification-templates.md|44 col 144| The link to the project page 'ref:create-notification-templates' is invalid.
Links to project pages must use a Hugo relref shortcode like {{< relref "./path/to/page" >}}.

Links to project assets must be made from a bundle (index.md or _index.md file).
The asset must be contained within the bundle directory, it must have an extension, and must not have the extension .md.
docs/sources/alerting/manage-notifications/template-notifications/using-go-templating-language.md|43 col 271| The link to the project page 'ref:extendeddata' is invalid.
Links to project pages must use a Hugo relref shortcode like {{< relref "./path/to/page" >}}.

Links to project assets must be made from a bundle (index.md or _index.md file).
The asset must be contained within the bundle directory, it must have an extension, and must not have the extension .md.
docs/sources/alerting/manage-notifications/template-notifications/using-go-templating-language.md|43 col 640| The link to the project page 'ref:create-notification-templates' is invalid.
Links to project pages must use a Hugo relref shortcode like {{< relref "./path/to/page" >}}.

Links to project assets must be made from a bundle (index.md or _index.md file).
The asset must be contained within the bundle directory, it must have an extension, and must not have the extension .md.
docs/sources/alerting/manage-notifications/template-notifications/using-go-templating-language.md|43 col 742| The link to the project page 'ref:reference' is invalid.
Links to project pages must use a Hugo relref shortcode like {{< relref "./path/to/page" >}}.

Links to project assets must be made from a bundle (index.md or _index.md file).
The asset must be contained within the bundle directory, it must have an extension, and must not have the extension .md.
docs/sources/alerting/set-up/_index.md|50 col 18| The link to the project page 'ref:data-source-management' is invalid.
Links to project pages must use a Hugo relref shortcode like {{< relref "./path/to/page" >}}.

Links to project assets must be made from a bundle (index.md or _index.md file).
The asset must be contained within the bundle directory, it must have an extension, and must not have the extension .md.
docs/sources/alerting/set-up/_index.md|51 col 65| The link to the project page 'ref:data-source-alerting' is invalid.
Links to project pages must use a Hugo relref shortcode like {{< relref "./path/to/page" >}}.

Links to project assets must be made from a bundle (index.md or _index.md file).
The asset must be contained within the bundle directory, it must have an extension, and must not have the extension .md.
docs/sources/alerting/set-up/_index.md|87 col 3| The link to the project page 'ref:terraform-provisioning' is invalid.
Links to project pages must use a Hugo relref shortcode like {{< relref "./path/to/page" >}}.

Links to project assets must be made from a bundle (index.md or _index.md file).
The asset must be contained within the bundle directory, it must have an extension, and must not have the extension .md.
docs/sources/alerting/set-up/_index.md|88 col 3| The link to the project page 'ref:configure-alertmanager' is invalid.
Links to project pages must use a Hugo relref shortcode like {{< relref "./path/to/page" >}}.

Links to project assets must be made from a bundle (index.md or _index.md file).
The asset must be contained within the bundle directory, it must have an extension, and must not have the extension .md.
docs/sources/alerting/set-up/_index.md|89 col 3| The link to the project page 'ref:configure-high-availability' is invalid.
Links to project pages must use a Hugo relref shortcode like {{< relref "./path/to/page" >}}.

Links to project assets must be made from a bundle (index.md or _index.md file).
The asset must be contained within the bundle directory, it must have an extension, and must not have the extension .md.
docs/sources/alerting/set-up/migrating-alerts/_index.md|194 col 4| The link to the project page 'ref:alerting_config_error_handling' is invalid.
Links to project pages must use a Hugo relref shortcode like {{< relref "./path/to/page" >}}.

Links to project assets must be made from a bundle (index.md or _index.md file).
The asset must be contained within the bundle directory, it must have an extension, and must not have the extension .md.
docs/sources/alerting/set-up/migrating-alerts/_index.md|194 col 369| The link to the project page 'ref:special_alert' is invalid.
Links to project pages must use a Hugo relref shortcode like {{< relref "./path/to/page" >}}.

Links to project assets must be made from a bundle (index.md or _index.md file).
The asset must be contained within the bundle directory, it must have an extension, and must not have the extension .md.
docs/sources/alerting/set-up/migrating-alerts/_index.md|195 col 4| The link to the project page 'ref:alerting_config_error_handling' is invalid.
Links to project pages must use a Hugo relref shortcode like {{< relref "./path/to/page" >}}.

Links to project assets must be made from a bundle (index.md or _index.md file).
The asset must be contained within the bundle directory, it must have an extension, and must not have the extension .md.
docs/sources/alerting/set-up/migrating-alerts/legacy-alerting-deprecation.md|40 col 18| The link to the project page 'ref:migrating-alerts' is invalid.
Links to project pages must use a Hugo relref shortcode like {{< relref "./path/to/page" >}}.

Links to project assets must be made from a bundle (index.md or _index.md file).
The asset must be contained within the bundle directory, it must have an extension, and must not have the extension .md.
docs/sources/alerting/set-up/migrating-alerts/legacy-alerting-deprecation.md|50 col 77| The link to the project page 'ref:angular_deprecation' is invalid.
Links to project pages must use a Hugo relref shortcode like {{< relref "./path/to/page" >}}.

Links to project assets must be made from a bundle (index.md or _index.md file).
The asset must be contained within the bundle directory, it must have an extension, and must not have the extension .md.
docs/sources/alerting/set-up/migrating-alerts/legacy-alerting-deprecation.md|54 col 102| The link to the project page 'ref:angular_deprecation' is invalid.
Links to project pages must use a Hugo relref shortcode like {{< relref "./path/to/page" >}}.

Links to project assets must be made from a bundle (index.md or _index.md file).
The asset must be contained within the bundle directory, it must have an extension, and must not have the extension .md.
docs/sources/alerting/set-up/migrating-alerts/legacy-alerting-deprecation.md|58 col 14| The link to the project page 'ref:migrating-alerts' is invalid.
Links to project pages must use a Hugo relref shortcode like {{< relref "./path/to/page" >}}.

Links to project assets must be made from a bundle (index.md or _index.md file).
The asset must be contained within the bundle directory, it must have an extension, and must not have the extension .md.
docs/sources/alerting/set-up/migrating-alerts/legacy-alerting-deprecation.md|62 col 3| The link to the project page 'ref:migrating-alerts' is invalid.
Links to project pages must use a Hugo relref shortcode like {{< relref "./path/to/page" >}}.

Links to project assets must be made from a bundle (index.md or _index.md file).
The asset must be contained within the bundle directory, it must have an extension, and must not have the extension .md.
docs/sources/alerting/set-up/migrating-alerts/legacy-alerting-deprecation.md|63 col 3| The link to the project page 'ref:angular_deprecation' is invalid.
Links to project pages must use a Hugo relref shortcode like {{< relref "./path/to/page" >}}.

Links to project assets must be made from a bundle (index.md or _index.md file).
The asset must be contained within the bundle directory, it must have an extension, and must not have the extension .md.
docs/sources/alerting/set-up/provision-alerting-resources/_index.md|65 col 8| The link to the project page 'ref:alerting_tf_provisioning' is invalid.
Links to project pages must use a Hugo relref shortcode like {{< relref "./path/to/page" >}}.

Links to project assets must be made from a bundle (index.md or _index.md file).
The asset must be contained within the bundle directory, it must have an extension, and must not have the extension .md.
docs/sources/alerting/set-up/provision-alerting-resources/_index.md|67 col 12| The link to the project page 'ref:alerting_http_provisioning' is invalid.
Links to project pages must use a Hugo relref shortcode like {{< relref "./path/to/page" >}}.

Links to project assets must be made from a bundle (index.md or _index.md file).
The asset must be contained within the bundle directory, it must have an extension, and must not have the extension .md.
docs/sources/alerting/set-up/provision-alerting-resources/_index.md|76 col 105| The link to the project page 'ref:alerting_export' is invalid.
Links to project pages must use a Hugo relref shortcode like {{< relref "./path/to/page" >}}.

Links to project assets must be made from a bundle (index.md or _index.md file).
The asset must be contained within the bundle directory, it must have an extension, and must not have the extension .md.
docs/sources/alerting/set-up/provision-alerting-resources/_index.md|92 col 1| The link to the project page 'ref:provisioning' is invalid.
Links to project pages must use a Hugo relref shortcode like {{< relref "./path/to/page" >}}.

Links to project assets must be made from a bundle (index.md or _index.md file).
The asset must be contained within the bundle directory, it must have an extension, and must not have the extension .md.
docs/sources/alerting/set-up/provision-alerting-resources/export-alerting-resources/index.md|61 col 83| The link to the project page 'ref:alerting_tf_provisioning' is invalid.
Links to project pages must use a Hugo relref shortcode like {{< relref "./path/to/page" >}}.

Links to project assets must be made from a bundle (index.md or _index.md file).
The asset must be contained within the bundle directory, it must have an extension, and must not have the extension .md.
docs/sources/alerting/set-up/provision-alerting-resources/export-alerting-resources/index.md|113 col 79| The link to the project page 'ref:export_rule' is invalid.
Links to project pages must use a Hugo relref shortcode like {{< relref "./path/to/page" >}}.

Links to project assets must be made from a bundle (index.md or _index.md file).
The asset must be contained within the bundle directory, it must have an extension, and must not have the extension .md.
docs/sources/alerting/set-up/provision-alerting-resources/export-alerting-resources/index.md|114 col 79| The link to the project page 'ref:export_rule_group' is invalid.
Links to project pages must use a Hugo relref shortcode like {{< relref "./path/to/page" >}}.

Links to project assets must be made from a bundle (index.md or _index.md file).
The asset must be contained within the bundle directory, it must have an extension, and must not have the extension .md.
docs/sources/alerting/set-up/provision-alerting-resources/export-alerting-resources/index.md|115 col 79| The link to the project page 'ref:export_rules' is invalid.
Links to project pages must use a Hugo relref shortcode like {{< relref "./path/to/page" >}}.

Links to project assets must be made from a bundle (index.md or _index.md file).
The asset must be contained within the bundle directory, it must have an extension, and must not have the extension .md.
docs/sources/alerting/set-up/provision-alerting-resources/export-alerting-resources/index.md|116 col 79| The link to the project page 'ref:export_contacts' is invalid.
Links to project pages must use a Hugo relref shortcode like {{< relref "./path/to/page" >}}.

Links to project assets must be made from a bundle (index.md or _index.md file).
The asset must be contained within the bundle directory, it must have an extension, and must not have the extension .md.
docs/sources/alerting/set-up/provision-alerting-resources/export-alerting-resources/index.md|117 col 79| The link to the project page 'ref:export_notifications' is invalid.
Links to project pages must use a Hugo relref shortcode like {{< relref "./path/to/page" >}}.

Links to project assets must be made from a bundle (index.md or _index.md file).
The asset must be contained within the bundle directory, it must have an extension, and must not have the extension .md.
docs/sources/alerting/set-up/provision-alerting-resources/file-provisioning/index.md|40 col 75| The link to the project page 'ref:provisioning' is invalid.
Links to project pages must use a Hugo relref shortcode like {{< relref "./path/to/page" >}}.

Links to project assets must be made from a bundle (index.md or _index.md file).
The asset must be contained within the bundle directory, it must have an extension, and must not have the extension .md.
docs/sources/alerting/set-up/provision-alerting-resources/file-provisioning/index.md|56 col 4| The link to the project page 'ref:alerting_export' is invalid.
Links to project pages must use a Hugo relref shortcode like {{< relref "./path/to/page" >}}.

Links to project assets must be made from a bundle (index.md or _index.md file).
The asset must be contained within the bundle directory, it must have an extension, and must not have the extension .md.
docs/sources/alerting/set-up/provision-alerting-resources/file-provisioning/index.md|154 col 4| The link to the project page 'ref:alerting_export' is invalid.
Links to project pages must use a Hugo relref shortcode like {{< relref "./path/to/page" >}}.

Links to project assets must be made from a bundle (index.md or _index.md file).
The asset must be contained within the bundle directory, it must have an extension, and must not have the extension .md.
docs/sources/alerting/set-up/provision-alerting-resources/file-provisioning/index.md|593 col 4| The link to the project page 'ref:alerting_export' is invalid.
Links to project pages must use a Hugo relref shortcode like {{< relref "./path/to/page" >}}.

Links to project assets must be made from a bundle (index.md or _index.md file).
The asset must be contained within the bundle directory, it must have an extension, and must not have the extension .md.
docs/sources/alerting/set-up/provision-alerting-resources/file-provisioning/index.md|820 col 1| The link to the project page 'ref:provisioning' is invalid.
Links to project pages must use a Hugo relref shortcode like {{< relref "./path/to/page" >}}.

Links to project assets must be made from a bundle (index.md or _index.md file).
The asset must be contained within the bundle directory, it must have an extension, and must not have the extension .md.
docs/sources/alerting/set-up/provision-alerting-resources/terraform-provisioning/index.md|58 col 49| The link to the project page 'ref:alerting_export' is invalid.
Links to project pages must use a Hugo relref shortcode like {{< relref "./path/to/page" >}}.

Links to project assets must be made from a bundle (index.md or _index.md file).
The asset must be contained within the bundle directory, it must have an extension, and must not have the extension .md.
docs/sources/alerting/set-up/provision-alerting-resources/terraform-provisioning/index.md|72 col 18| The link to the project page 'ref:service-accounts' is invalid.
Links to project pages must use a Hugo relref shortcode like {{< relref "./path/to/page" >}}.

Links to project assets must be made from a bundle (index.md or _index.md file).
The asset must be contained within the bundle directory, it must have an extension, and must not have the extension .md.
docs/sources/alerting/set-up/provision-alerting-resources/terraform-provisioning/index.md|79 col 48| The link to the project page 'ref:alerting_http_provisioning' is invalid.
Links to project pages must use a Hugo relref shortcode like {{< relref "./path/to/page" >}}.

Links to project assets must be made from a bundle (index.md or _index.md file).
The asset must be contained within the bundle directory, it must have an extension, and must not have the extension .md.
docs/sources/alerting/set-up/provision-alerting-resources/terraform-provisioning/index.md|280 col 1| The link to the project page 'ref:alerting-rules' is invalid.
Links to project pages must use a Hugo relref shortcode like {{< relref "./path/to/page" >}}.

Links to project assets must be made from a bundle (index.md or _index.md file).
The asset must be contained within the bundle directory, it must have an extension, and must not have the extension .md.
docs/sources/alerting/set-up/provision-alerting-resources/terraform-provisioning/index.md|286 col 25| The link to the project page 'ref:testdata' is invalid.
Links to project pages must use a Hugo relref shortcode like {{< relref "./path/to/page" >}}.

Links to project assets must be made from a bundle (index.md or _index.md file).
The asset must be contained within the bundle directory, it must have an extension, and must not have the extension .md.
docs/sources/fundamentals/dashboards-overview/index.md|66 col 91| The link to the project page 'ref:transform-data' is invalid.
Links to project pages must use a Hugo relref shortcode like {{< relref "./path/to/page" >}}.

Links to project assets must be made from a bundle (index.md or _index.md file).
The asset must be contained within the bundle directory, it must have an extension, and must not have the extension .md.
docs/sources/fundamentals/intro-histograms/index.md|52 col 70| The link to the project page 'ref:histogram' is invalid.
Links to project pages must use a Hugo relref shortcode like {{< relref "./path/to/page" >}}.

Links to project assets must be made from a bundle (index.md or _index.md file).
The asset must be contained within the bundle directory, it must have an extension, and must not have the extension .md.
docs/sources/fundamentals/intro-histograms/index.md|64 col 68| The link to the project page 'ref:heatmap' is invalid.
Links to project pages must use a Hugo relref shortcode like {{< relref "./path/to/page" >}}.

Links to project assets must be made from a bundle (index.md or _index.md file).
The asset must be contained within the bundle directory, it must have an extension, and must not have the extension .md.
docs/sources/fundamentals/intro-to-prometheus/index.md|124 col 29| The link to the project page 'ref:build-dashboards' is invalid.
Links to project pages must use a Hugo relref shortcode like {{< relref "./path/to/page" >}}.

Links to project assets must be made from a bundle (index.md or _index.md file).
The asset must be contained within the bundle directory, it must have an extension, and must not have the extension .md.
docs/sources/fundamentals/intro-to-prometheus/index.md|126 col 93| The link to the project page 'ref:prometheus' is invalid.
Links to project pages must use a Hugo relref shortcode like {{< relref "./path/to/page" >}}.

Links to project assets must be made from a bundle (index.md or _index.md file).
The asset must be contained within the bundle directory, it must have an extension, and must not have the extension .md.
docs/sources/fundamentals/timeseries-dimensions/index.md|36 col 4| The link to the project page 'ref:time-series-databases' is invalid.
Links to project pages must use a Hugo relref shortcode like {{< relref "./path/to/page" >}}.

Links to project assets must be made from a bundle (index.md or _index.md file).
The asset must be contained within the bundle directory, it must have an extension, and must not have the extension .md.
docs/sources/fundamentals/timeseries-dimensions/index.md|108 col 48| The link to the project page 'ref:create-grafana-managed-rule' is invalid.
Links to project pages must use a Hugo relref shortcode like {{< relref "./path/to/page" >}}.

Links to project assets must be made from a bundle (index.md or _index.md file).
The asset must be contained within the bundle directory, it must have an extension, and must not have the extension .md.

@@ -28,7 +39,7 @@ Grafana Alerting is available for Grafana OSS, Grafana Enterprise, or Grafana Cl

Watch this video to learn more about Grafana Alerting: {{< vimeo 720001629 >}}

_Refer to [Manage your alert rules][alerting-rules] for current instructions._
_Refer to [Manage your alert rules](ref:alerting-rules) for current instructions._
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [doc-validator] reported by reviewdog 🐶
The link to the project page 'ref:alerting-rules' is invalid.
Links to project pages must use a Hugo relref shortcode like {{< relref "./path/to/page" >}}.

Links to project assets must be made from a bundle (index.md or _index.md file).
The asset must be contained within the bundle directory, it must have an extension, and must not have the extension .md.

[fundamentals]: "/docs/grafana/ -> /docs/grafana/<GRAFANA_VERSION>/alerting/fundamentals"
[fundamentals]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/alerting-and-irm/alerting/fundamentals"
{{% /docs/reference %}}
- [Introduction to Alerting](ref:fundamentals)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [doc-validator] reported by reviewdog 🐶
The link to the project page 'ref:fundamentals' is invalid.
Links to project pages must use a Hugo relref shortcode like {{< relref "./path/to/page" >}}.

Links to project assets must be made from a bundle (index.md or _index.md file).
The asset must be contained within the bundle directory, it must have an extension, and must not have the extension .md.

@@ -22,37 +48,20 @@ Configure the features and integrations that you need to create and manage your

**Configure alert rules**

[Configure Grafana-managed alert rules][create-grafana-managed-rule].
[Configure Grafana-managed alert rules](ref:create-grafana-managed-rule).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [doc-validator] reported by reviewdog 🐶
The link to the project page 'ref:create-grafana-managed-rule' is invalid.
Links to project pages must use a Hugo relref shortcode like {{< relref "./path/to/page" >}}.

Links to project assets must be made from a bundle (index.md or _index.md file).
The asset must be contained within the bundle directory, it must have an extension, and must not have the extension .md.


[Configure data source-managed alert rules][create-mimir-loki-managed-rule]
[Configure data source-managed alert rules](ref:create-mimir-loki-managed-rule)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [doc-validator] reported by reviewdog 🐶
The link to the project page 'ref:create-mimir-loki-managed-rule' is invalid.
Links to project pages must use a Hugo relref shortcode like {{< relref "./path/to/page" >}}.

Links to project assets must be made from a bundle (index.md or _index.md file).
The asset must be contained within the bundle directory, it must have an extension, and must not have the extension .md.


**Configure recording rules**

_Recording rules are only available for compatible Prometheus or Loki data sources._

For more information, see [Configure recording rules][create-mimir-loki-managed-recording-rule].
For more information, see [Configure recording rules](ref:create-mimir-loki-managed-recording-rule).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [doc-validator] reported by reviewdog 🐶
The link to the project page 'ref:create-mimir-loki-managed-recording-rule' is invalid.
Links to project pages must use a Hugo relref shortcode like {{< relref "./path/to/page" >}}.

Links to project assets must be made from a bundle (index.md or _index.md file).
The asset must be contained within the bundle directory, it must have an extension, and must not have the extension .md.

---

# Queries and conditions

In Grafana, queries play a vital role in fetching and transforming data from supported data sources, which include databases like MySQL and PostgreSQL, time series databases like Prometheus, InfluxDB and Graphite, and services like Elasticsearch, AWS CloudWatch, Azure Monitor and Google Cloud Monitoring.

For more information on supported data sources, see [Data sources][data-source-alerting].
For more information on supported data sources, see [Data sources](ref:data-source-alerting).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [doc-validator] reported by reviewdog 🐶
The link to the project page 'ref:data-source-alerting' is invalid.
Links to project pages must use a Hugo relref shortcode like {{< relref "./path/to/page" >}}.

Links to project assets must be made from a bundle (index.md or _index.md file).
The asset must be contained within the bundle directory, it must have an extension, and must not have the extension .md.


The process of executing a query involves defining the data source, specifying the desired data to retrieve, and applying relevant filters or transformations. Query languages or syntaxes specific to the chosen data source are utilized for constructing these queries.

In Alerting, you define a query to get the data you want to measure and a condition that needs to be met before an alert rule fires.

An alert rule consists of one or more queries and expressions that select the data you want to measure.

For more information on queries and expressions, see [Query and transform data][query-transform-data].
For more information on queries and expressions, see [Query and transform data](ref:query-transform-data).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [doc-validator] reported by reviewdog 🐶
The link to the project page 'ref:query-transform-data' is invalid.
Links to project pages must use a Hugo relref shortcode like {{< relref "./path/to/page" >}}.

Links to project assets must be made from a bundle (index.md or _index.md file).
The asset must be contained within the bundle directory, it must have an extension, and must not have the extension .md.

[configure-alertmanager]: "/docs/grafana/ -> /docs/grafana/<GRAFANA_VERSION>/alerting/set-up/configure-alertmanager"
[configure-alertmanager]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/alerting-and-irm/alerting/set-up/configure-alertmanager"
{{% /docs/reference %}}
[Add an external Alertmanager](ref:configure-alertmanager)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [doc-validator] reported by reviewdog 🐶
The link to the project page 'ref:configure-alertmanager' is invalid.
Links to project pages must use a Hugo relref shortcode like {{< relref "./path/to/page" >}}.

Links to project assets must be made from a bundle (index.md or _index.md file).
The asset must be contained within the bundle directory, it must have an extension, and must not have the extension .md.

@@ -25,7 +31,7 @@ Labels and annotations contain information about an alert. Both labels and annot

The main difference between a label and an annotation is that labels are used to differentiate an alert from all other alerts, while annotations are used to add additional information to an existing alert.

For example, consider two high CPU alerts: one for `server1` and another for `server2`. In such an example we might have a label called `server` where the first alert has the label `server="server1"` and the second alert has the label `server="server2"`. However, we might also want to add a description to each alert such as `"The CPU usage for server1 is above 75%."`, where `server1` and `75%` are replaced with the name and CPU usage of the server (please refer to the documentation on [templating labels and annotations][variables-label-annotation] for how to do this). This kind of description would be more suitable as an annotation.
For example, consider two high CPU alerts: one for `server1` and another for `server2`. In such an example we might have a label called `server` where the first alert has the label `server="server1"` and the second alert has the label `server="server2"`. However, we might also want to add a description to each alert such as `"The CPU usage for server1 is above 75%."`, where `server1` and `75%` are replaced with the name and CPU usage of the server (please refer to the documentation on [templating labels and annotations](ref:variables-label-annotation) for how to do this). This kind of description would be more suitable as an annotation.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [doc-validator] reported by reviewdog 🐶
The link to the project page 'ref:variables-label-annotation' is invalid.
Links to project pages must use a Hugo relref shortcode like {{< relref "./path/to/page" >}}.

Links to project assets must be made from a bundle (index.md or _index.md file).
The asset must be contained within the bundle directory, it must have an extension, and must not have the extension .md.

@@ -37,17 +43,12 @@

### Custom Labels

Custom labels are additional labels from the alert rule. Like annotations, custom labels must have a name, and their value can contain a combination of text and template code that is evaluated when an alert is fired. Documentation on how to template custom labels can be found [here][variables-label-annotation].
Custom labels are additional labels from the alert rule. Like annotations, custom labels must have a name, and their value can contain a combination of text and template code that is evaluated when an alert is fired. Documentation on how to template custom labels can be found [here](ref:variables-label-annotation).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [doc-validator] reported by reviewdog 🐶
The link to the project page 'ref:variables-label-annotation' is invalid.
Links to project pages must use a Hugo relref shortcode like {{< relref "./path/to/page" >}}.

Links to project assets must be made from a bundle (index.md or _index.md file).
The asset must be contained within the bundle directory, it must have an extension, and must not have the extension .md.

@jdbaldry jdbaldry closed this May 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant