hendrik/lens
1
0
Fork 0
mirror of https://github.com/lensapp/lens.git synced 2025-05-20 05:10:56 +00:00
Code Issues Projects Releases Wiki Activity

add basic usage docs for extensions (#1583)

Browse Source 
Signed-off-by: Sebastian Malton <sebastian@malton.name>
This commit is contained in:
Sebastian Malton 2020-12-01 11:30:01 -05:00 committed by GitHub
parent 99c3a00721
commit 111c518bf5
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 11 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
docs/extensions/usage/README.md
View File

@ -3,21 +3,24 @@
The features that Lens includes out-of-the-box are just the start. 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. 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. 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) ![Extensions](images/extensions.png)
## Installing an Extension ## 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\<user>\.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. 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.
## Disabling an Extension A disabled extension is not loaded by Lens and is not run.
Go to **File** > **Extensions** (**Lens** > **Extensions** on Mac) and click "Disable" button.
## Uninstalling an Extension ## 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.