From a7425f875e787c482a151cfaa45fd0a96a901447 Mon Sep 17 00:00:00 2001 From: Ashley Harrison Date: Fri, 8 Sep 2023 03:57:16 +0100 Subject: [PATCH] Browse Dashboards: Update docs to remove reference to `General` folder (#74528) * update documentation to remove mention of General folder * update swagger-tags --- docs/sources/administration/provisioning/index.md | 4 ++-- docs/sources/dashboards/share-dashboards-panels/index.md | 2 +- docs/sources/developers/http_api/dashboard.md | 2 +- docs/sources/developers/http_api/folder.md | 5 ----- docs/sources/developers/http_api/folder_dashboard_search.md | 4 ++-- docs/sources/developers/http_api/library_element.md | 4 ++-- pkg/api/swagger_tags.json | 2 +- public/api-merged.json | 2 +- public/openapi3.json | 2 +- 9 files changed, 11 insertions(+), 16 deletions(-) diff --git a/docs/sources/administration/provisioning/index.md b/docs/sources/administration/provisioning/index.md index 61252affed8..7e3d90f15ec 100644 --- a/docs/sources/administration/provisioning/index.md +++ b/docs/sources/administration/provisioning/index.md @@ -343,7 +343,7 @@ providers: When Grafana starts, it will update/insert all dashboards available in the configured path. Then later on poll that path every **updateIntervalSeconds** and look for updated json files and update/insert those into the database. -> **Note:** Dashboards are provisioned to the General folder if the `folder` option is missing or empty. +> **Note:** Dashboards are provisioned to the root level if the `folder` option is missing or empty. #### Making changes to a provisioned dashboard @@ -413,7 +413,7 @@ providers: {{% /admonition %}} {{% admonition type="note" %}} -To provision dashboards to the General folder, store them in the root of your `path`. +To provision dashboards to the root level, store them in the root of your `path`. {{% /admonition %}} ## Alerting diff --git a/docs/sources/dashboards/share-dashboards-panels/index.md b/docs/sources/dashboards/share-dashboards-panels/index.md index 07295943ad4..ee5ef2e5a24 100644 --- a/docs/sources/dashboards/share-dashboards-panels/index.md +++ b/docs/sources/dashboards/share-dashboards-panels/index.md @@ -188,6 +188,6 @@ To create a library panel from the **Share Panel** dialog: 1. Click **Library panel**. 1. In **Library panel name**, enter the name. -1. In **Save in folder**, select the folder in which to save the library panel. By default, the General folder is selected. +1. In **Save in folder**, select the folder in which to save the library panel. By default, the root level is selected. 1. Click **Create library panel** to save your changes. 1. Save the dashboard. diff --git a/docs/sources/developers/http_api/dashboard.md b/docs/sources/developers/http_api/dashboard.md index 3ccee1a6d0a..05dcb8294c4 100644 --- a/docs/sources/developers/http_api/dashboard.md +++ b/docs/sources/developers/http_api/dashboard.md @@ -35,7 +35,7 @@ The uid can have a maximum length of 40 characters. `POST /api/dashboards/db` -Creates a new dashboard or updates an existing dashboard. When updating existing dashboards, if you do not define the `folderId` or the `folderUid` property, then the dashboard(s) are moved to the General folder. (You need to define only one property, not both). +Creates a new dashboard or updates an existing dashboard. When updating existing dashboards, if you do not define the `folderId` or the `folderUid` property, then the dashboard(s) are moved to the root level. (You need to define only one property, not both). **Required permissions** diff --git a/docs/sources/developers/http_api/folder.md b/docs/sources/developers/http_api/folder.md index 09fe3317a35..2269e0635c6 100644 --- a/docs/sources/developers/http_api/folder.md +++ b/docs/sources/developers/http_api/folder.md @@ -28,11 +28,6 @@ The unique identifier (uid) of a folder can be used for uniquely identify folder The uid can have a maximum length of 40 characters. -## A note about the General folder - -The General folder (id=0) is special and is not part of the Folder API which means -that you cannot use this API for retrieving information about the General folder. - ## Get all folders `GET /api/folders` diff --git a/docs/sources/developers/http_api/folder_dashboard_search.md b/docs/sources/developers/http_api/folder_dashboard_search.md index 68c2a6bfa5f..13becff4d0e 100644 --- a/docs/sources/developers/http_api/folder_dashboard_search.md +++ b/docs/sources/developers/http_api/folder_dashboard_search.md @@ -39,7 +39,7 @@ Query parameters: - **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+. -**Example request for retrieving folders and dashboards of the general folder**: +**Example request for retrieving folders and dashboards at the root level**: ```http GET /api/search?folderIds=0&query=&starred=false HTTP/1.1 @@ -48,7 +48,7 @@ Content-Type: application/json Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk ``` -**Example response for retrieving folders and dashboards of the general folder**: +**Example response for retrieving folders and dashboards at the root level**: ```http HTTP/1.1 200 diff --git a/docs/sources/developers/http_api/library_element.md b/docs/sources/developers/http_api/library_element.md index 8ade1b876d8..c6efb1df45a 100644 --- a/docs/sources/developers/http_api/library_element.md +++ b/docs/sources/developers/http_api/library_element.md @@ -282,7 +282,7 @@ Creates a new library element. JSON Body schema: - `folderId`: ID of the folder where the library element is stored. It is deprecated since Grafana v9 -- `folderUid`: Optional, the UID of the folder where the library element is stored, empty string when it is General folder +- `folderUid`: Optional, the UID of the folder where the library element is stored, empty string when it is at the root level. - `name`: Optional, the name of the library element. - `model`: The JSON model for the library element. - `kind`: Kind of element to create, Use `1` for library panels or `2` for library variables. @@ -361,7 +361,7 @@ Updates an existing library element identified by uid. JSON Body schema: - `folderId`: ID of the folder where the library element is stored. It is deprecated since Grafana v9 -- `folderUid`: UID of the folder where the library element is stored, empty string when it is General folder. +- `folderUid`: UID of the folder where the library element is stored, empty string when it is at the root level. - `name`: Name of the library element. - `model`: The JSON model for the library element. - `kind`: Kind of element to create. Use `1` for library panels or `2` for library variables. diff --git a/pkg/api/swagger_tags.json b/pkg/api/swagger_tags.json index 43228f641f4..149059186b9 100644 --- a/pkg/api/swagger_tags.json +++ b/pkg/api/swagger_tags.json @@ -6,7 +6,7 @@ }, { "name": "folders", - "description": "Folders are identified by the identifier (id) and the unique identifier (uid).\nThe identifier (id) of a folder is an auto-incrementing numeric value and is only unique per Grafana install.\nThe unique identifier (uid) of a folder can be used for uniquely identify folders between multiple Grafana installs. It’s automatically generated if not provided when creating a folder. The uid allows having consistent URLs for accessing folders and when syncing folders between multiple Grafana installs. This means that changing the title of a folder will not break any bookmarked links to that folder.\nThe uid can have a maximum length of 40 characters.\n\nThe General folder (id=0) is special and is not part of the Folder API which means that you cannot use this API for retrieving information about the General folder." + "description": "Folders are identified by the identifier (id) and the unique identifier (uid).\nThe identifier (id) of a folder is an auto-incrementing numeric value and is only unique per Grafana install.\nThe unique identifier (uid) of a folder can be used for uniquely identify folders between multiple Grafana installs. It’s automatically generated if not provided when creating a folder. The uid allows having consistent URLs for accessing folders and when syncing folders between multiple Grafana installs. This means that changing the title of a folder will not break any bookmarked links to that folder.\nThe uid can have a maximum length of 40 characters." }, { "name": "folder_permissions", diff --git a/public/api-merged.json b/public/api-merged.json index 134364a792f..8b9f5927e3d 100644 --- a/public/api-merged.json +++ b/public/api-merged.json @@ -21519,7 +21519,7 @@ "name": "datasources" }, { - "description": "Folders are identified by the identifier (id) and the unique identifier (uid).\nThe identifier (id) of a folder is an auto-incrementing numeric value and is only unique per Grafana install.\nThe unique identifier (uid) of a folder can be used for uniquely identify folders between multiple Grafana installs. It’s automatically generated if not provided when creating a folder. The uid allows having consistent URLs for accessing folders and when syncing folders between multiple Grafana installs. This means that changing the title of a folder will not break any bookmarked links to that folder.\nThe uid can have a maximum length of 40 characters.\n\nThe General folder (id=0) is special and is not part of the Folder API which means that you cannot use this API for retrieving information about the General folder.", + "description": "Folders are identified by the identifier (id) and the unique identifier (uid).\nThe identifier (id) of a folder is an auto-incrementing numeric value and is only unique per Grafana install.\nThe unique identifier (uid) of a folder can be used for uniquely identify folders between multiple Grafana installs. It’s automatically generated if not provided when creating a folder. The uid allows having consistent URLs for accessing folders and when syncing folders between multiple Grafana installs. This means that changing the title of a folder will not break any bookmarked links to that folder.\nThe uid can have a maximum length of 40 characters.", "name": "folders" }, { diff --git a/public/openapi3.json b/public/openapi3.json index be89f9fd356..994382f0266 100644 --- a/public/openapi3.json +++ b/public/openapi3.json @@ -22979,7 +22979,7 @@ "name": "datasources" }, { - "description": "Folders are identified by the identifier (id) and the unique identifier (uid).\nThe identifier (id) of a folder is an auto-incrementing numeric value and is only unique per Grafana install.\nThe unique identifier (uid) of a folder can be used for uniquely identify folders between multiple Grafana installs. It’s automatically generated if not provided when creating a folder. The uid allows having consistent URLs for accessing folders and when syncing folders between multiple Grafana installs. This means that changing the title of a folder will not break any bookmarked links to that folder.\nThe uid can have a maximum length of 40 characters.\n\nThe General folder (id=0) is special and is not part of the Folder API which means that you cannot use this API for retrieving information about the General folder.", + "description": "Folders are identified by the identifier (id) and the unique identifier (uid).\nThe identifier (id) of a folder is an auto-incrementing numeric value and is only unique per Grafana install.\nThe unique identifier (uid) of a folder can be used for uniquely identify folders between multiple Grafana installs. It’s automatically generated if not provided when creating a folder. The uid allows having consistent URLs for accessing folders and when syncing folders between multiple Grafana installs. This means that changing the title of a folder will not break any bookmarked links to that folder.\nThe uid can have a maximum length of 40 characters.", "name": "folders" }, {