From ec774c901a0eb464dc287f19bd0970e54aa492f9 Mon Sep 17 00:00:00 2001 From: Jack Baldry Date: Mon, 2 Oct 2023 10:46:44 +0100 Subject: [PATCH] Replace use of `relref` shortcode with `docs/reference` so links work in Grafana Cloud (#75433) * Replace use of `relref` shortcode with `docs/reference` so links work in Grafana Cloud Signed-off-by: Jack Baldry * Link to Grafana Cloud content --------- Signed-off-by: Jack Baldry --- .../dashboards/build-dashboards/create-dashboard/index.md | 5 ++++- .../panels-visualizations/configure-data-links/index.md | 8 +++++++- .../visualizations/datagrid/index.md | 7 ++++++- .../panels-visualizations/visualizations/traces/index.md | 5 ++++- 4 files changed, 21 insertions(+), 4 deletions(-) diff --git a/docs/sources/dashboards/build-dashboards/create-dashboard/index.md b/docs/sources/dashboards/build-dashboards/create-dashboard/index.md index 38e472fa134..172e5b1b4f5 100644 --- a/docs/sources/dashboards/build-dashboards/create-dashboard/index.md +++ b/docs/sources/dashboards/build-dashboards/create-dashboard/index.md @@ -109,7 +109,7 @@ To provide context to dashboard users, add the variable to the row title. ### Repeating rows and the Dashboard special data source -If a row includes panels using the special [Dashboard]({{< relref "../../../datasources/#special-data-sources" >}}) data source—the data source that uses a result set from another panel in the same dashboard—then corresponding panels in repeated rows will reference the panel in the original row, not the ones in the repeated rows. +If a row includes panels using the special [Dashboard][] data source—the data source that uses a result set from another panel in the same dashboard—then corresponding panels in repeated rows will reference the panel in the original row, not the ones in the repeated rows. For example, in a dashboard: @@ -135,6 +135,9 @@ You can size a dashboard panel to suits your needs. 1. To adjust the size of the panel, click and drag the lower-right corner of the panel. {{% docs/reference %}} +[Dashboard]: "/docs/grafana/ -> /docs/grafana//datasources#special-data-sources" +[Dashboard]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/connect-externally-hosted/data-sources#special-data-sources" + [Override field values]: "/docs/grafana/ -> /docs/grafana//panels-visualizations/configure-overrides" [Override field values]: "/docs/grafana-cloud/ -> /docs/grafana//panels-visualizations/configure-overrides" diff --git a/docs/sources/panels-visualizations/configure-data-links/index.md b/docs/sources/panels-visualizations/configure-data-links/index.md index da465313f60..af4b8bad8ea 100644 --- a/docs/sources/panels-visualizations/configure-data-links/index.md +++ b/docs/sources/panels-visualizations/configure-data-links/index.md @@ -37,7 +37,7 @@ To see a list of available variables, type `$` in the data link **URL** field to These variables changed in 6.4 so if you have an older version of Grafana, then use the version picker to select docs for an older version of Grafana. {{% /admonition %}} -Azure Monitor, [CloudWatch]({{< relref "../../datasources/aws-cloudwatch/query-editor/#deep-link-grafana-panels-to-the-cloudwatch-console-1" >}}), and [Google Cloud Monitoring]({{< relref "../../datasources/google-cloud-monitoring/query-editor/#deep-link-from-grafana-panels-to-the-google-cloud-console-metrics-explorer" >}}) have pre-configured data links called _deep links_. +Azure Monitor, [CloudWatch][], and [Google Cloud Monitoring][] have pre-configured data links called _deep links_. You can also use template variables in your data links URLs, refer to [Templates and variables][] for more information on template variables. @@ -133,6 +133,12 @@ When creating or updating a data link, press Cmd+Space or Ctrl+Space on your key 1. Click **Save** in the upper right to save your changes to the dashboard. {{% docs/reference %}} +[Cloudwatch]: "/docs/grafana/ -> /docs/grafana//datasources/aws-cloudwatch/query-editor#deep-link-grafana-panels-to-the-cloudwatch-console-1" +[Cloudwatch]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/connect-externally-hosted/data-sources/aws-cloudwatch/query-editor#deep-link-grafana-panels-to-the-cloudwatch-console-1" + +[Google Cloud Monitoring]: "/docs/grafana/ -> /docs/grafana//datasources/google-cloud-monitoring/query-editor#deep-link-from-grafana-panels-to-the-google-cloud-console-metrics-explorer" +[Google Cloud Monitoring]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/connect-externally-hosted/data-sources/google-cloud-monitoring/query-editor#deep-link-from-grafana-panels-to-the-google-cloud-console-metrics-explorer" + [Templates and variables]: "/docs/grafana/ -> /docs/grafana//dashboards/variables" [Templates and variables]: "/docs/grafana-cloud/ -> /docs/grafana//dashboards/variables" diff --git a/docs/sources/panels-visualizations/visualizations/datagrid/index.md b/docs/sources/panels-visualizations/visualizations/datagrid/index.md index 3ee1c51f647..af530fcaa3d 100644 --- a/docs/sources/panels-visualizations/visualizations/datagrid/index.md +++ b/docs/sources/panels-visualizations/visualizations/datagrid/index.md @@ -41,7 +41,7 @@ Editing the dataset changes the data source to use the inbuilt `-- Grafana --` d You can then use the panel as a data source for other panels, by using the inbuilt `-- Dashboard --` data source to pull the datagrid data. This allows for an interactive dashboard experience, where you can modify the data and see the changes reflected in other panels. -Learn more about the inbuilt `-- Grafana --` and `-- Dashboard --` data sources in the [special data sources]({{< relref "../../../datasources/#special-data-sources" >}}) documentation. +Learn more about the inbuilt `-- Grafana --` and `-- Dashboard --` data sources in the [special data sources][] documentation. ## Context menu @@ -121,3 +121,8 @@ To delete or clear multiple rows, take the following steps: The same rules apply to columns by clicking the column headers. To delete all rows, use the "select all" checkbox at the top left corner of the datagrid. This selects all rows and allows you to delete them using the context menu. + +{{% docs/reference %}} +[special data sources]: "/docs/grafana/ -> /docs/grafana//datasources#special-data-sources" +[special data sources]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/connect-externally-hosted/data-sources#special-data-sources" +{{% /docs/reference %}} diff --git a/docs/sources/panels-visualizations/visualizations/traces/index.md b/docs/sources/panels-visualizations/visualizations/traces/index.md index 3275663cab3..8b0e85c4c0d 100644 --- a/docs/sources/panels-visualizations/visualizations/traces/index.md +++ b/docs/sources/panels-visualizations/visualizations/traces/index.md @@ -41,7 +41,7 @@ For more information about dashboard variables, refer to the [Variables document To use this procedure, you need: - A Grafana instance -- A Tempo data source connected to your Grafana instance (refer to [documentation]({{< relref "../../../datasources/tempo" >}})) +- A [Tempo data source][] connected to your Grafana instance ### Add the traces visualization query {#add-the-traces-panel-query} @@ -130,4 +130,7 @@ You should now see a list of matching traces in the table visualization. While s [Configure panel options documentation]: "/docs/grafana/ -> /docs/grafana//panels-visualizations/configure-panel-options" [Configure panel options documentation]: "/docs/grafana-cloud/ -> /docs/grafana//panels-visualizations/configure-panel-options" + +[Tempo data source]: "/docs/grafana/ -> /docs/grafana//datasources/tempo" +[Tempo data source]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/connect-externally-hosted/data-sources/tempo" {{% /docs/reference %}}