Docs: Manage library panels refactor (#51661)

* merges library panel content into a single topic

* updates menuTite

* fixes typo

* removed Grafana from task titles
pull/51645/head
Christopher Moyer 3 years ago committed by GitHub
parent 500010e0b6
commit 7eec92988e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
  1. 87
      docs/sources/dashboards/manage-library-panels.md
  2. 14
      docs/sources/panels/library-panels/_index.md
  3. 13
      docs/sources/panels/library-panels/about-library-panels.md
  4. 29
      docs/sources/panels/library-panels/add-library-panel.md
  5. 31
      docs/sources/panels/library-panels/create-library-panel.md
  6. 25
      docs/sources/panels/library-panels/delete-library-panel.md
  7. 26
      docs/sources/panels/library-panels/manage-library-panel.md
  8. 23
      docs/sources/panels/library-panels/unlink-library-panel.md

@ -0,0 +1,87 @@
---
aliases:
- /docs/grafana/latest/panels/panel-library/
- /docs/grafana/latest/panels/library-panels/
- /docs/grafana/latest/panels/library-panels/create-library-panel/
- /docs/grafana/latest/panels/library-panels/add-library-panel/
- /docs/grafana/latest/panels/library-panels/unlink-library-panel/
- /docs/grafana/latest/panels/library-panels/manage-library-panel/
- /docs/grafana/latest/panels/library-panels/delete-library-panel/
- /docs/grafana/latest/dashboards/manage-library-panels/
title: Manage Grafana library panels
menuTitle: Manage library panels
weight: 3
---
# Manage Grafana library panels
A library panel is a reusable panel that you can use in any dashboard. When you make a change to a library panel, that change propagates to all instances of where the panel is used. Library panels streamline reuse of panels across multiple dashboards.
You can save a library panel in a folder alongside saved dashboards.
## Create a library panel
When you create a library panel, the panel on the source dashboard is converted to a library panel as well. You need to save the original dashboard once a panel is converted.
1. Open a panel in edit mode.
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" >}}
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 **Save in folder**, select the folder to save the library panel.
1. Click **Create library panel** to save your changes.
1. Save the dashboard.
Once created, you can modify the library panel using any dashboard on which it appears. After you save the changes, all instances of the library panel reflect these modifications.
{{< figure src="/static/img/docs/library-panels/create-from-more-8-0.png" class="docs-image--no-shadow" max-width= "900px" caption="Screenshot of the edit panel" >}}
## Add a library panel to a dashboard
Add a Grafana library panel to a dashboard when you want to provide visualizations to other dashboard users.
1. Hover over the **Dashboards** option on the left menu, then select **New dashboard** from the drop-down options.
The **Add** panel dialog opens.
{{< figure src="/static/img/docs/library-panels/add-library-panel-8-0.png" class="docs-image--no-shadow" max-width= "900px" caption="Screenshot of the edit panel" >}}
1. Click the **Add a panel from the panel library** option.
You will see a list of your library panels.
1. Filter the list or search to find the panel you want to add.
1. Click a panel to add it to the dashboard.
## Unlink a library panel
Unlink a library panel when you want to make a change to the panel and not affect other instances of the library panel.
1. Hover over **Dashboard** on the left menu, and then click **Library panels**.
1. Select a library panel that is being used in different dashboards.
1. Select the panel you want to unlink.
1. Click the title of the panel and then click **Edit**. The panel opens in edit mode.
1. Click the **Unlink** option on the top right corner of the page.
## View a list of library panels
You can view a list of available library panels and search for a library panel.
1. Hover over the **Dashboard** option on the left menu, then click **Library panels**.
You can see a list of previously defined library panels.
{{< figure src="/static/img/docs/library-panels/library-panel-list-8-0.png" class="docs-image--no-shadow" max-width= "900px" caption="Screenshot of the edit panel" >}}
1. Search for a specific library panel if you know its name.
You can also filter the panels by folder or type.
## Delete a library panel
Delete a library panel when you no longer need it.
1. Hover over **Dashboard** on the left menu, and select **Library panels**.
1. Select the panel you want to delete.
1. Click the delete icon next to the library panel name.

@ -1,14 +0,0 @@
---
aliases:
- /docs/grafana/latest/panels/library-panels/
- /docs/grafana/latest/panels/panel-library/
- /docs/sources/panels/library-panels/
title: Create reusable Grafana panels
weight: 700
---
# Create reusable Grafana panels
Library panels enable you to create reusable panels that you can add to any dashboard in your organization.
{{< section >}}

@ -1,13 +0,0 @@
---
aliases:
- /docs/grafana/latest/panels/library-panels/about-library-panels/
- /docs/sources/panels/library-panels/about-library-panels/
title: About Grafana library panels
weight: 10
---
# About Grafana panel libraries
A library panel is a reusable panel that you can use in any dashboard. When you make a change to a library panel, that change propagates to all instances of where the panel is used. Library panels streamline reuse of panels across multiple dashboards.
You can save a library panel in a folder alongside saved dashboards.

@ -1,29 +0,0 @@
---
aliases:
- /docs/grafana/latest/panels/library-panels/add-library-panel/
- /docs/sources/panels/library-panels/add-library-panel/
title: Add a Grafana library panel to a dashboard
weight: 30
---
# Add a Grafana library panel to a dashboard
Add a Grafana library panel to a dashboard when you want to provide visualizations to other dashboard users.
## Before you begin
- [Create a library panel]({{< relref "create-library-panel/" >}}).
**To add a library panel to a dashboard**:
1. Hover over the **Dashboards** option on the left menu, then select **New dashboard** from the drop-down options.
The **Add** panel dialog opens.
{{< figure src="/static/img/docs/library-panels/add-library-panel-8-0.png" class="docs-image--no-shadow" max-width= "900px" caption="Screenshot of the edit panel" >}}
1. Click the **Add a panel from the panel library** option.
You will see a list of your library panels.
1. Filter the list or search to find the panel you want to add.
1. Click a panel to add it to the dashboard.

@ -1,31 +0,0 @@
---
aliases:
- /docs/grafana/latest/panels/library-panels/create-library-panel/
- /docs/sources/panels/library-panels/create-library-panel/
title: Create a Grafana library panel
weight: 20
---
# Create a Grafana library panel
When you create a library panel, the panel on the source dashboard is converted to a library panel as well. You need to save the original dashboard once a panel is converted.
## Before you begin
- [Add a panel to a dashboard]({{< relref "../working-with-panels/add-panel/" >}}).
**To create a library panel**:
1. Open a panel in edit mode.
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" >}}
1. Click the **Library panels** option, and then click **Create new 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 **Save in folder**, select the folder to save the library panel.
1. Click **Create library panel** to save your changes.
1. Save the dashboard.
Once created, you can modify the library panel using any dashboard on which it appears. After you save the changes, all instances of the library panel reflect these modifications.
{{< figure src="/static/img/docs/library-panels/create-from-more-8-0.png" class="docs-image--no-shadow" max-width= "900px" caption="Screenshot of the edit panel" >}}

@ -1,25 +0,0 @@
---
aliases:
- /docs/grafana/latest/panels/library-panels/delete-library-panel/
- /docs/sources/panels/library-panels/delete-library-panel/
title: Delete a Grafana library panel
weight: 60
---
# Delete a Grafana library panel
Delete a library panel when you no longer need it.
## Before you begin
- Verify that the panel does not appear on a dashboard.
**To delete a library panel**:
1. Hover over **Dashboard** on the left menu, and select Library panels from the drop-down options.
1. Select a library panel that is being used in different dashboards.
You will see a list of all the dashboards.
1. Select the panel you want to delete.
1. Click the delete icon next to the library panel name.

@ -1,26 +0,0 @@
---
aliases:
- /docs/grafana/latest/panels/library-panels/manage-library-panel/
- /docs/sources/panels/library-panels/manage-library-panel/
title: Manage Grafana library panels
weight: 40
---
# Manage Grafana library panels
You can adjust library panel configuration at any time.
## Before you begin
- [Add a panel to a dashboard]({{< relref "../working-with-panels/add-panel/" >}}).
**To view and manage a library panel**:
1. Hover over the **Dashboard** option on the left menu, then click **Library panels**.
You can see a list of previously defined library panels.
{{< figure src="/static/img/docs/library-panels/library-panel-list-8-0.png" class="docs-image--no-shadow" max-width= "900px" caption="Screenshot of the edit panel" >}}
1. Search for a specific library panel if you know its name.
You can also filter the panels by folder or type.

@ -1,23 +0,0 @@
---
aliases:
- /docs/grafana/latest/panels/library-panels/unlink-library-panel/
- /docs/sources/panels/library-panels/unlink-library-panel/
title: Unlink a Grafana library panel
weight: 50
---
# Unlink a Grafana library panel
Unlink a library panel when you want to make a change to the panel and not affect other instances of the library panel.
## Before you begin
- Identify the panel you want to unlink.
**To unlink a library panel from a dashboard**:
1. Hover over **Dashboard** on the left menu, and then click **Library panels**.
1. Select a library panel that is being used in different dashboards.
1. Select the panel you want to unlink.
1. Click the title of the panel and then click **Edit**. The panel opens in edit mode.
1. Click the **Unlink** option on the top right corner of the page.
Loading…
Cancel
Save