From 76a8a47a4c0c1cf5e094e1be6fee06ac7472442b Mon Sep 17 00:00:00 2001 From: Sebastian Malton Date: Thu, 4 Feb 2021 08:27:57 -0500 Subject: [PATCH] improve docs Signed-off-by: Sebastian Malton --- docs/extensions/guides/protocol-handlers.md | 7 +++++++ docs/getting-started/README.md | 2 +- 2 files changed, 8 insertions(+), 1 deletion(-) diff --git a/docs/extensions/guides/protocol-handlers.md b/docs/extensions/guides/protocol-handlers.md index 9668000c15..8e13c8436a 100644 --- a/docs/extensions/guides/protocol-handlers.md +++ b/docs/extensions/guides/protocol-handlers.md @@ -32,6 +32,13 @@ export default class ExampleExtensionMain extends LensMainExtension { } ``` +For testing the routing of URIs the `open` (on macOS) or `xdg-open` (on most linux) CLI utilities can be used. +For the above handler, the following URI would be always routed to it: + +``` +open lens://extension/example-extension/ +``` + ## Deregistering A Protocol Handler All that is needed to deregister a handler is to remove it from the array of handlers. diff --git a/docs/getting-started/README.md b/docs/getting-started/README.md index bd43bbde73..23a7cac9ed 100644 --- a/docs/getting-started/README.md +++ b/docs/getting-started/README.md @@ -28,7 +28,7 @@ Review the [System Requirements](/supporting/requirements/) to check if your com See the [Download Lens](https://github.com/lensapp/lens/releases) page for a complete list of available installation options. -After installing Lens manually (not using a package manager file such as `.deb` or `.rpm`) the following will need to be done in allow protocol handling. +After installing Lens manually (not using a package manager file such as `.deb` or `.rpm`) the following will need to be done to allow protocol handling. This assumes that your linux distribution uses `xdg-open` and the `xdg-*` suite of programs for determining which application can handle custom URIs. 1. Create a file called `lens.desktop` in either `~/.local/share/applications/` or `/usr/share/applications` (if you have permissions and are installing Lens for all users).