PackageJson: Prettify markdown/mdx on commit with lint-staged (#37616)
* Format md,mdx files with prettier on lint-staged * Manually run prettier on docs/sources
This commit is contained in:
Connor Lindsey
@@ -6,6 +6,7 @@ weight = 85
|
||||
# Sharing dashboards and panels
|
||||
|
||||
Grafana allows you to share dashboards and panels with other users within an organization and in certain situations, publicly on the Web. You can share using:
|
||||
|
||||
- A direct link
|
||||
- A Snapshot
|
||||
- An embedded link (for panels only)
|
||||
@@ -15,8 +16,8 @@ Refer to [Share a dashboard]({{< relref "share-dashboard.md" >}}) and [Share a p
|
||||
|
||||
You must have an authorized viewer permission to see an image rendered by a direct link.
|
||||
|
||||
The same permission is also required to view embedded links unless you have anonymous access permission enabled for your Grafana instance.
|
||||
The same permission is also required to view embedded links unless you have anonymous access permission enabled for your Grafana instance.
|
||||
|
||||
*> Note:** As of Grafana 8.0, anonymous access permission is no available for Grafana Cloud.
|
||||
\*> Note:\*\* As of Grafana 8.0, anonymous access permission is no available for Grafana Cloud.
|
||||
|
||||
When you share a panel or dashboard as a snapshot, a snapshot (of the panel or the dashboard at that moment in time) is publicly available on the web. Anyone with a link to it can access it. Since snapshots do not need any authorization to view, Grafana strips information related to the account it came from, as well as any sensitive data from the snapshot.
|
||||
|
||||
@@ -5,10 +5,10 @@ weight = 4
|
||||
draft = "true"
|
||||
+++
|
||||
|
||||
|
||||
# Playlists
|
||||
|
||||
A _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.
|
||||
|
||||
Grafana automatically scales dashboards to any resolution, which makes them perfect for big screens.
|
||||
@@ -88,7 +88,7 @@ You can save a playlist to add it to your **Playlists** page, where you can star
|
||||
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.
|
||||
- Ensure that your playlist has a **Name**, **Interval**, and at least one **Dashboard** added to it.
|
||||
1. Click **Save**.
|
||||
|
||||
## Start a playlist
|
||||
@@ -101,38 +101,38 @@ 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 navbar, row and panel controls appear at the top of the screen.
|
||||
- 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 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 mouse movement or keyboard action.
|
||||
- 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 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.
|
||||
- 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.
|
||||
- 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.
|
||||
- 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.
|
||||
- Dashboard panels automatically adjust to optimize space on screen.
|
||||
- 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
|
||||
|
||||
You can control a playlist in **Normal** or **TV** mode after it's started, using the navigation bar at the top of your screen.
|
||||
|
||||
| Button | Result |
|
||||
| --- | --- |
|
||||
| Next (double-right arrow) | Advances to the next dashboard. |
|
||||
| Back (left arrow) | Returns to the previous dashboard. |
|
||||
| Stop (square) | Ends the playlist, and exits to the current dashboard. |
|
||||
| Cycle view mode (monitor icon) | Rotates the display of the dashboards in different view modes. |
|
||||
| Time range | Displays data within a time range. It can be set to display the last 5 minutes up to 5 years ago, or a custom time range, using the down arrow. |
|
||||
| Refresh (circle arrow) | Reloads the dashboard, to display the current data. It can be set to reload automatically every 5 seconds to 1 day, using the drop down arrow. |
|
||||
| Button | Result |
|
||||
| ------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| Next (double-right arrow) | Advances to the next dashboard. |
|
||||
| Back (left arrow) | Returns to the previous dashboard. |
|
||||
| Stop (square) | Ends the playlist, and exits to the current dashboard. |
|
||||
| Cycle view mode (monitor icon) | Rotates the display of the dashboards in different view modes. |
|
||||
| Time range | Displays data within a time range. It can be set to display the last 5 minutes up to 5 years ago, or a custom time range, using the down arrow. |
|
||||
| Refresh (circle arrow) | Reloads the dashboard, to display the current data. It can be set to reload automatically every 5 seconds to 1 day, using the drop down arrow. |
|
||||
|
||||
> Shortcut: Press the Esc key to stop the playlist from your keyboard.
|
||||
|
||||
@@ -140,11 +140,13 @@ You can control a playlist in **Normal** or **TV** mode after it's started, usin
|
||||
|
||||
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. 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.
|
||||
|
||||
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. Paste the URL to your destination.
|
||||
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. Paste the URL to your destination.
|
||||
|
||||
@@ -15,6 +15,7 @@ To share a dashboard:
|
||||
1. Click on the share icon in the top navigation. The share dialog opens and shows the Link tab.
|
||||
|
||||
|
||||
|
||||
## Use direct link
|
||||
|
||||
The Link tab has the current time range, template variables and theme selected by default. You can optionally select a shortened URL to share.
|
||||
|
||||
@@ -7,7 +7,7 @@ weight = 6
|
||||
|
||||
# Share a panel
|
||||
|
||||
You can share a panel as a direct link, as a snapshot or as an embedded link. You can also create library panels using the “Share” option for any panel.
|
||||
You can share a panel as a direct link, as a snapshot or as an embedded link. You can also create library panels using the “Share” option for any panel.
|
||||
|
||||
To share a panel:
|
||||
|
||||
@@ -33,6 +33,7 @@ Here is an example of a link to a server-side rendered PNG:
|
||||
```bash
|
||||
https://play.grafana.org/d/000000012/grafana-play-home?orgId=1&from=1568719680173&to=1568726880174&panelId=4&fullscreen
|
||||
```
|
||||
|
||||
#### Query string parameters for server-side rendered images
|
||||
|
||||
- **width:** width in pixels. Default is 800.
|
||||
@@ -59,7 +60,7 @@ If you created a snapshot by mistake, click **delete snapshot** to remove the sn
|
||||
|
||||
## Embed panel
|
||||
|
||||
You can embed a panel using an iframe on another web site. A viewer must be signed into Grafana to view the graph.
|
||||
You can embed a panel using an iframe on another web site. A viewer must be signed into Grafana to view the graph.
|
||||
|
||||
**> Note:** As of Grafana 8.0, anonymous access permission is no available for Grafana Cloud.
|
||||
|
||||
@@ -68,7 +69,12 @@ You can embed a panel using an iframe on another web site. A viewer must be sign
|
||||
Here is an example of the HTML code:
|
||||
|
||||
```html
|
||||
<iframe src="https://snapshot.raintank.io/dashboard-solo/snapshot/y7zwi2bZ7FcoTlB93WN7yWO4aMiz3pZb?from=1493369923321&to=1493377123321&panelId=4" width="650" height="300" frameborder="0"></iframe>
|
||||
<iframe
|
||||
src="https://snapshot.raintank.io/dashboard-solo/snapshot/y7zwi2bZ7FcoTlB93WN7yWO4aMiz3pZb?from=1493369923321&to=1493377123321&panelId=4"
|
||||
width="650"
|
||||
height="300"
|
||||
frameborder="0"
|
||||
></iframe>
|
||||
```
|
||||
|
||||
The result is an interactive Grafana graph embedded in an iframe:
|
||||
@@ -79,9 +85,9 @@ The result is an interactive Grafana graph embedded in an iframe:
|
||||
|
||||
To create a library panel from the Share Panel dialog:
|
||||
|
||||
1. Click **Library panel**.
|
||||
1. Click **Library panel**.
|
||||
{{< figure src="/static/img/docs/library-panels/create-lib-panel-8-0.png" class="docs-image--no-shadow" max-width= "900px" caption="Screenshot of the create library panel dialog" >}}
|
||||
1. In **Library panel name**, enter the name.
|
||||
1. In **Save in folder**, select the folder to save the library panel. By default, the General folder is selected.
|
||||
1. Click **Create library panel** to save your changes.
|
||||
1. Save the dashboard.
|
||||
1. Save the dashboard.
|
||||
|
||||
Reference in New Issue
Block a user