Fix Extension Docs (#2377)

Co-authored-by: Jim Ehrismann <40840436+jim-docker@users.noreply.github.com>
2025-05-20 05:10:56 +00:00 · 2021-04-19 11:46:07 -04:00
1 parent 05f5176419
commit 49a01b7922
@@ -1,6 +1,7 @@
 # Extension Anatomy

-In the [previous section](your-first-extension.md) you learned how to create your first extension. In this section you will learn how this extension works under the hood.
+In the [previous section](your-first-extension.md) you learned how to create your first extension.
+In this section you will learn how this extension works under the hood.

 The Hello World sample extension does three things:

@@ -26,13 +27,19 @@ Let's take a closer look at our Hello World sample's source code and see how the
 ├── webpack.config.js    // Webpack configuration
 ```

-The extension directory contains the extension's entry files and a few configuration files. Three files: `package.json`, `main.ts` and `renderer.tsx` are essential to understanding the Hello World sample extension. We'll look at those first.
+The extension directory contains the extension's entry files and a few configuration files.
+Three files: `package.json`, `main.ts` and `renderer.tsx` are essential to understanding the Hello World sample extension.
+We'll look at those first.

 ### Extension Manifest

-Each Lens extension must have a `package.json` file. It contains a mix of Node.js fields, including scripts and dependencies, and Lens-specific fields such as `publisher` and `contributes`. Some of the most-important fields include:
+Each Lens extension must have a `package.json` file.
+It contains a mix of Node.js fields, including scripts and dependencies, and Lens-specific fields such as `publisher` and `contributes`.
+Some of the most-important fields include:

- `name` and `publisher`: Lens uses `@<publisher>/<name>` as a unique ID for the extension. For example, the Hello World sample has the ID `@lensapp-samples/helloworld-sample`. Lens uses this ID to uniquely identify your extension.
+- `name` and `publisher`: Lens uses `@<publisher>/<name>` as a unique ID for the extension.
+For example, the Hello World sample has the ID `@lensapp-samples/helloworld-sample`.
+Lens uses this ID to uniquely identify your extension.
 - `main`: the extension's entry point run in `main` process.
 - `renderer`: the extension's entry point run in `renderer` process.
 - `engines.lens`: the minimum version of Lens API that the extension depends upon.
@@ -71,11 +78,22 @@ Each Lens extension must have a `package.json` file. It contains a mix of Node.j

 ## Extension Entry Files

-Lens extensions can have two separate entry files. One file is used in the `main` process of the Lens application and the other is used in the `renderer` process. The `main` entry file exports the class that extends `LensMainExtension`, and the `renderer` entry file exports the class that extends `LensRendererExtension`.
+Lens extensions can have two separate entry files.
+One file is used in the `main` process of the Lens application and the other is used in the `renderer` process.
+The `main` entry file exports the class that extends `LensMainExtension`, and the `renderer` entry file exports the class that extends `LensRendererExtension`.

-Both extension classes have `onActivate` and `onDeactivate` methods. The `onActivate` method is executed when your extension is activated. If you need to initialize something in your extension, this is where such an operation should occur. The `onDeactivate` method gives you a chance to clean up before your extension becomes deactivated. For extensions where explicit cleanup is not required, you don't need to override this method. However, if an extension needs to perform an operation when Lens is shutting down (or if the extension is disabled or uninstalled), this is the method where such an operation should occur.
+Both extension classes have `onActivate` and `onDeactivate` methods.
+The `onActivate` method is executed when your extension is activated.
+If you need to initialize something in your extension, this is where such an operation should occur.
+The `onDeactivate` method gives you a chance to clean up before your extension becomes deactivated.
+For extensions where explicit cleanup is not required, you don't need to override this method.
+However, if an extension needs to perform an operation when Lens is shutting down (or if the extension is disabled or uninstalled), this is the method where such an operation should occur.

-The Hello World sample extension does not do anything on the `main` process, so we'll focus on the `renderer` process, instead. On the `renderer` entry point, the Hello World sample extension defines the `Cluster Page` object. The `Cluster Page` object registers the `/extension-example` path, and this path renders the `ExamplePage` React component. It also registers the `MenuItem` component that displays the `ExampleIcon` React component and the "Hello World" text in the left-side menu of the cluster dashboard. These React components are defined in the additional `./src/page.tsx` file.
+The Hello World sample extension does not do anything on the `main` process, so we'll focus on the `renderer` process, instead.
+On the `renderer` entry point, the Hello World sample extension defines the `Cluster Page` object.
+The `Cluster Page` object registers the `/extension-example` path, and this path renders the `ExamplePage` React component.
+It also registers the `MenuItem` component that displays the `ExampleIcon` React component and the "Hello World" text in the left-side menu of the cluster dashboard.
+These React components are defined in the additional `./src/page.tsx` file.

 ``` typescript
 import { LensRendererExtension } from "@k8slens/extensions";
@@ -94,4 +112,5 @@ export default class ExampleExtension extends LensRendererExtension {
 }
 ```

-The Hello World sample extension uses the `Cluster Page` capability, which is just one of the Lens extension API's capabilities. The [Common Capabilities](../capabilities/common-capabilities.md) page will help you home in on the right capabilities to use with your own extensions.
+The Hello World sample extension uses the `Cluster Page` capability, which is just one of the Lens extension API's capabilities.
+The [Common Capabilities](../capabilities/common-capabilities.md) page will help you home in on the right capabilities to use with your own extensions.
@@ -1,19 +1,27 @@
 # Extension Development Overview

-This is a general overview to how the development of an extension will procede. For building extensions there will be a few things that you should have installed, and some other things that might be of help.
+This is a general overview to how the development of an extension will proceed.
+For building extensions there will be a few things that you should have installed, and some other things that might be of help.

 ### Required:
 - [Node.js](https://www.nodejs.org/en/)
 - [Git](https://www.git-scm.com/)
 - Some sort of text editor – we recommend [VSCode](https://code.visualstudio.com/)
- We use [Webpack](https://www.webpack.js.org/) for compilation. All extension need to be at least compatable with a webpack system.
+- We use [Webpack](https://www.webpack.js.org/) for compilation.
+All extension need to be at least compatible with a webpack system.

 ### Recommended:

-All Lens extensions are javascript packages. We recommend that you program in [Typescript](https://www.typescriptlang.org/) because it catches many common errors.
+All Lens extensions are javascript packages.
+We recommend that you program in [Typescript](https://www.typescriptlang.org/) because it catches many common errors.

-Lens is a standard [Electron](https://www.electronjs.org/) application with both main and renderer processes. An extension is made up of two parts, one for each of Lens's core processes. When an extension is loaded, each part is first loaded and issues a notification that it has been loaded. From there, the extension can start doing is work.
+Lens is a standard [Electron](https://www.electronjs.org/) application with both main and renderer processes.
+An extension is made up of two parts, one for each of Lens's core processes.
+When an extension is loaded, each part is first loaded and issues a notification that it has been loaded.
+From there, the extension can start doing is work.

-Lens uses [React](https://www.reactjs.org/) as its UI framework and provides some of Lens's own components for reuse with extensions. An extension is resonsible for the lifetime of any resources it spins up. If an extension's main part starts new processes they all must be stopped and cleaned up when the extension is deactivated or unloaded.
+Lens uses [React](https://www.reactjs.org/) as its UI framework and provides some of Lens's own components for reuse with extensions.
+An extension is responsible for the lifetime of any resources it spins up.
+If an extension's main part starts new processes they all must be stopped and cleaned up when the extension is deactivated or unloaded.

 See [Your First Extension](your-first-extension.md) to get started.
@@ -1,14 +1,20 @@
 # Wrapping Up

-In [Your First Extension](your-first-extension.md), you learned how to create and run an extension. In [Extension Anatomy](anatomy.md), you learned in detail how a basic extension works. This is just a glimpse into what can be created with Lens extensions. Below are some suggested routes for learning more.
+In [Your First Extension](your-first-extension.md), you learned how to create and run an extension.
+In [Extension Anatomy](anatomy.md), you learned in detail how a basic extension works.
+This is just a glimpse into what can be created with Lens extensions.
+Below are some suggested routes for learning more.

 ## Extension Capabilities

-In this section, you'll find information on common extension capabilities, styling information, and a color reference guide. Determine whether your idea for an extension is doable and get ideas for new extensions by reading through the [Common Capabilities](../capabilities/common-capabilities.md) page.
+In this section, you'll find information on common extension capabilities, styling information, and a color reference guide.
+Determine whether your idea for an extension is doable and get ideas for new extensions by reading through the [Common Capabilities](../capabilities/common-capabilities.md) page.

 ## Guides and Samples

-Here you'll find a collection of sample extensions that you can use as a base to work from. Some of these samples include a detailed guide that explains the source code. You can find all samples and guides in the [lens-extension-samples](https://github.com/lensapp/lens-extension-samples) repository.
+Here you'll find a collection of sample extensions that you can use as a base to work from.
+Some of these samples include a detailed guide that explains the source code.
+You can find all samples and guides in the [lens-extension-samples](https://github.com/lensapp/lens-extension-samples) repository.

 ## Testing and Publishing

@@ -1,6 +1,7 @@
 # Your First Extension

-We recommend to always use [Yeoman generator for Lens Extension](https://github.com/lensapp/generator-lens-ext) to start new extension project. [Read the generator guide here](../guides/generator.md).
+We recommend to always use [Yeoman generator for Lens Extension](https://github.com/lensapp/generator-lens-ext) to start new extension project.
+[Read the generator guide here](../guides/generator.md).

 If you want to setup the project manually, please continue reading.

@@ -16,7 +17,9 @@ To install the extension, clone the [Lens Extension samples](https://github.com/
 git clone https://github.com/lensapp/lens-extension-samples.git
 ```

-Next you need to create a symlink. A symlink connects the directory that Lens will monitor for user-installed extensions to the sample extension. In this case the sample extension is `helloworld-sample`.
+Next you need to create a symlink.
+A symlink connects the directory that Lens will monitor for user-installed extensions to the sample extension.
+In this case the sample extension is `helloworld-sample`.

 ### Linux & macOS

@@ -64,16 +67,19 @@ npm install
 npm run build
 ```

-Optionally, automatically rebuild the extension by watching for changes to the source code. To do so, enter:
+Optionally, automatically rebuild the extension by watching for changes to the source code.
+To do so, enter:

 ```sh
 cd <lens-extension-samples directory>/helloworld-sample
 npm run dev
 ```

-You must restart Lens for the extension to load. After this initial restart, reload Lens and it will automatically pick up changes any time the extension rebuilds. 
+You must restart Lens for the extension to load.
+After this initial restart, reload Lens and it will automatically pick up changes any time the extension rebuilds.

-With Lens running, either connect to an existing cluster or [create a new one](../../clusters/adding-clusters.md). You will see the "Hello World" page in the left-side cluster menu.
+With Lens running, either connect to an existing cluster or [create a new one](../../clusters/adding-clusters.md).
+You will see the "Hello World" page in the left-side cluster menu.

 ## Develop the Extension

@@ -90,4 +96,5 @@ Finally, you'll make a change to the message that our Hello World sample extensi

 In the [next topic](anatomy.md), we'll take a closer look at the source code of our Hello World sample.

-You can find the source code for this tutorial at: [lensapp/lens-extension-samples](https://github.com/lensapp/lens-extension-samples/tree/master/helloworld-sample). [Extension Guides](../guides/README.md) contains additional samples.
+You can find the source code for this tutorial at: [lensapp/lens-extension-samples](https://github.com/lensapp/lens-extension-samples/tree/master/helloworld-sample).
+[Extension Guides](../guides/README.md) contains additional samples.