From ff982ed0015e2efb8356f3aa059682eec32a8a4e Mon Sep 17 00:00:00 2001 From: Isabel Matwawana <76437239+imatwawana@users.noreply.github.com> Date: Tue, 2 Jul 2024 16:35:54 -0400 Subject: [PATCH] Docs: Clarify query and tags search in dashboard list (#89968) --- .../visualizations/dashboard-list/index.md | 29 +++++++++++++------ 1 file changed, 20 insertions(+), 9 deletions(-) diff --git a/docs/sources/panels-visualizations/visualizations/dashboard-list/index.md b/docs/sources/panels-visualizations/visualizations/dashboard-list/index.md index 852f6152d2c..dc523bf12c3 100644 --- a/docs/sources/panels-visualizations/visualizations/dashboard-list/index.md +++ b/docs/sources/panels-visualizations/visualizations/dashboard-list/index.md @@ -24,11 +24,16 @@ refs: destination: /docs/grafana//dashboards/build-dashboards/create-dashboard-url-variables/ - pattern: /docs/grafana-cloud/ destination: /docs/grafana-cloud/visualizations/dashboards/build-dashboards/create-dashboard-url-variables/ + dashboard: + - pattern: /docs/grafana/ + destination: /docs/grafana//dashboards/build-dashboards/create-dashboard/ + - pattern: /docs/grafana-cloud/ + destination: /docs/grafana-cloud/visualizations/dashboards/build-dashboards/create-dashboard/ --- # Dashboard list -Dashboard lists allow you to display dynamic links to other dashboards. The list can be configured to use starred dashboards, recently viewed dashboards, a search query, and dashboard tags. +Dashboard lists allow you to display dynamic links to other dashboards. You can configure the list to use starred dashboards, recently viewed dashboards, a search query, and dashboard tags. {{< figure src="/static/img/docs/v45/dashboard-list-panels.png" max-width="850px" alt="A dashboard list visualization" >}} @@ -38,7 +43,7 @@ You can use a dashboard list visualization to display a list of important dashbo ## Configure a dashboard list visualization -Once you’ve created a [dashboard](https://grafana.com/docs/grafana//dashboards/build-dashboards/create-dashboard/), the following video shows you how to configure a dashboard list visualization: +Once you’ve created a [dashboard](ref:dashboard), the following video shows you how to configure a dashboard list visualization: {{< youtube id="MserjWGWsh8" >}} @@ -58,7 +63,7 @@ Select this option to propagate the time range of the current dashboard to the d ### Include current template variable values -Select this option to include template variables currently used as query parameters in a link. When you click the link, any matching templates in the linked dashboard are set to the values from the link. Learn more in [Dashboard URL variables](ref:dashboard-url-variables). +Select this option to include template variables that are being used as query parameters in a link. When you click the link, any matching templates in the linked dashboard are set to the values from the link. Learn more in [Dashboard URL variables](ref:dashboard-url-variables). ### Starred @@ -70,11 +75,15 @@ Display recently viewed dashboards in alphabetical order. ### Search -Display dashboards by search query or tags. You must enter at least one value in **Query** or **Tags**. For the **Query** and **Tags** fields, variable interpolation is supported. For example, `$my_var` or `${my_var}`. +Display dashboards by search query or tags. You must enter at least one value in **Query** or **Tags**. For the **Query** and **Tags** fields, variable interpolation is supported. For example, `$my_var` or `${my_var}`. Learn more in [Search option](#search-options). ### Show headings -The selected list section (**Starred**, **Recently viewed**, **Search**) is shown as a heading. +The selected list section is shown as a heading: + +- **Starred** +- **Recently viewed** +- **Search** ### Max items @@ -82,11 +91,11 @@ Sets the maximum number of items to list per section. For example, if you leave ## Search options -These options only apply if the **Search** option is selected. +These options only apply if you select the **Search** option. ### Query -Enter the query by which you want to search. Queries are case-insensitive and partial values are accepted. +Use this field to search by dashboard name. Query terms are case-insensitive and partial values are accepted. For example, if you have dashboards called "Indoor Temps" and "Outdoor temp", entering the word "temp" would return both results. ### Folder @@ -94,6 +103,8 @@ Select the dashboard folders that you want to display. ### Tags -Enter tags by which you want to search. Note that existing tags don't appear as you type, and they _are_ case sensitive. +Enter tags by which you want to search. Note that tags don't appear as you type, and they're case sensitive. Tag search uses an `OR` condition, so if a dashboard has one of the defined tags, it's included in the list. -> **Note:** When multiple tags and strings appear, the dashboard list displays those matching _all_ conditions. +{{< admonition type="note" >}} +When multiple tags and strings appear, the dashboard list displays those matching _all_ conditions. +{{< /admonition >}}