Commit 5b8544e5 by achatterjee-grafana Committed by GitHub

Share panel dashboard add images (#30201)

* Added 2 image links.

* Fixed a typo

* Fixed one more typo

* Added images to the  "Share a panel" and "Share a dashboard" topics.

* Updated title of the section on panel embed.

* Update docs/sources/sharing/share-dashboard.md

Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com>

* Fixed numbering.

Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com>
parent ad5762cd
......@@ -14,6 +14,8 @@ To share a dashboard:
1. Go to the home page of your Grafana instance.
1. Click on the share icon in the top navigation. The share dialog opens and shows the Link tab.
{{< docs-imagebox img="/img/docs/sharing/Share_Dashboard_Direct_Link.png" max-width="700px" >}}
## 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.
......@@ -23,7 +25,7 @@ To share a direct link:
1. Click **Copy**. This copies the default or the shortened URL to the clipboard.
1. Send the copied URL to a Grafana user with authorization to view the link.
## Publish snapshots
## Publish a snapshot
A dashboard snapshot shares an interactive dashboard publicly. Grafana strips sensitive data like queries
(metric, template and annotation) and panel links, leaving only the visible metric data and series names embedded into your dashboard. Dashboard snapshots can be accessed by anyone with the link.
......@@ -31,7 +33,7 @@ A dashboard snapshot shares an interactive dashboard publicly. Grafana strips se
You can publish snapshots to your local instance or to [snapshot.raintank.io](http://snapshot.raintank.io). The latter is a free service
provided by Grafana Labs that allows you to publish dashboard snapshots to an external Grafana instance. The same rules still apply: anyone with the link can view it. You can set an expiration time if you want the snapshot removed after a certain time period.
{{< docs-imagebox img="/img/docs/v50/share_panel_modal.png" max-width="700px" >}}
{{< docs-imagebox img="/img/docs/sharing/Share_Dashboard_Snapshot.png" max-width="700px" >}}
To publish a snapshot:
......@@ -40,6 +42,8 @@ To publish a snapshot:
In case you created a snapshot by mistake, click **delete snapshot** to remove the snapshot from your Grafana instance.
## Export dashboard
## Dashboard export
Grafana dashboards can easily be exported and imported. For more information, refer to [Export and import dashboards]({{< relref "../dashboards/export-import.md" >}}).
{{< docs-imagebox img="/img/docs/sharing/Share_Dashboard_Export.png" max-width="700px" >}}
......@@ -14,6 +14,8 @@ To share a panel:
1. Click a panel title to open the panel menu.
1. Click **Share**. The share dialog opens and shows the Link tab.
{{< docs-imagebox img="/img/docs/sharing/Share_Panel_Direct_Link.png" max-width="700px" >}}
## Use direct link
The Link tab has the current time range, template variables and theme selected by default. You can optionally enable a shortened URL to share.
......@@ -31,7 +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
#### Query string parameters for server-side rendered images
- **width:** width in pixels. Default is 800.
- **height:** height in pixels. Default is 400.
......@@ -39,12 +41,14 @@ https://play.grafana.org/d/000000012/grafana-play-home?orgId=1&from=156871968017
- **timeout:** number of seconds. The timeout can be increased if the query for the panel needs more than the default 30 seconds.
- **scale:** numeric value to configure device scale factor. Default is 1. Use a higher value to produce more detailed images (higher DPI). Supported in Grafana v7.0+.
## Publish snapshots
## Publish snapshot
A panel snapshot shares an interactive panel publicly. Grafana strips sensitive data leaving only the visible metric data and series names embedded into your dashboard. Panel snapshots can be accessed by anyone with the link.
You can publish snapshots to your local instance or to [snapshot.raintank.io](http://snapshot.raintank.io). The latter is a free service provided by [Raintank](http://raintank.io), that allows you to publish dashboard snapshots to an external Grafana instance. You can optionally set an expiration time if you want the snapshot to be removed after a certain time period.
{{< docs-imagebox img="/img/docs/sharing/Share_Panel_Snapshot.png" max-width="700px" >}}
To publish a snapshot:
1. In the Share Panel dialog, click **Snapshot** to open the tab.
......@@ -57,6 +61,8 @@ If you created a snapshot by mistake, click **delete snapshot** to remove the sn
You can embed a panel using an iframe on another web site. Unless anonymous access permission is enabled, the viewer must be signed into Grafana to view the graph.
{{< docs-imagebox img="/img/docs/sharing/Share_Panel_Embedded_Link.png" max-width="700px" >}}
Here is an example of the HTML code:
```html
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment