From e403d54ba462a73652c3e0ca444c2061f606cde4 Mon Sep 17 00:00:00 2001 From: Will Browne Date: Wed, 4 Aug 2021 18:35:15 +0200 Subject: [PATCH] Plugins: Update plugin catalog docs (#37557) * docs(catalog): update documentation for 8.1 changes * docs(catalog): update the image and video links * Apply suggestions from code review Co-authored-by: achatterjee-grafana <70489351+achatterjee-grafana@users.noreply.github.com> * make catalog refs consistent * Update docs/sources/plugins/catalog.md Co-authored-by: achatterjee-grafana <70489351+achatterjee-grafana@users.noreply.github.com> Co-authored-by: Jack Westbrook Co-authored-by: achatterjee-grafana <70489351+achatterjee-grafana@users.noreply.github.com> --- docs/sources/plugins/catalog.md | 64 +++++++++++++++++++-------------- 1 file changed, 38 insertions(+), 26 deletions(-) diff --git a/docs/sources/plugins/catalog.md b/docs/sources/plugins/catalog.md index f826535b89c..8f9924ef4de 100644 --- a/docs/sources/plugins/catalog.md +++ b/docs/sources/plugins/catalog.md @@ -6,63 +6,75 @@ weight = 1 # Plugin catalog -The plugin catalog allows you to browse and manage plugins from within Grafana. Only a Grafana server administrator can access and use the catalog. +The Plugin catalog allows you to browse and manage plugins from within Grafana. Only Grafana server administrators and organization administrators can access and use the plugin catalog. The following access rules apply depending on the user role: -> **Note:** The plugin catalog is designed to work with a single Grafana server instance only. Support for Grafana clusters will be added in future Grafana releases. +| Org Admin | Server Admin | Permissions | +| --------- | ------------ | ------------------------------------------------------------------------------------------- | +| ✓ | ✓ | | +| ✓ | × | | +| × | ✓ | | + +> **Note:** The Plugin catalog is designed to work with a single Grafana server instance only. Support for Grafana clusters will be added in future Grafana releases.
-Before you can use the plugin catalog, you must enable it in the Grafana [configuration]({{< relref "../administration/configuration.md#plugin_admin_enabled" >}}) file. +Before you can use the Plugin catalog, you must enable it in the Grafana [configuration]({{< relref "../administration/configuration.md#plugin_admin_enabled" >}}) file. Before following the steps below, make sure you are logged in as a Grafana administrator. + +Currently, there are two entry points to the Plugin catalog. +- Grafana server administrators can find it at **Server Admin > +Plugins**. +- Organization administrators can find it at **Configuration > Plugins**. + ## Browse plugins -To browse available plugins: +To browse for available plugins: -1. In Grafana, navigate to **Configuration > Plugins**. -1. Click **Install & manage plugins**. +1. In Grafana, [navigate to the Plugin catalog](#plugin-catalog-entry) to view installed plugins. +1. Click the **All** filter to browse all available plugins. +1. Click the **Data sources**, **Panels**, or **Applications** buttons to filter by plugin type. -You can also browse existing plugins by navigating to the **Library** tab. - -![Plugin catalog browse](/static/img/docs/plugins/plugins-catalog-browse-8-0.png) +![Plugin catalog browse](/static/img/docs/plugins/plugins-catalog-browse-8-1.png) ## Install a plugin -1. In Grafana, navigate to **Configuration > Plugins**. -1. Click **Install & manage plugins**. +To install a plugin: + +1. In Grafana, [navigate to the Plugin catalog](#plugin-catalog-entry) to view installed plugins. 1. Browse and find a plugin. 1. Click on the plugin logo. -1. Click **Install**. +1. Click **Install**. -A confirmation message opens notifying that the installation was successful. +When the update is complete, you see a confirmation message that the installation was successful. -![Plugin catalog install](/static/img/docs/plugins/plugins-catalog-install-8-0.png) +![Plugin catalog install](/static/img/docs/plugins/plugins-catalog-install-8-1.png) ## Update a plugin -1. In Grafana, navigate to **Configuration > Plugins**. -1. Click **Install & manage plugins**. -1. Navigate to the **Library** tab. +To update a plugin: + +1. In Grafana, [navigate to the Plugin catalog](#plugin-catalog-entry) to view installed plugins. 1. Click on the plugin logo. 1. Click **Update**. -A confirmation message opens notifying that the installation was successful. +When the update is complete, you see a confirmation message that the update was successful. -![Plugin catalog update](/static/img/docs/plugins/plugins-catalog-update-8-0.png) +![Plugin catalog update](/static/img/docs/plugins/plugins-catalog-update-8-1.png) ## Uninstall a plugin -1. In Grafana, navigate to **Configuration > Plugins**. -1. Click **Install & manage plugins**. -1. Navigate to the **Library** tab. +To uninstall a plugin: + +1. In Grafana, [navigate to the Plugin catalog](#plugin-catalog-entry) to view installed plugins. 1. Click on the plugin logo. 1. Click **Uninstall**. -A confirmation message opens notifying that the installation was successful. - -![Plugin catalog uninstall](/static/img/docs/plugins/plugins-catalog-uninstall-8-0.png) +When the update is complete, you see a confirmation message that the uninstall was successful. + +![Plugin catalog uninstall](/static/img/docs/plugins/plugins-catalog-uninstall-8-1.png)