From a6ef2cda29ea680891c3b54cb499427be5cb15a2 Mon Sep 17 00:00:00 2001 From: achatterjee-grafana <70489351+achatterjee-grafana@users.noreply.github.com> Date: Tue, 5 Oct 2021 20:41:20 -0400 Subject: [PATCH] Doc: Fix escalation issue 903 (#40034) (#40036) * First set of reorg of Playlist topic. Also fixed a broken bookmark in Azure authentication topic. * More re-org. * Added note requested in issue 903. * Updated a note added dashboard HTTP API endpoint. * Update docs/sources/dashboards/playlist.md Co-authored-by: Fiona Artiaga <89225282+GrafanaWriter@users.noreply.github.com> * Update docs/sources/dashboards/playlist.md Co-authored-by: Fiona Artiaga <89225282+GrafanaWriter@users.noreply.github.com> * Update docs/sources/dashboards/playlist.md Co-authored-by: Fiona Artiaga <89225282+GrafanaWriter@users.noreply.github.com> * Update docs/sources/dashboards/playlist.md Co-authored-by: Fiona Artiaga <89225282+GrafanaWriter@users.noreply.github.com> * Update docs/sources/dashboards/playlist.md Co-authored-by: Fiona Artiaga <89225282+GrafanaWriter@users.noreply.github.com> * Update docs/sources/dashboards/playlist.md Co-authored-by: Fiona Artiaga <89225282+GrafanaWriter@users.noreply.github.com> * Updated image position and name. Co-authored-by: Fiona Artiaga <89225282+GrafanaWriter@users.noreply.github.com> Co-authored-by: Fiona Artiaga <89225282+GrafanaWriter@users.noreply.github.com> --- docs/sources/auth/azuread.md | 2 +- docs/sources/dashboards/playlist.md | 161 ++++++++++------------------ docs/sources/http_api/dashboard.md | 2 +- 3 files changed, 58 insertions(+), 107 deletions(-) diff --git a/docs/sources/auth/azuread.md b/docs/sources/auth/azuread.md index 7c93f79b1fc..7323f90dad7 100644 --- a/docs/sources/auth/azuread.md +++ b/docs/sources/auth/azuread.md @@ -10,7 +10,7 @@ weight = 700 The Azure AD authentication allows you to use an Azure Active Directory tenant as an identity provider for Grafana. You can use Azure AD Application Roles to assign users and groups to Grafana roles from the Azure Portal. This topic has the following sections: - [Create the Azure AD application](#create-the-azure-ad-application) -- [Enable Azure AD OAuth in Grafana](/#enable-azure-ad-oauth-in-grafana) +- [Enable Azure AD OAuth in Grafana](#enable-azure-ad-oauth-in-grafana) ## Create the Azure AD application diff --git a/docs/sources/dashboards/playlist.md b/docs/sources/dashboards/playlist.md index 404b9e08146..51bea340289 100644 --- a/docs/sources/dashboards/playlist.md +++ b/docs/sources/dashboards/playlist.md @@ -7,121 +7,42 @@ weight = 4 # Playlist -A playlist is a list of dashboards that are displayed in a sequence. You might use a playlist to build situational awareness or to present your metrics to your team or visitors. +A playlist displays a list of dashboards that are in a sequence. Use a playlist to build situational awareness or to present your metrics to your team or visitors. Grafana automatically scales dashboards to any resolution, which makes them perfect for big screens. This topic has the following sections: -Grafana automatically scales dashboards to any resolution, which makes them perfect for big screens. +- [Access, share, and control a playlist](#access-share-and-control-a-playlist) +- [Create a playlist](#create-a-playlist) +- [Edit or delete a playlist](#edit-or-delete-a-playlist) +- [Share a playlist](#share-a-playlist-in-a-view-mode) -You can access the Playlist feature from Grafana's side menu, in the Dashboards submenu. +## Access, share, and control a playlist -{{< figure src="/static/img/docs/v50/playlist.png" max-width="25rem">}} +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. -## Create a playlist +### Access playlist -You create a playlist to present dashboards in a sequence, with a set order and time interval between dashboards. +1. Hover your cursor over Grafana’s side menu. +1. Click **Playlists**. You will see a list of existing playlists. -1. To access the Playlist feature, hover your cursor over Grafana's side menu. -1. Click **Playlists**. -1. Click **New playlist**. -1. In the **Name** text box, enter a name for your playlist. -1. In the **Interval** text box, enter a time interval. +### Start a playlist -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. [Access](#access-playlist) the playlist page to see a list of existing playlists. +1. Find the playlist you want to start, then click **Start playlist**. The start playlist dialog opens. +1. Select one of the five playlist modes available based on the information in the following table. +1. Click **Start **. -1. Next to the dashboard(s) you want to add to your playlist, click **Add to playlist**. -1. Click **Create**. +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. -## Edit a playlist +| Mode | Description | +| --------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| Normal mode | | +| TV mode | | +| TV mode (with auto fit panels) |