Docs: updates for file-based menu (#28500)
* initial * cleanup * remove bad aliases * cleanup, fix links * add docs-file-based-command * update docs * update readme * fix broken links * fix spelling Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com>
This commit is contained in:
Robby Milo
co-authored by
Diana Payton
Diana Payton
parent
a7e092f243
commit
abee02dbcd
@@ -1,10 +1,7 @@
|
||||
+++
|
||||
title = "Dashboard overview"
|
||||
type = "docs"
|
||||
title = "Dashboards"
|
||||
aliases = ["/docs/grafana/latest/features/dashboard/dashboards/"]
|
||||
[menu.docs]
|
||||
identifier = "dashboards"
|
||||
weight = 100
|
||||
weight = 80
|
||||
+++
|
||||
|
||||
# Dashboard overview
|
||||
|
||||
@@ -1,11 +1,7 @@
|
||||
+++
|
||||
title = "Annotations"
|
||||
keywords = ["grafana", "annotations", "documentation", "guide"]
|
||||
type = "docs"
|
||||
aliases = ["/docs/grafana/latest/reference/annotations/"]
|
||||
[menu.docs]
|
||||
name = "Annotations"
|
||||
parent = "dashboard_features"
|
||||
weight = 2
|
||||
+++
|
||||
|
||||
|
||||
@@ -1,11 +1,7 @@
|
||||
+++
|
||||
title = "Dashboard Folders"
|
||||
keywords = ["grafana", "dashboard", "dashboard folders", "folder", "folders", "documentation", "guide"]
|
||||
type = "docs"
|
||||
aliases = ["/docs/grafana/latest/reference/dashboard_folders/"]
|
||||
[menu.docs]
|
||||
name = "Folders"
|
||||
parent = "dashboard_features"
|
||||
weight = 3
|
||||
+++
|
||||
|
||||
|
||||
@@ -1,11 +1,7 @@
|
||||
+++
|
||||
title = "Dashboard Version History"
|
||||
keywords = ["grafana", "dashboard", "documentation", "version", "history"]
|
||||
type = "docs"
|
||||
aliases = ["/docs/grafana/latest/reference/dashboard_history/"]
|
||||
[menu.docs]
|
||||
name = "Dashboard Version History"
|
||||
parent = "dashboard_features"
|
||||
weight = 100
|
||||
+++
|
||||
|
||||
|
||||
@@ -1,10 +1,7 @@
|
||||
+++
|
||||
title = "Export and import"
|
||||
keywords = ["grafana", "dashboard", "documentation", "export", "import"]
|
||||
type = "docs"
|
||||
aliases = ["/docs/grafana/latest/reference/export_import/"]
|
||||
[menu.docs]
|
||||
parent = "dashboard_features"
|
||||
weight = 800
|
||||
+++
|
||||
|
||||
@@ -30,7 +27,7 @@ the dashboard, and will also be added as a required input when the dashboard is
|
||||
|
||||
## Importing a dashboard
|
||||
|
||||
To import a dashboard click the + icon in the side menu, and then click **Import**.
|
||||
To import a dashboard click the + icon in the side menu, and then click **Import**.
|
||||
|
||||
{{< docs-imagebox img="/img/docs/v70/import_step1.png" max-width="700px" >}}
|
||||
|
||||
|
||||
@@ -1,11 +1,7 @@
|
||||
+++
|
||||
title = "JSON model"
|
||||
keywords = ["grafana", "dashboard", "documentation", "json", "model"]
|
||||
type = "docs"
|
||||
aliases = ["/docs/grafana/latest/reference/dashboard/"]
|
||||
[menu.docs]
|
||||
name = "JSON Model"
|
||||
parent = "dashboard_features"
|
||||
weight = 1200
|
||||
+++
|
||||
|
||||
|
||||
@@ -1,11 +1,7 @@
|
||||
+++
|
||||
title = "Playlist"
|
||||
keywords = ["grafana", "dashboard", "documentation", "playlist"]
|
||||
type = "docs"
|
||||
aliases = ["/docs/grafana/latest/reference/playlist/"]
|
||||
[menu.docs]
|
||||
parent = "dashboard_features"
|
||||
identifier = "feature_playlist"
|
||||
weight = 4
|
||||
+++
|
||||
|
||||
@@ -22,7 +18,7 @@ You can access the Playlist feature from Grafana's side menu, in the Dashboards
|
||||
|
||||
## Create a playlist
|
||||
|
||||
You create a playlist to present dashboards in a sequence, with a set order and time interval between dashboards.
|
||||
You create a playlist to present dashboards in a sequence, with a set order and time interval between dashboards.
|
||||
|
||||
1. To access the Playlist feature, hover your cursor over Grafana's side menu.
|
||||
1. Click **Playlists**.
|
||||
@@ -32,7 +28,7 @@ You create a playlist to present dashboards in a sequence, with a set order and
|
||||
|
||||
The time interval is the amount of time for Grafana to stay on a particular dashboard before advancing to the next one on the playlist.
|
||||
|
||||
1. Next to the dashboard(s) you want to add to your playlist, click **Add to playlist**.
|
||||
1. Next to the dashboard(s) you want to add to your playlist, click **Add to playlist**.
|
||||
1. Click **Create**.
|
||||
|
||||
## Edit a playlist
|
||||
@@ -46,7 +42,7 @@ You can edit playlists while creating them or after saving them.
|
||||
### Edit the Name of a playlist
|
||||
|
||||
1. Double-click within the **Name** text box.
|
||||
1. Enter a name.
|
||||
1. Enter a name.
|
||||
1. Click **Save** to save your changes.
|
||||
|
||||
### Edit the Interval of a playlist
|
||||
@@ -62,9 +58,9 @@ You can edit playlists while creating them or after saving them.
|
||||
|
||||
### Search for a dashboard to add
|
||||
|
||||
1. Click the **Search dashboards by name** text box.
|
||||
1. Search for the playlist by name or regular expression.
|
||||
1. If needed, filter your results by starred status or tags.
|
||||
1. Click the **Search dashboards by name** text box.
|
||||
1. Search for the playlist by name or regular expression.
|
||||
1. If needed, filter your results by starred status or tags.
|
||||
By default, your starred dashboards will appear as options to add to the Playlist.
|
||||
1. Click **Save** to save your changes.
|
||||
|
||||
@@ -85,18 +81,18 @@ You can edit playlists while creating them or after saving them.
|
||||
|
||||
## Save a playlist
|
||||
|
||||
You can save a playlist to add it to your **Playlists** page, where you can start it. Be sure that all the dashboards you want to appear in your playlist are added when creating or editing the playlist before saving it.
|
||||
You can save a playlist to add it to your **Playlists** page, where you can start it. Be sure that all the dashboards you want to appear in your playlist are added when creating or editing the playlist before saving it.
|
||||
|
||||
1. To access the Playlist feature, hover your cursor over Grafana's side menu.
|
||||
1. Click **Playlists**.
|
||||
1. Click on the playlist.
|
||||
1. Edit the playlist.
|
||||
* Ensure that your playlist has a **Name**, **Interval**, and at least one **Dashboard** added to it.
|
||||
1. Click **Save**.
|
||||
1. Click **Save**.
|
||||
|
||||
## Start a playlist
|
||||
|
||||
You can start a playlist in five different view modes, which determine how the menus and navigation bar are displayed on the dashboards.
|
||||
You can start a playlist in five different view modes, which determine how the menus and navigation bar are displayed on the dashboards.
|
||||
|
||||
By default, each dashboard is displayed for the amount of time entered in the Interval field, which can be set while creating or editing a playlist. Once a playlist is started, it can be controlled using the navbar at the top of your screen.
|
||||
|
||||
@@ -104,24 +100,24 @@ By default, each dashboard is displayed for the amount of time entered in the In
|
||||
1. Next to the playlist you want to start, click **Start playlist**.
|
||||
1. In the dropdown, select the mode you want the playlist to display in.
|
||||
- **Normal mode:**
|
||||
- The side menu remains visible.
|
||||
- The side menu remains visible.
|
||||
- The navbar, row and panel controls appear at the top of the screen.
|
||||
- **TV mode:**
|
||||
- The side menu is hidden/removed.
|
||||
- The side menu is hidden/removed.
|
||||
- The navbar, row and panel controls appear at the top of the screen.
|
||||
- Enabled automatically after one minute of user inactivity.
|
||||
- You can enable it manually using the `d v` sequence shortcut, or by appending the parameter `?inactive` to the dashboard URL.
|
||||
- You can disable it with any mouse movement or keyboard action.
|
||||
- **TV mode (with auto fit panels):**
|
||||
- The side menu is hidden/removed.
|
||||
- You can enable it manually using the `d v` sequence shortcut, or by appending the parameter `?inactive` to the dashboard URL.
|
||||
- You can disable it with any mouse movement or keyboard action.
|
||||
- **TV mode (with auto fit panels):**
|
||||
- The side menu is hidden/removed.
|
||||
- The navbar, row and panel controls appear at the top of the screen.
|
||||
- Dashboard panels automatically adjust to optimize space on screen.
|
||||
- **Kiosk mode:**
|
||||
- The side menu, navbar, row and panel controls are completely hidden/removed from view.
|
||||
- **Kiosk mode:**
|
||||
- The side menu, navbar, row and panel controls are completely hidden/removed from view.
|
||||
- You can enable it manually using the `d v` sequence shortcut after the playlist has started.
|
||||
- You can disable it manually with the same shortcut.
|
||||
- **Kiosk mode (with auto fit panels):**
|
||||
- The side menu, navbar, row and panel controls are completely hidden/removed from view.
|
||||
- **Kiosk mode (with auto fit panels):**
|
||||
- The side menu, navbar, row and panel controls are completely hidden/removed from view.
|
||||
- Dashboard panels automatically adjust to optimize space on screen.
|
||||
|
||||
## Control a playlist
|
||||
@@ -141,12 +137,12 @@ You can control a playlist in **Normal** or **TV** mode after it's started, usin
|
||||
|
||||
## Share a playlist in a view mode
|
||||
|
||||
You can share a playlist by copying the link address on the view mode you prefer, and pasting the URL to your destination.
|
||||
You can share a playlist by copying the link address on the view mode you prefer, and pasting the URL to your destination.
|
||||
|
||||
1. From the Dashboards submenu, click **Playlists**.
|
||||
1. Next to the playlist you want to share, click **Start playlist**.
|
||||
1. In the dropdown, right click the view mode you prefer.
|
||||
1. Click **Copy Link Address** to copy the URL to your clipboard.
|
||||
1. Click **Copy Link Address** to copy the URL to your clipboard.
|
||||
|
||||
Example: The URL for the first playlist on the Grafana Play site in Kiosk mode will look like this:
|
||||
[https://play.grafana.org/playlists/play/1?kiosk](https://play.grafana.org/playlists/play/1?kiosk).
|
||||
|
||||
@@ -2,10 +2,7 @@
|
||||
title = "Reporting"
|
||||
description = ""
|
||||
keywords = ["grafana", "reporting"]
|
||||
type = "docs"
|
||||
aliases = ["/docs/grafana/latest/administration/reports"]
|
||||
[menu.docs]
|
||||
parent = "features"
|
||||
weight = 8
|
||||
+++
|
||||
|
||||
|
||||
@@ -1,10 +1,7 @@
|
||||
+++
|
||||
title = "Scripted dashboards"
|
||||
keywords = ["grafana", "dashboard", "documentation", "scripted"]
|
||||
type = "docs"
|
||||
aliases = ["/docs/grafana/latest/reference/scripting/"]
|
||||
[menu.docs]
|
||||
parent = "dashboard_features"
|
||||
weight = 1500
|
||||
+++
|
||||
|
||||
|
||||
@@ -1,10 +1,7 @@
|
||||
+++
|
||||
title = "Search"
|
||||
keywords = ["grafana", "dashboard", "documentation", "search"]
|
||||
type = "docs"
|
||||
aliases =["/docs/grafana/latest/reference/search/"]
|
||||
[menu.docs]
|
||||
parent = "dashboard_features"
|
||||
weight = 5
|
||||
+++
|
||||
|
||||
|
||||
@@ -1,10 +1,7 @@
|
||||
+++
|
||||
title = "Share dashboard"
|
||||
keywords = ["grafana", "dashboard", "documentation", "sharing"]
|
||||
type = "docs"
|
||||
aliases = ["/docs/grafana/latest/reference/share_dashboard/"]
|
||||
[menu.docs]
|
||||
parent = "dashboard_features"
|
||||
weight = 500
|
||||
+++
|
||||
|
||||
|
||||
@@ -1,10 +1,7 @@
|
||||
+++
|
||||
title = "Share panel"
|
||||
keywords = ["grafana", "dashboard", "documentation", "sharing"]
|
||||
type = "docs"
|
||||
aliases = ["/docs/grafana/latest/reference/share_panel/"]
|
||||
[menu.docs]
|
||||
parent = "dashboard_features"
|
||||
weight = 600
|
||||
+++
|
||||
|
||||
|
||||
@@ -1,8 +1,5 @@
|
||||
+++
|
||||
title = "Keyboard shortcuts"
|
||||
type = "docs"
|
||||
[menu.docs]
|
||||
parent = "features"
|
||||
weight = 7
|
||||
+++
|
||||
|
||||
|
||||
@@ -2,10 +2,6 @@
|
||||
title = "Time range controls"
|
||||
keywords = ["grafana", "dashboard", "documentation", "time range"]
|
||||
aliases = ["/docs/grafana/latest/reference/timerange/"]
|
||||
type = "docs"
|
||||
[menu.docs]
|
||||
name = "Time range controls"
|
||||
parent = "dashboards"
|
||||
weight = 7
|
||||
+++
|
||||
|
||||
|
||||
Reference in New Issue
Block a user