From 4cf3ebbb3dbd95996c1f1fe084434dd3c696032a Mon Sep 17 00:00:00 2001 From: Isabel Matwawana <76437239+imatwawana@users.noreply.github.com> Date: Tue, 25 Jun 2024 09:51:39 -0400 Subject: [PATCH] Docs: Manage playlists updates (#89573) * Made updates to add dashboard controls changes; also fixed styling issues and consolidated some tasks * Made minor edits * Committed suggestion from review Co-authored-by: Ivan Ortega Alba * Update docs/sources/dashboards/create-manage-playlists/index.md Co-authored-by: Isabel Matwawana <76437239+imatwawana@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: Isabel Matwawana <76437239+imatwawana@users.noreply.github.com> --------- Co-authored-by: Ivan Ortega Alba --- .../create-manage-playlists/index.md | 136 ++++++++---------- 1 file changed, 57 insertions(+), 79 deletions(-) diff --git a/docs/sources/dashboards/create-manage-playlists/index.md b/docs/sources/dashboards/create-manage-playlists/index.md index 20acca7382cc..0b916eeb488f 100644 --- a/docs/sources/dashboards/create-manage-playlists/index.md +++ b/docs/sources/dashboards/create-manage-playlists/index.md @@ -28,34 +28,41 @@ You can access the Playlist feature from Grafana's side menu, in the Dashboards ## Access, share, and control a playlist -Use the information in this section to access existing playlists. Start and control the display of a playlist using one of the five available modes. +Use the information in this section to access playlists. Start and control the display of a playlist using one of the six available modes. ### Access a playlist -1. Click **Dashboards** in the left-side menu. -1. Click **Playlists** to see a list of existing playlists. +1. Click **Dashboards** in the main menu. +1. Click **Playlists** to see a list of playlists. ### Start a playlist -You can start a playlist in five different view modes. View modes determine how the menus and navigation bar appear on the dashboards. +You can start a playlist in six different view modes. View modes determine how the menus and navigation bar appear on the dashboards as well as how panels are sized. -By default, each dashboard is displayed for the amount of time entered in the Interval field, which you set when you create or edit a playlist. After you start a playlist, you can control it with the navbar at the top of the page. +1. Click **Dashboards** in the main menu. +1. Click **Playlists**. +1. Find the desired playlist and click **Start playlist**. +1. In the dialog box that opens, select one of the [six playlist modes](#playlist-modes) available. +1. Disable any dashboard controls that you don't want displayed while the list plays; these controls are enabled and visible by default. Select from: + + - **Time and refresh** + - **Variables** + - **Dashboard links** -1. Click **Dashboards** in the left-side menu. -1. Click **Playlists** to see a list of existing playlists. -1. Find the playlist you want to start, then click **Start playlist**. -1. In the modal that opens, select one of the five playlist modes available, based on the information in the table below. 1. Click **Start \**. -The playlist displays each dashboard for the time specified in the **Interval** field, set when creating or editing a playlist. Once a playlist starts, you can [control](#control-a-playlist) it using the navbar at the top of your screen. +The playlist displays each dashboard for the time specified in the **Interval** field, set when creating or editing a playlist. After a playlist starts, you can [control](#control-a-playlist) it using the navbar at the top of your screen. -| Mode | Description | -| --------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| Normal mode |
  • The side menu remains visible.
  • The navbar, row, and panel controls appear at the top of the screen.
| -| TV mode |
  • The side menu and dashboard submenu (including variable drop-downs and dashboard links) are hidden or removed.
  • The navbar, row, and panel controls appear at the top of the screen.
  • Enabled automatically after one minute of user inactivity.
  • Enable it manually using the `d v` sequence shortcut, or by appending the parameter `?inactive` to the dashboard URL.
  • Disable it with any mouse movement or keyboard action.
| -| TV mode (with auto fit panels) |
  • The side menu and dashboard submenu (including variable drop-downs and dashboard links) are hidden or 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, ro 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.
    • Dashboard panels automatically adjust to optimize space on screen.
    | +### Playlist modes + +| Mode | Description | +| ---------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| Normal mode |
    • The side menu remains visible.
    • The navbar and dashboard controls appear at the top of the screen.
    | +| Normal mode (with auto fit panels) |
    • The side menu remains visible.
    • The navbar and dashboard controls appear at the top of the screen.
    • Dashboard panels automatically adjust to optimize space on screen.
    | +| TV mode |
    • The side menu is hidden or removed.
    • The navbar and dashboard controls appear at the top of the screen.
    • Enabled automatically after one minute of user inactivity.
    • Enable it manually using the `d v` sequence shortcut, or by appending the parameter `?inactive` to the dashboard URL.
    • Disable it with any mouse movement or keyboard action.
    | +| TV mode (with auto fit panels) |
    • The side menu is hidden or removed.
    • The navbar and dashboard controls appear at the top of the screen.
    • Dashboard panels automatically adjust to optimize space on screen.
      | +| Kiosk mode |
      • The side menu is hidden or removed.
      • The navbar and dashboard controls appear at the top of the screen.
      • You can disable or enable it manually using the `d v` sequence shortcut after the playlist has started.
      | +| Kiosk mode (with auto fit panels) |
      • The side menu is hidden or removed.
      • The navbar and dashboard controls appear at the top of the screen.
      • You can disable or enable it manually using the `d v` sequence shortcut after the playlist has started.
      • Dashboard panels automatically adjust to optimize space on screen.
      | ### Control a playlist @@ -72,79 +79,50 @@ You can control a playlist in **Normal** or **TV** mode after it's started, usin ## Create a playlist -You can create a playlist to present dashboards in a sequence, with a set order and time interval between dashboards. +You can create a playlist to present dashboards in a sequence, with a set order and time interval between dashboards. Be sure that all the dashboards you want to appear in your playlist are added before you create the playlist. + +1. Click **Dashboards** in the main menu. +1. Click **Playlists**. +1. Click **New playlist**. +1. In the **Name** field, enter a descriptive name. +1. In the **Interval** field, enter the time interval each dashboard is displayed before moving on to the next dashboard. +1. In the **Add dashboards** section, add dashboards to the playlist using the **Add by title** and **Add by tag** drop-down options. + + Added dashboards are displayed in a list in the **Dashboards** section of the page, in the order you added them. This is also the play order of the dashboards. -1. Click **Dashboards** in the left-side menu. -1. Click **Playlists** to see a list of existing playlists. -1. Click **New playlist**. The New playlist page opens. -1. In the **Name** text box, enter a descriptive name. -1. In the **Interval** text box, enter a time interval. Grafana displays a particular dashboard for the interval of time specified here before moving on to the next dashboard. -1. In Dashboards, add existing dashboards to the playlist using **Add by title** and **Add by tag** drop-down options. The dashboards you add are listed in a sequential order. -1. If needed: - - Search for a dashboard by its name, a regular expression, or a tag. - - Filter your results by starred status or tags. -1. If needed, rearrange the order of the dashboard you have added using the up and down arrow icon. -1. Optionally, remove a dashboard from the playlist by clicking the x icon beside dashboard. 1. Click **Save**. -## Save a playlist +## Edit a playlist -You can save a playlist and 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 edit a playlist including adding, removing, and rearranging the order of dashboards. + +1. Click **Dashboards** in the main menu. +1. Click **Playlists**. +1. Find the playlist you want to update and click **Edit playlist**. Do one or more of the following: + + - Edit - Update the name and time interval. + - Add dashboards - Search for dashboards by title or tag to add them to the playlist. + - Rearrange dashboards - Click and drag the dashboards into your desired order. + - Remove dashboards - Click the **X** next to the name of the dashboard you want to remove from the playlist. -1. Click **Dashboards** in the left-side menu. -1. Click **Playlists** to see a list of existing playlists. -1. Click on the playlist. -1. Edit the playlist. -1. Ensure that your playlist has a **Name**, **Interval**, and at least one **Dashboard** added to it. 1. Click **Save**. -## Edit or delete a playlist - -You can edit a playlist by updating its name, interval time, and by adding, removing, and rearranging the order of dashboards. On the rare occasion when you no longer need a playlist, you can delete it. - -### Edit a playlist - -1. Click **Dashboards** in the left-side menu. -1. Click **Playlists** to see a list of existing playlists. -1. Find the playlist you want to update and click **Edit playlist**. -1. Update the name and time interval, then add or remove dashboards from the playlist using instructions in [Create a playlist](#create-a-playlist). -1. Click **Save** to save your changes. - -### Delete a playlist - -1. Click **Dashboards** in the left-side menu. -1. Click **Playlists** to see a list of existing playlists. -1. Find the playlist you want to remove. -1. Click **Delete playlist**. - -### Rearrange dashboard order - -1. Click **Dashboards** in the left-side menu. -1. Click **Playlists** to see a list of existing playlists. -1. Find the playlist you want to update and click **Edit playlist**. -1. Click and drag the dashboards into your desired order. -1. Click **Save** to save your changes. - -### Remove a dashboard - -1. Click **Dashboards** in the left-side menu. -1. Click **Playlists** to see a list of existing playlists. -1. Find the playlist you want to update and click **Edit playlist**. -1. Click **\[x\]** on the name of the dashboard you want to remove from the playlist. -1. Click **Save** to save your changes. - ## 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. -1. Click **Dashboards** in the left-side menu. -1. Click **Playlists** to see a list of existing playlists. +1. Click **Dashboards** in the main menu. +1. Click **Playlists**. 1. Click the share icon of the playlist you want to share. 1. Select the view mode you prefer. -1. Click **Copy** next to the Link URL to copy it to your clipboard. - - For 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). - +1. Click **Copy** next to the **Link URL** to copy it to your clipboard. 1. Paste the URL to your destination. + +## Delete a playlist + +When you no longer need a playlist, follow these steps to delete it: + +1. Click **Dashboards** in the main menu. +1. Click **Playlists**. +1. Find the playlist you want to remove. +1. Click **Delete playlist**.