mirror of
https://github.com/grafana/grafana.git
synced 2025-07-28 14:12:09 +08:00
Docs: removes dashboard images (#59619)
* removes dashboard images * removes explore and developer docs screenshots
This commit is contained in:

committed by
GitHub

parent
d9f697b41e
commit
3a9d4cc688
@ -28,7 +28,6 @@ When you create a library panel, the panel on the source dashboard is converted
|
|||||||
1. In the panel display options, click the down arrow option to bring changes to the visualization.
|
1. In the panel display options, click the down arrow option to bring changes to the visualization.
|
||||||
{{< figure src="/static/img/docs/library-panels/create-lib-panel-from-edit-8-0.png" class="docs-image--no-shadow" max-width= "800px" caption="Screenshot of the edit panel" >}}
|
{{< figure src="/static/img/docs/library-panels/create-lib-panel-from-edit-8-0.png" class="docs-image--no-shadow" max-width= "800px" caption="Screenshot of the edit panel" >}}
|
||||||
1. Click the **Library panels** option, and then click **Create library panel** to open the create dialog.
|
1. Click the **Library panels** option, and then click **Create library panel** to open the create dialog.
|
||||||
{{< figure src="/static/img/docs/library-panels/create-lib-panel-8-0.png" class="docs-image--no-shadow" max-width= "500px" caption="Screenshot of the create library panel dialog" >}}
|
|
||||||
1. In **Library panel name**, enter the name.
|
1. In **Library panel name**, enter the name.
|
||||||
1. In **Save in folder**, select the folder to save the library panel.
|
1. In **Save in folder**, select the folder to save the library panel.
|
||||||
1. Click **Create library panel** to save your changes.
|
1. Click **Create library panel** to save your changes.
|
||||||
|
@ -20,8 +20,6 @@ Grafana automatically scales dashboards to any resolution, which makes them perf
|
|||||||
|
|
||||||
You can access the Playlist feature from Grafana's side menu, in the Dashboards submenu.
|
You can access the Playlist feature from Grafana's side menu, in the Dashboards submenu.
|
||||||
|
|
||||||
{{< figure src="/static/img/docs/v50/playlist.png" max-width="25rem">}}
|
|
||||||
|
|
||||||
## Access, share, and control a playlist
|
## 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 existing playlists. Start and control the display of a playlist using one of the five available modes.
|
||||||
@ -80,8 +78,6 @@ You can create a playlist to present dashboards in a sequence, with a set order
|
|||||||
1. Optionally, remove a dashboard from the playlist by clicking the x icon beside dashboard.
|
1. Optionally, remove a dashboard from the playlist by clicking the x icon beside dashboard.
|
||||||
1. Click **Save**.
|
1. Click **Save**.
|
||||||
|
|
||||||
{{< figure src="/static/img/docs/dashboards/create-playlist-8-2.png" max-width="25rem">}}
|
|
||||||
|
|
||||||
## Save a playlist
|
## Save 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 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.
|
||||||
|
@ -70,12 +70,6 @@ Only organization administrators can create reports by default. You can customiz
|
|||||||
- **Send test email:** To verify that the configuration works as expected. You can choose to send this email to the recipients configured for the report, or to a different set of email addresses only used for testing.
|
- **Send test email:** To verify that the configuration works as expected. You can choose to send this email to the recipients configured for the report, or to a different set of email addresses only used for testing.
|
||||||
1. Preview and save the report.
|
1. Preview and save the report.
|
||||||
|
|
||||||
{{< figure src="/static/img/docs/enterprise/reports/select-dashboard.png" max-width="500px" class="docs-image--no-shadow" >}}
|
|
||||||
{{< figure src="/static/img/docs/enterprise/reports/format-report.png" max-width="500px" class="docs-image--no-shadow" >}}
|
|
||||||
{{< figure src="/static/img/docs/enterprise/reports/schedule.png" max-width="500px" class="docs-image--no-shadow" >}}
|
|
||||||
{{< figure src="/static/img/docs/enterprise/reports/share.png" max-width="500px" class="docs-image--no-shadow" >}}
|
|
||||||
{{< figure src="/static/img/docs/enterprise/reports/confirm.png" max-width="500px" class="docs-image--no-shadow" >}}
|
|
||||||
|
|
||||||
### Choose template variables
|
### Choose template variables
|
||||||
|
|
||||||
> **Note:** Available in [Grafana Enterprise]({{< relref "../../introduction/grafana-enterprise/" >}}) version 7.5 and later behind the `reportVariables` feature flag, Grafana Enterprise version 8.0 and later without a feature flag, and [Grafana Cloud Pro and Advanced](/docs/grafana-cloud/).
|
> **Note:** Available in [Grafana Enterprise]({{< relref "../../introduction/grafana-enterprise/" >}}) version 7.5 and later behind the `reportVariables` feature flag, Grafana Enterprise version 8.0 and later without a feature flag, and [Grafana Cloud Pro and Advanced](/docs/grafana-cloud/).
|
||||||
@ -142,8 +136,6 @@ A background job runs every 10 minutes and removes temporary CSV files. You can
|
|||||||
|
|
||||||
Scheduled reports can be sent once, or repeated on an hourly, daily, weekly, or monthly basis, or sent at custom intervals. You can also disable scheduling by selecting **Never**, for example to send the report via the API.
|
Scheduled reports can be sent once, or repeated on an hourly, daily, weekly, or monthly basis, or sent at custom intervals. You can also disable scheduling by selecting **Never**, for example to send the report via the API.
|
||||||
|
|
||||||
{{< figure src="/static/img/docs/enterprise/reports_scheduler_8.1.png" max-width="500px" class="docs-image--no-shadow" >}}
|
|
||||||
|
|
||||||
**Send now or schedule for later**
|
**Send now or schedule for later**
|
||||||
|
|
||||||
- **Send now** sends the report immediately after you save it. To stop sending the report at some point in the future, add an end date. If you leave the end date empty, the report is sent out indefinitely.
|
- **Send now** sends the report immediately after you save it. To stop sending the report at some point in the future, add an end date. If you leave the end date empty, the report is sent out indefinitely.
|
||||||
@ -169,8 +161,6 @@ When you schedule a report with a monthly frequency, and set the start date betw
|
|||||||
|
|
||||||
The last saved version of the report will be sent to selected emails. You can use this to verify emails are working and to make sure the report is generated and displayed as you expect.
|
The last saved version of the report will be sent to selected emails. You can use this to verify emails are working and to make sure the report is generated and displayed as you expect.
|
||||||
|
|
||||||
{{< figure src="/static/img/docs/enterprise/reports_send_test_mail.png" max-width="500px" class="docs-image--no-shadow" >}}
|
|
||||||
|
|
||||||
### Pause a report
|
### Pause a report
|
||||||
|
|
||||||
> **Note:** Available in [Grafana Enterprise]({{< relref "../../introduction/grafana-enterprise/" >}}) version 8.0 and later, and [Grafana Cloud Pro and Advanced](/docs/grafana-cloud/).
|
> **Note:** Available in [Grafana Enterprise]({{< relref "../../introduction/grafana-enterprise/" >}}) version 8.0 and later, and [Grafana Cloud Pro and Advanced](/docs/grafana-cloud/).
|
||||||
@ -257,8 +247,6 @@ Email branding:
|
|||||||
- **Footer link text:** Text of the link in the report email footer. Defaults to `Grafana`.
|
- **Footer link text:** Text of the link in the report email footer. Defaults to `Grafana`.
|
||||||
- **Footer link URL:** Link of the report email footer.
|
- **Footer link URL:** Link of the report email footer.
|
||||||
|
|
||||||
{{< figure src="/static/img/docs/enterprise/reports_settings.png" max-width="500px" class="docs-image--no-shadow" >}}
|
|
||||||
|
|
||||||
## Troubleshoot reporting
|
## Troubleshoot reporting
|
||||||
|
|
||||||
To troubleshoot and get more log information, enable debug logging in the configuration file. Refer to [Configuration]({{< relref "../../setup-grafana/configure-grafana/#filters" >}}) for more information.
|
To troubleshoot and get more log information, enable debug logging in the configuration file. Refer to [Configuration]({{< relref "../../setup-grafana/configure-grafana/#filters" >}}) for more information.
|
||||||
|
@ -58,8 +58,6 @@ When you save a dashboard, you can either select a folder for the dashboard to b
|
|||||||
|
|
||||||
## Manage dashboards
|
## Manage dashboards
|
||||||
|
|
||||||
{{< figure src="/static/img/docs/v50/manage_dashboard_menu.png" max-width="300px" class="docs-image--right" >}}
|
|
||||||
|
|
||||||
On the **Manage dashboards and folders** page, you can:
|
On the **Manage dashboards and folders** page, you can:
|
||||||
|
|
||||||
- create a folder
|
- create a folder
|
||||||
@ -99,8 +97,6 @@ The dashboard export action creates a Grafana JSON file that contains everything
|
|||||||
|
|
||||||
Grafana downloads a JSON file to your local machine.
|
Grafana downloads a JSON file to your local machine.
|
||||||
|
|
||||||
{{< figure src="/static/img/docs/export/export-modal.png" max-width="800px" >}}
|
|
||||||
|
|
||||||
#### Make a dashboard portable
|
#### Make a dashboard portable
|
||||||
|
|
||||||
If you want to export a dashboard for others to use, you can add template variables for things like a metric prefix (use a constant variable) and server name.
|
If you want to export a dashboard for others to use, you can add template variables for things like a metric prefix (use a constant variable) and server name.
|
||||||
@ -110,9 +106,6 @@ A template variable of the type `Constant` will automatically be hidden in the d
|
|||||||
### Import a dashboard
|
### Import a dashboard
|
||||||
|
|
||||||
1. Click **Dashboards > Import** in the side menu.
|
1. Click **Dashboards > Import** in the side menu.
|
||||||
|
|
||||||
{{< figure src="/static/img/docs/v70/import_step1.png" max-width="700px" >}}
|
|
||||||
|
|
||||||
1. Perform one of the following steps:
|
1. Perform one of the following steps:
|
||||||
|
|
||||||
- Upload a dashboard JSON file
|
- Upload a dashboard JSON file
|
||||||
|
@ -59,8 +59,6 @@ You can share a dashboard as a direct link or as a snapshot. You can also export
|
|||||||
|
|
||||||
The share dialog opens and shows the **Link** tab.
|
The share dialog opens and shows the **Link** tab.
|
||||||
|
|
||||||

|
|
||||||
|
|
||||||
### Share a direct link
|
### Share a direct link
|
||||||
|
|
||||||
The **Link** tab shows the current time range, template variables, and the default theme. You can also share a shortened URL.
|
The **Link** tab shows the current time range, template variables, and the default theme. You can also share a shortened URL.
|
||||||
@ -77,8 +75,6 @@ A dashboard snapshot shares an interactive dashboard publicly. Grafana strips se
|
|||||||
|
|
||||||
You can publish snapshots to your local instance or to [snapshots.raintank.io](http://snapshots.raintank.io). The latter is a free service provided by Grafana Labs that enables you to publish dashboard snapshots to an external Grafana instance. Anyone with the link can view it. You can set an expiration time if you want the snapshot removed after a certain time period.
|
You can publish snapshots to your local instance or to [snapshots.raintank.io](http://snapshots.raintank.io). The latter is a free service provided by Grafana Labs that enables you to publish dashboard snapshots to an external Grafana instance. Anyone with the link can view it. You can set an expiration time if you want the snapshot removed after a certain time period.
|
||||||
|
|
||||||

|
|
||||||
|
|
||||||
1. Click **Local Snapshot** or **Publish to snapshots.raintank.io**.
|
1. Click **Local Snapshot** or **Publish to snapshots.raintank.io**.
|
||||||
|
|
||||||
Grafana generates a link of the snapshot.
|
Grafana generates a link of the snapshot.
|
||||||
@ -91,8 +87,6 @@ If you created a snapshot by mistake, click **Delete snapshot** to remove the sn
|
|||||||
|
|
||||||
Grafana dashboards can easily be exported and imported. For more information, refer to [Export and import dashboards]({{< relref "./manage-dashboards/#export-and-import-dashboards" >}}).
|
Grafana dashboards can easily be exported and imported. For more information, refer to [Export and import dashboards]({{< relref "./manage-dashboards/#export-and-import-dashboards" >}}).
|
||||||
|
|
||||||

|
|
||||||
|
|
||||||
## Export dashboard as PDF
|
## Export dashboard as PDF
|
||||||
|
|
||||||
You can generate and save PDF files of any dashboard.
|
You can generate and save PDF files of any dashboard.
|
||||||
@ -114,8 +108,6 @@ You can share a panel as a direct link, as a snapshot, or as an embedded link. Y
|
|||||||
|
|
||||||
The share dialog opens and shows the **Link** tab.
|
The share dialog opens and shows the **Link** tab.
|
||||||
|
|
||||||

|
|
||||||
|
|
||||||
### Use direct link
|
### Use direct link
|
||||||
|
|
||||||
The **Link** tab shows the current time range, template variables, and the default theme. You can optionally enable a shortened URL to share.
|
The **Link** tab shows the current time range, template variables, and the default theme. You can optionally enable a shortened URL to share.
|
||||||
@ -149,8 +141,6 @@ A panel snapshot shares an interactive panel publicly. Grafana strips sensitive
|
|||||||
|
|
||||||
You can publish snapshots to your local instance or to [snapshots.raintank.io](http://snapshots.raintank.io). The latter is a free service provided by [Grafana Labs](https://grafana.com), that enables 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.
|
You can publish snapshots to your local instance or to [snapshots.raintank.io](http://snapshots.raintank.io). The latter is a free service provided by [Grafana Labs](https://grafana.com), that enables 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.
|
||||||
|
|
||||||

|
|
||||||
|
|
||||||
1. In the **Share Panel** dialog, click **Snapshot** to open the tab.
|
1. In the **Share Panel** dialog, click **Snapshot** to open the tab.
|
||||||
1. Click **Local Snapshot** or **Publish to snapshots.raintank.io**.
|
1. Click **Local Snapshot** or **Publish to snapshots.raintank.io**.
|
||||||
|
|
||||||
@ -166,8 +156,6 @@ You can embed a panel using an iframe on another web site. A viewer must be sign
|
|||||||
|
|
||||||
**> Note:** As of Grafana 8.0, anonymous access permission is no longer available for Grafana Cloud.
|
**> Note:** As of Grafana 8.0, anonymous access permission is no longer available for Grafana Cloud.
|
||||||
|
|
||||||

|
|
||||||
|
|
||||||
Here is an example of the HTML code:
|
Here is an example of the HTML code:
|
||||||
|
|
||||||
```html
|
```html
|
||||||
@ -179,16 +167,13 @@ Here is an example of the HTML code:
|
|||||||
></iframe>
|
></iframe>
|
||||||
```
|
```
|
||||||
|
|
||||||
The result is an interactive Grafana graph embedded in an iframe:
|
The result is an interactive Grafana graph embedded in an iframe.
|
||||||
|
|
||||||
<iframe src="https://snapshots.raintank.io/dashboard-solo/snapshot/y7zwi2bZ7FcoTlB93WN7yWO4aMiz3pZb?from=1493369923321&to=1493377123321&panelId=4" width="650" height="300" frameborder="0"></iframe>
|
|
||||||
|
|
||||||
### Library panel
|
### Library panel
|
||||||
|
|
||||||
To create a library panel from the **Share Panel** dialog:
|
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 **Library panel name**, enter the name.
|
||||||
1. In **Save in folder**, select the folder in which to save the library panel. By default, the General folder is selected.
|
1. In **Save in folder**, select the folder in which to save the library panel. By default, the General folder is selected.
|
||||||
1. Click **Create library panel** to save your changes.
|
1. Click **Create library panel** to save your changes.
|
||||||
|
@ -57,8 +57,6 @@ curl http://admin:admin@localhost:3000/api/org
|
|||||||
**Example**:
|
**Example**:
|
||||||
|
|
||||||
```http
|
```http
|
||||||
|
|
||||||
```http
|
|
||||||
GET http://your.grafana.com/api/dashboards/db/mydash HTTP/1.1
|
GET http://your.grafana.com/api/dashboards/db/mydash HTTP/1.1
|
||||||
Accept: application/json
|
Accept: application/json
|
||||||
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
|
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
|
||||||
|
@ -15,8 +15,6 @@ App plugins are Grafana plugins that can bundle data source and panel plugins wi
|
|||||||
|
|
||||||
Data source and panel plugins will show up like normal plugins. The app pages will be available in the main menu.
|
Data source and panel plugins will show up like normal plugins. The app pages will be available in the main menu.
|
||||||
|
|
||||||
{{< figure class="float-right" src="/static/img/docs/v3/app-in-main-menu.png" caption="App in Main Menu" >}}
|
|
||||||
|
|
||||||
## Enabling app plugins
|
## Enabling app plugins
|
||||||
|
|
||||||
After installing an app, it has to be enabled before it shows up as a data source or panel. You can do that on the app page in the configuration tab.
|
After installing an app, it has to be enabled before it shows up as a data source or panel. You can do that on the app page in the configuration tab.
|
||||||
|
@ -33,8 +33,6 @@ To access Explore:
|
|||||||
|
|
||||||
1. Click on the Explore icon on the menu bar.
|
1. Click on the Explore icon on the menu bar.
|
||||||
|
|
||||||
{{< figure src="/static/img/docs/explore/access-explore-7-4.png" max-width= "650px" caption="Screenshot of the new Explore Icon" >}}
|
|
||||||
|
|
||||||
An empty Explore tab opens.
|
An empty Explore tab opens.
|
||||||
|
|
||||||
Alternately to start with an existing query in a panel, choose the Explore option from the Panel menu. This opens an Explore tab with the query from the panel and allows you to tweak or iterate in the query outside of your dashboard.
|
Alternately to start with an existing query in a panel, choose the Explore option from the Panel menu. This opens an Explore tab with the query from the panel and allows you to tweak or iterate in the query outside of your dashboard.
|
||||||
|
Reference in New Issue
Block a user