Nested Folders: Update documentation (#81054)

* docs updates!

* Apply suggestions from code review

Co-authored-by: Jack Baldry <jack.baldry@grafana.com>

* Apply suggestions from code review

Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com>

* simplify

---------

Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com>
This commit is contained in:
Ashley Harrison 2024-01-25 09:20:37 +00:00 committed by GitHub
parent c741697333
commit 3e073c4dc1
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
3 changed files with 17 additions and 4 deletions

View File

@ -419,6 +419,10 @@ providers:
To provision dashboards to the root level, store them in the root of your `path`. To provision dashboards to the root level, store them in the root of your `path`.
{{% /admonition %}} {{% /admonition %}}
{{< admonition type="note" >}}
This feature doesn't currently allow you to create nested folder structures, that is, where you have folders within folders.
{{< /admonition >}}
## Alerting ## Alerting
For information on provisioning Grafana Alerting, refer to [Provision Grafana Alerting resources]({{< relref "../../alerting/set-up/provision-alerting-resources/" >}}). For information on provisioning Grafana Alerting, refer to [Provision Grafana Alerting resources]({{< relref "../../alerting/set-up/provision-alerting-resources/" >}}).

View File

@ -56,6 +56,11 @@ On the **Dashboards** page, you can browse and manage folders and dashboards. Th
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. 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 %}} {{% /admonition %}}
### Shared with me
The **Shared with me** section displays folders and dashboards that are directly shared with you that wouldn't otherwise be visible in the standard dashboards list.
This is because you don't have access to one or more of the parent folders.
## Create a dashboard folder ## 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. Folders help you organize and group dashboards, which is useful when you have many dashboards or multiple teams using the same Grafana instance.
@ -65,10 +70,14 @@ Folders help you organize and group dashboards, which is useful when you have ma
**To create a dashboard folder:** **To create a dashboard folder:**
1. Click **Dashboards** in the main menu. 1. Click **Dashboards** in the main menu.
1. On the **Dashboards** page, click **New** and select **New folder** in the drop-down. 1. Do one of the following:
- On the **Dashboards** page, click **New** and select **New folder** in the drop-down.
- Click an existing folder and on the folders page, click **New** and select **New folder** in the drop-down.
1. Enter a unique name and click **Create**. 1. Enter a unique name and click **Create**.
When you save a dashboard, you can either select a folder for the dashboard to be saved in or create a new folder. When you nest folders, you can do so up to four levels deep.
When you save a dashboard, you can optionally select a folder to save the dashboard in.
{{% admonition type="note" %}} {{% admonition type="note" %}}
Alerts can't be placed in folders with slashes (\ /) in the name. If you wish to place alerts in the folder, don't use slashes in the folder name. Alerts can't be placed in folders with slashes (\ /) in the name. If you wish to place alerts in the folder, don't use slashes in the folder name.

View File

@ -34,7 +34,7 @@ Query parameters:
- **dashboardIds** List of dashboard id's to search for - **dashboardIds** List of dashboard id's to search for
- **dashboardUID** - List of dashboard uid's to search for, It is deprecated since Grafana v9.1, please use dashboardUIDs instead - **dashboardUID** - List of dashboard uid's to search for, It is deprecated since Grafana v9.1, please use dashboardUIDs instead
- **dashboardUIDs** List of dashboard uid's to search for - **dashboardUIDs** List of dashboard uid's to search for
- **folderIds** List of folder id's to search in for dashboards - **folderUIDs** List of folder UIDs to search in
- **starred** Flag indicating if only starred Dashboards should be returned - **starred** Flag indicating if only starred Dashboards should be returned
- **limit** Limit the number of returned results (max is 5000; default is 1000) - **limit** Limit the number of returned results (max is 5000; default is 1000)
- **page** Use this parameter to access hits beyond limit. Numbering starts at 1. limit param acts as page size. Only available in Grafana v6.2+. - **page** Use this parameter to access hits beyond limit. Numbering starts at 1. limit param acts as page size. Only available in Grafana v6.2+.
@ -42,7 +42,7 @@ Query parameters:
**Example request for retrieving folders and dashboards at the root level**: **Example request for retrieving folders and dashboards at the root level**:
```http ```http
GET /api/search?folderIds=0&query=&starred=false HTTP/1.1 GET /api/search?query=&starred=false HTTP/1.1
Accept: application/json Accept: application/json
Content-Type: application/json Content-Type: application/json
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk