Documentation updates (#502)

Add documentation about Nested Folder in yaml and fix references to incorrect `Dashboards`/`DashboardFolders` targets
grafana · Oct 16, 2024 · d736558 · d736558
1 parent 6e2a3ff
commit d736558
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 1 deletion.
diff --git a/docs/content/configuration.md b/docs/content/configuration.md
@@ -64,7 +64,7 @@ wish to use all of these types. It is possible to set a list of "target" resourc
 with:
 
 ```
-grr config set targets Dashboards,DashboardFolders
+grr config set targets Dashboard,DashboardFolder
 ```
 
 These can be overriden on the command line with the `-t` or `--target` flag.

diff --git a/docs/content/grafana.md b/docs/content/grafana.md
@@ -26,6 +26,22 @@ spec:
 
 A folder simply has a name and a title.
 
+## Nested Folders
+Grizzly supports the creation of nested folders.
+To create one, specify the *uid* of the parent folder to a `DashboardFolder` definition:
+
+```yaml
+apiVersion: grizzly.grafana.com/v1alpha1
+kind: DashboardFolder
+metadata:
+  name: nestedFolderSample
+spec:
+  parentUid: sample
+  title: Nested folder
+```
+
+This will create a new folder "Nested folder" under the `sample` folder.
+
 ### Placing Dashboards in Folders
 Dashboards can be placed into folders using the `folder` metadata field. Here, a
 dashboard is placed into the folder defined above:
-Original file line number
+Diff line change
@@ Expand Up @@
     with:
     ```
-    grr config set targets Dashboards,DashboardFolders
+    grr config set targets Dashboard,DashboardFolder
     ```
     These can be overriden on the command line with the `-t` or `--target` flag.
@@ Expand Down @@