From 244d3f61c37b42f8e57c1587724aa48e155c3974 Mon Sep 17 00:00:00 2001 From: Will Browne Date: Fri, 28 May 2021 16:44:40 +0200 Subject: [PATCH] Plugins: Add missing docs for plugin catalog (#34679) * add missing docs for plugin catalog * apply PR feedback * use mp4 instead of gif * update wording * Add note about org admins Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com> * apply pr feedback Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com> --- docs/sources/plugins/catalog.md | 62 ++++++++++++++++++++++++++++----- 1 file changed, 53 insertions(+), 9 deletions(-) diff --git a/docs/sources/plugins/catalog.md b/docs/sources/plugins/catalog.md index dc91ad50fa0..b182c2aed80 100644 --- a/docs/sources/plugins/catalog.md +++ b/docs/sources/plugins/catalog.md @@ -6,17 +6,61 @@ weight = 1 # Plugin catalog -Catalog for Grafana is a plugin bundled with Grafana versions 8.0+. It allows users to browse and manage plugins from within Grafana. Only Grafana Admins can access and use the Marketplace. +The Plugin catalog allows users to browse and manage plugins from within Grafana. Only Organization Admins who are also Grafana Server Admins can access and use the catalog. -[screenshot placeholder] +
+ +
-To use the Catalog for Grafana, you first need to enable it in the Grafana [configuration]({{< relref "../administration/configuration.md#catalog_app_enabled" >}}). +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. -## Install a plugin from the Catalog -To install a plugin ... +## Browse plugins -### Updating a plugin -To update a plugin ... +To browse available plugins: -## Uninstall a plugin from the Catalog -To uninstall a plugin ... +1. In Grafana, navigate to **Configuration > Plugins**. +1. Click **Install & manage plugins**. + +You can also browse existing plugins by navigating to the **Library** tab. + +![Plugin catalog browse](/img/docs/plugins/plugins-catalog-browse-8-0.png) + +## Install a plugin + +1. In Grafana, navigate to **Configuration > Plugins**. +1. Click **Install & manage plugins**. +1. Browse and find a plugin. +1. Click on the plugin logo. +1. Click **Install**. + +A confirmation message opens notifying that the installation was successful. + +![Plugin catalog install](/img/docs/plugins/plugins-catalog-install-8-0.png) + +## Update a plugin + +1. In Grafana, navigate to **Configuration > Plugins**. +1. Click **Install & manage plugins**. +1. Navigate to the **Library** tab. +1. Click on the plugin logo. +1. Click **Update**. + +A confirmation message opens notifying that the installation was successful. + +![Plugin catalog update](/img/docs/plugins/plugins-catalog-update-8-0.png) + +## Uninstall a plugin + +1. In Grafana, navigate to **Configuration > Plugins**. +1. Click **Install & manage plugins**. +1. Navigate to the **Library** tab. +1. Click on the plugin logo. +1. Click **Uninstall**. + +A confirmation message opens notifying that the installation was successful. + +![Plugin catalog uninstall](/img/docs/plugins/plugins-catalog-uninstall-8-0.png)