public/grafana
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

[v11.0] Remove relref shortcodes (#101712) (#101996)

Browse Source 
* manually replce all shared relrefs

* relref replace - previous grafana versions

* Merge branch 'master' into robbymilo/relref-replace-grafana-previous

* update test

* prettier

(cherry picked from commit 77a1e41789)
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

Co-authored-by: Robby Milo <robbymilo@fastmail.com>
This commit is contained in:
Jack Baldry
2025-03-12 10:02:10 +00:00
committed by GitHub
co-authored by Robby Milo
parent b056dba9f5
commit 0fdbcb3877
192 changed files with 1655 additions and 1658 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/sources/shared/alerts/alerting_provisioning.md
+19 -19
View File
@@ -6,9 +6,9 @@ labels:
title: 'Alerting Provisioning HTTP API '
---
The Alerting provisioning API can be used to create, modify, and delete resources relevant to [Grafana-managed alerts]({{< relref "/docs/grafana/latest/alerting/alerting-rules/create-grafana-managed-rule" >}}). It is the one used by our [Grafana Terraform provider](https://registry.terraform.io/providers/grafana/grafana/latest/docs).
The Alerting provisioning API can be used to create, modify, and delete resources relevant to [Grafana-managed alerts](/docs/grafana/<GRAFANA_VERSION>/alerting/alerting-rules/create-grafana-managed-rule). It is the one used by our [Grafana Terraform provider](https://registry.terraform.io/providers/grafana/grafana/latest/docs).
To manage resources related to [data source-managed alerts]({{< relref "/docs/grafana/latest/alerting/alerting-rules/create-grafana-managed-rule" >}}), including recording rules, use the [Mimir tool](https://grafana.com/docs/mimir/latest/manage/tools/mimirtool/) and [Cortex tool](https://github.com/grafana/cortex-tools#cortextool).
To manage resources related to [data source-managed alerts](/docs/grafana/<GRAFANA_VERSION>/alerting/alerting-rules/create-grafana-managed-rule), including recording rules, use the [Mimir tool](https://grafana.com/docs/mimir/latest/manage/tools/mimirtool/) and [Cortex tool](https://github.com/grafana/cortex-tools#cortextool).
## Information
@@ -1374,7 +1374,7 @@ Status: Accepted
| annotations | map of string | `map[string]string` | | | | |
| condition | string | `string` | | | | |
| dashboardUid | string | `string` | | | | |
| data | [][AlertQueryExport](#alert-query-export) | `[]*AlertQueryExport` | | | | |
| data | [][alertqueryexport](#alert-query-export) | `[]*AlertQueryExport` | | | | |
| execErrState | string | `string` | | | | |
| for | [Duration](#duration) | `Duration` | | | | |
| isPaused | boolean | `bool` | | | | |
@@ -1396,7 +1396,7 @@ Status: Accepted
| --------- | ------------------------------------------------- | ------------------------- | :------: | ------- | ----------- | ------- |
| folderUid | string | `string` | | | | |
| interval | int64 (formatted integer) | `int64` | | | | |
| rules | [][ProvisionedAlertRule](#provisioned-alert-rule) | `[]*ProvisionedAlertRule` | | | | |
| rules | [][provisionedalertrule](#provisioned-alert-rule) | `[]*ProvisionedAlertRule` | | | | |
| title | string | `string` | | | | |
{{% /responsive-table %}}
@@ -1413,7 +1413,7 @@ Status: Accepted
| interval | [Duration](#duration) | `Duration` | | | | |
| name | string | `string` | | | | |
| orgId | int64 (formatted integer) | `int64` | | | | |
| rules | [][AlertRuleExport](#alert-rule-export) | `[]*AlertRuleExport` | | | | |
| rules | [][alertruleexport](#alert-rule-export) | `[]*AlertRuleExport` | | | | |
{{% /responsive-table %}}
@@ -1426,9 +1426,9 @@ Status: Accepted
| Name | Type | Go type | Required | Default | Description | Example |
| ------------- | --------------------------------------------------------- | ----------------------------- | :------: | ------- | ----------- | ------- |
| apiVersion | int64 (formatted integer) | `int64` | | | | |
| contactPoints | [][ContactPointExport](#contact-point-export) | `[]*ContactPointExport` | | | | |
| groups | [][AlertRuleGroupExport](#alert-rule-group-export) | `[]*AlertRuleGroupExport` | | | | |
| policies | [][NotificationPolicyExport](#notification-policy-export) | `[]*NotificationPolicyExport` | | | | |
| contactPoints | [][contactpointexport](#contact-point-export) | `[]*ContactPointExport` | | | | |
| groups | [][alertrulegroupexport](#alert-rule-group-export) | `[]*AlertRuleGroupExport` | | | | |
| policies | [][notificationpolicyexport](#notification-policy-export) | `[]*NotificationPolicyExport` | | | | |
{{% /responsive-table %}}
@@ -1440,11 +1440,11 @@ Status: Accepted
| --------- | ------------------------------------ | ------------------- | :------: | ------- | ----------- | ------- |
| name | string | `string` | | | | |
| orgId | int64 (formatted integer) | `int64` | | | | |
| receivers | [][ReceiverExport](#receiver-export) | `[]*ReceiverExport` | | | | |
| receivers | [][receiverexport](#receiver-export) | `[]*ReceiverExport` | | | | |
### <span id="contact-points"></span> ContactPoints
[][EmbeddedContactPoint](#embedded-contact-point)
[][embeddedcontactpoint](#embedded-contact-point)
### <span id="duration"></span> Duration
@@ -1508,7 +1508,7 @@ Status: Accepted
> provides a Matches method to match a LabelSet against all Matchers in the
> slice. Note that some users of Matchers might require it to be sorted.
[][Matcher](#matcher)
[][matcher](#matcher)
### <span id="mute-time-interval"></span> MuteTimeInterval
@@ -1519,7 +1519,7 @@ Status: Accepted
| Name | Type | Go type | Required | Default | Description | Example |
| -------------- | -------------------------------- | ----------------- | :------: | ------- | ----------- | ------- |
| name | string | `string` | | | | |
| time_intervals | [][TimeInterval](#time-interval) | `[]*TimeInterval` | | | | |
| time_intervals | [][timeinterval](#time-interval) | `[]*TimeInterval` | | | | |
{{% /responsive-table %}}
@@ -1533,7 +1533,7 @@ Status: Accepted
### <span id="mute-timings"></span> MuteTimings
[][MuteTimeInterval](#mute-time-interval)
[][mutetimeinterval](#mute-time-interval)
### <span id="not-found"></span> NotFound
@@ -1576,7 +1576,7 @@ Status: Accepted
### <span id="notification-templates"></span> NotificationTemplates
[][NotificationTemplate](#notification-template)
[][notificationtemplate](#notification-template)
### <span id="object-matchers"></span> ObjectMatchers
@@ -1604,7 +1604,7 @@ Status: Accepted
| ------------ | ---------------------------- | ------------------- | :------: | ------- | ----------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| annotations | map of string | `map[string]string` | | | | `{"runbook_url":"https://supercoolrunbook.com/page/13"}` |
| condition | string | `string` | ✓ | | | `A` |
| data | [][AlertQuery](#alert-query) | `[]*AlertQuery` | ✓ | | | `[{"datasourceUid":"__expr__","model":{"conditions":[{"evaluator":{"params":[0,0],"type":"gt"},"operator":{"type":"and"},"query":{"params":[]},"reducer":{"params":[],"type":"avg"},"type":"query"}],"datasource":{"type":"__expr__","uid":"__expr__"},"expression":"1 == 1","hide":false,"intervalMs":1000,"maxDataPoints":43200,"refId":"A","type":"math"},"queryType":"","refId":"A","relativeTimeRange":{"from":0,"to":0}}]` |
| data | [][alertquery](#alert-query) | `[]*AlertQuery` | ✓ | | | `[{"datasourceUid":"__expr__","model":{"conditions":[{"evaluator":{"params":[0,0],"type":"gt"},"operator":{"type":"and"},"query":{"params":[]},"reducer":{"params":[],"type":"avg"},"type":"query"}],"datasource":{"type":"__expr__","uid":"__expr__"},"expression":"1 == 1","hide":false,"intervalMs":1000,"maxDataPoints":43200,"refId":"A","type":"math"},"queryType":"","refId":"A","relativeTimeRange":{"from":0,"to":0}}]` |
| execErrState | string | `string` | ✓ | | | |
| folderUID | string | `string` | ✓ | | | `project_x` |
| for | [Duration](#duration) | `Duration` | ✓ | | | |
@@ -1623,7 +1623,7 @@ Status: Accepted
### <span id="provisioned-alert-rules"></span> ProvisionedAlertRules
[][ProvisionedAlertRule](#provisioned-alert-rule)
[][provisionedalertrule](#provisioned-alert-rule)
### <span id="raw-message"></span> RawMessage
@@ -1686,7 +1686,7 @@ Status: Accepted
| provenance | [Provenance](#provenance) | `Provenance` | | | | |
| receiver | string | `string` | | | | |
| repeat_interval | string | `string` | | | | |
| routes | [][Route](#route) | `[]*Route` | | | | |
| routes | [][route](#route) | `[]*Route` | | | | |
{{% /responsive-table %}}
@@ -1710,7 +1710,7 @@ Status: Accepted
| object_matchers | [ObjectMatchers](#object-matchers) | `ObjectMatchers` | | | | |
| receiver | string | `string` | | | | |
| repeat_interval | string | `string` | | | | |
| routes | [][RouteExport](#route-export) | `[]*RouteExport` | | | | |
| routes | [][routeexport](#route-export) | `[]*RouteExport` | | | | |
### <span id="time-interval"></span> TimeInterval
@@ -1726,7 +1726,7 @@ Status: Accepted
| days_of_month | []string | `[]string` | | | | |
| location | string | `string` | | | | |
| months | []string | `[]string` | | | | |
| times | [][TimeRange](#time-range) | `[]*TimeRange` | | | | |
| times | [][timerange](#time-range) | `[]*TimeRange` | | | | |
| weekdays | []string | `[]string` | | | | |
| years | []string | `[]string` | | | | |
docs/sources/shared/alerts/first-step.md
+1 -1
View File
@@ -8,7 +8,7 @@ title: TBD
## TBD
Use the instructions in [Getting started with Grafana]({{< relref "../../getting-started/getting-started/" >}}) to:
Use the instructions in [Getting started with Grafana](/docs/grafana/<GRAFANA_VERSION>/getting-started/getting-started/) to:
- Install Grafana.
- Log in to Grafana.
docs/sources/shared/alerts/grafana-managed-alerts.md
+1 -1
View File
@@ -22,7 +22,7 @@ Alerting rules can only query backend data sources with alerting enabled:
## Metrics from the alerting engine
The alerting engine publishes some internal metrics about itself. You can read more about how Grafana publishes [internal metrics]({{< relref "../../setup-grafana/set-up-grafana-monitoring/" >}}). See also, [View alert rules and their current state]({{< relref "../../alerting/fundamentals/state-and-health/" >}}).
The alerting engine publishes some internal metrics about itself. You can read more about how Grafana publishes [internal metrics](/docs/grafana/<GRAFANA_VERSION>/setup-grafana/set-up-grafana-monitoring/). See also, [View alert rules and their current state](/docs/grafana/<GRAFANA_VERSION>/alerting/fundamentals/state-and-health/).
| Metric Name | Type | Description |
| --------------------------------------------------- | --------- | ---------------------------------------------------------------------------------------- |
docs/sources/shared/auth/intro.md
+1 -1
View File
@@ -10,4 +10,4 @@ There are numerous authentication methods available in Grafana to verify user id
You can also configure Grafana to automatically update users' roles and team memberships in Grafana based on the information returned by the auth provider integration.
When deciding on an authentication method, it's important to take into account your current identity and access management system as well as the specific authentication and authorization features you require.
For a complete list of the available authentication options and the features they support, refer to [Configure authentication]({{< relref "/docs/grafana/latest/setup-grafana/configure-security/configure-authentication" >}}).
For a complete list of the available authentication options and the features they support, refer to [Configure authentication](/docs/grafana/<GRAFANA_VERSION>/setup-grafana/configure-security/configure-authentication).
docs/sources/shared/preferences/some-tasks-require-permissions.md
+1 -1
View File
@@ -6,4 +6,4 @@ labels:
title: Some tasks require permissions
---
Some tasks require certain permissions. For more information about roles, refer to [About users and permission]({{< relref "../../administration/manage-users-and-permissions/about-users-and-permissions/" >}}).
Some tasks require certain permissions. For more information about roles, refer to [About users and permission](/docs/grafana/<GRAFANA_VERSION>/administration/manage-users-and-permissions/about-users-and-permissions/).
docs/sources/shared/visualizations/change-axis-link.md
+1 -1
View File
@@ -4,4 +4,4 @@ title: Stack series link
## Axis
For full instructions, refer to [Change axis display]({{< relref "../../visualizations/time-series/change-axis-display/" >}}).
For full instructions, refer to [Change axis display](/docs/grafana/<GRAFANA_VERSION>/visualizations/time-series/change-axis-display/).
docs/sources/shared/visualizations/stack-series-link.md
+1 -1
View File
@@ -4,4 +4,4 @@ title: Stack series link
### Stack series
For full instructions, refer to [Graph stacked time series]({{< relref "../../visualizations/time-series/graph-time-series-stacking/" >}}).
For full instructions, refer to [Graph stacked time series](/docs/grafana/<GRAFANA_VERSION>/visualizations/time-series/graph-time-series-stacking/).