From 520497738e2c3a956c5c33c9473900c210b09ae5 Mon Sep 17 00:00:00 2001 From: Josh Hunt Date: Fri, 13 Oct 2023 15:39:35 +0000 Subject: [PATCH] Docs: Revisit Manage Dashboard docs for new UI (#75840) * Docs: Start to iterate on new Browse Dashboard docs * more * more changes * Apply suggestions from code review Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com> * prettier * Update docs/sources/dashboards/manage-dashboards/index.md Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com> * disclaimer about folders with slashes in them * Apply suggestions from code review Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com> --------- Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com> --- .../dashboards/manage-dashboards/index.md | 69 +++++++++++-------- 1 file changed, 40 insertions(+), 29 deletions(-) diff --git a/docs/sources/dashboards/manage-dashboards/index.md b/docs/sources/dashboards/manage-dashboards/index.md index 04711802967..c9ddc5dfaa3 100644 --- a/docs/sources/dashboards/manage-dashboards/index.md +++ b/docs/sources/dashboards/manage-dashboards/index.md @@ -32,10 +32,6 @@ weight: 8 # Manage dashboards -A dashboard is a set of one or more [panels][] that visually presents your data in one or more rows. - -For more information about creating dashboards, refer to [Add and organize panels](../add-organize-panels). - This topic includes techniques you can use to manage your Grafana dashboards, including: - [Creating and managing dashboard folders](#create-and-manage-dashboard-folders) @@ -43,48 +39,60 @@ This topic includes techniques you can use to manage your Grafana dashboards, in - [Organizing dashboards](#organize-a-dashboard) - [Troubleshooting dashboards](#troubleshoot-dashboards) +For more information about creating dashboards, refer to [Add and organize panels](../add-organize-panels). + +## Browse dashboards + +On the **Dashboards** page, you can browse and manage folders and dashboards. This includes the options to: + +- Create folders and dashboards +- Move dashboards between folders +- Delete multiple dashboards and folders +- Navigate to a folder +- Manage folder permissions. For more information, refer to [Dashboard permissions](https://grafana.com/docs/grafana//administration/roles-and-permissions/#dashboard-permissions). + +{{% admonition type="note" %}} +As of Grafana 10.2, there is no longer a special **General** folder. Dashboards without a folder are now shown at the top level alongside folders. +{{% /admonition %}} + ## Create a dashboard folder Folders help you organize and group dashboards, which is useful when you have many dashboards or multiple teams using the same Grafana instance. -**Before you begin:** - -- Ensure that you have Grafana Admin or Super Admin permissions. For more information about dashboard permissions, refer to [Dashboard permissions][]. +> **Before you begin:** Ensure you have Editor permissions or greater to create folders. For more information about dashboard permissions, refer to [Dashboard permissions][]. **To create a dashboard folder:** -1. Sign in to Grafana. -1. Click **Dashboards** in the left-side menu. -1. On the Dashboards page, click **New** and select **New folder** in the dropdown. +1. Click **Dashboards** in the main menu. +1. On the **Dashboards** page, click **New** and select **New folder** in the drop-down. 1. Enter a unique name and click **Create**. - Do not use the name of a folder that has already been provisioned (such as "General") and avoid special characters (except underscores and hyphens). - When you save a dashboard, you can either select a folder for the dashboard to be saved in or create a new folder. -## Manage dashboards +{{% admonition type="note" %}} +Alerts cannot be placed in folders with slashes (\ /) in the name. If you wish to place alerts in the folder, do not use slashes in the folder name. +{{% /admonition %}} -On the Dashboards page, you can: +**To edit the name of a folder:** -- create a folder -- create a dashboard -- move dashboards into folders -- delete multiple dashboards -- navigate to a folder page where you can assign folder and dashboard permissions +1. Click **Dashboards** in the main menu. +1. Navigate to the folder by selecting it in the list, or searching for it. +1. Click the pencil icon labelled **Edit title** in the header and update the name of the folder. -### Dashboard folder page +The new folder name is automatically saved. -You can complete the following tasks on a dashboard folder page: +### Folder permissions -- Move or delete dashboards in a folder -- Rename a folder (available on the Settings tab) -- Assign permissions to folders (which are inherited by the dashboards in the folder) +You can assign permissions to a folder. Any permissions you assign are inherited by the dashboards in the folder. You can assign permissions to organization roles, teams, and users. -To navigate to the dashboard folder page, hover over the name of the folder and click **Go to folder** in the dashboard search result list or on the Dashboards page. +**To modify permissions for a folder:** -### Dashboard permissions +1. Click **Dashboards** in the main menu. +1. Navigate to the folder by selecting it in the list, or searching for it. +1. On the folder's page, click **Folder actions** and select **Manage permissions** in the drop-down. +1. Update the permissions as desired. -You can assign permissions to a folder. Any permissions you assign are inherited by the dashboards in the folder. An Access Control List (ACL) is used where **Organization Role**, **Team**, and a **User** can be assigned permissions. +Changes are saved automatically. For more information about dashboard permissions, refer to [Dashboard permissions][]. @@ -96,10 +104,13 @@ You can use the Grafana UI or the [HTTP API][] to export and import dashboards. The dashboard export action creates a Grafana JSON file that contains everything you need, including layout, variables, styles, data sources, queries, and so on, so that you can later import the dashboard. -1. Click **Dashboards** in the left-side menu. +1. Click **Dashboards** in the main menu. 1. Open the dashboard you want to export. -1. Click the **Share** icon. +1. Click the **Share** icon in the top navigation bar. 1. Click **Export**. + + If you're exporting the dashboard to use in another instance, with different data source UIDs, enable the **Export for sharing externally** switch. + 1. Click **Save to file**. Grafana downloads a JSON file to your local machine.