From 111c518bf5dba93df2f9807ebceb08a0dab2380f Mon Sep 17 00:00:00 2001 From: Sebastian Malton Date: Tue, 1 Dec 2020 11:30:01 -0500 Subject: [PATCH] add basic usage docs for extensions (#1583) Signed-off-by: Sebastian Malton --- docs/extensions/usage/README.md | 19 +++++++++++-------- 1 file changed, 11 insertions(+), 8 deletions(-) diff --git a/docs/extensions/usage/README.md b/docs/extensions/usage/README.md index 4020e64d65..02b2db223a 100644 --- a/docs/extensions/usage/README.md +++ b/docs/extensions/usage/README.md @@ -3,21 +3,24 @@ The features that Lens includes out-of-the-box are just the start. Lens extensions let you add new features to your installation to support your workflow. Rich extensibility model lets extension authors plug directly into the Lens UI and contribute functionality through the same APIs used by Lens itself. +The start using Lens Extensions go to **File** (or **Lens** on macOS) > **Extensions** in the application menu. +This is the `Extensions` management page where all the management of the extensions you want to use is done. ![Extensions](images/extensions.png) ## Installing an Extension -You can install a dowloaded extension .tgz package by going to **File** > **Extensions** (**Lens** > **Extensions** on Mac). Alternatively you can point an URL to .tgz file. An installed extension is enabled automatically. +There are three ways to install extensions. +If you have the extension as a `.tgz` file then dragging and dropping it in the extension management page will install it for you. +If it is hosted on the web, you can paste the URL and click `Install` and Lens will download and install it. +The third way is to move the extension into your `~/.k8slens/extensions` (or `C:\Users\\.k8slens\extensions`) folder and Lens will automatically detect it and install the extension. -## Enabling an Extension +## Enabling or Disabling an Extension -Go to **File** > **Extensions** (**Lens** > **Extensions** on Mac) and click "Enable" button. - -## Disabling an Extension - -Go to **File** > **Extensions** (**Lens** > **Extensions** on Mac) and click "Disable" button. +Go to the extension management page and click either the `Enable` or `Disable` buttons. +Extensions will be enabled by default when you first install them. +A disabled extension is not loaded by Lens and is not run. ## Uninstalling an Extension -Go to **File** > **Extensions** (**Lens** > **Extensions** on Mac) and click "Uninstall" button. +If, for whatever reason, you wish to remove the installation of an extension simple click the `Uninstall` button. This will remove all the files that Lens would need to run the extension.