mirror of
https://github.com/lensapp/lens.git
synced 2025-05-20 05:10:56 +00:00
Changed titles and headings to sentence case and title/heading verbs to gerunds
Signed-off-by: Paul Williams <pawilliams@mirantis.com>
This commit is contained in:
1 parent
033a91f002
commit
d83932b5c5
15 files changed
+60
-60
No files matched your search
@@ -1,4 +1,4 @@
|
||||
# Extension Anatomy
|
||||
# Extension anatomy
|
||||
|
||||
You've now learnt how to get basic extension running. In this topic you will learn some fundamental concepts to Lens Extension development; How does it work under the hood?
|
||||
|
||||
@@ -10,7 +10,7 @@ You've now learnt how to get basic extension running. In this topic you will lea
|
||||
|
||||
Let's take a closer look at Hello World sample's source code and see how to achieve these things.
|
||||
|
||||
## Extension File Structure
|
||||
## Extension file structure
|
||||
|
||||
```
|
||||
.
|
||||
@@ -28,7 +28,7 @@ Let's take a closer look at Hello World sample's source code and see how to achi
|
||||
|
||||
Extension directory contains extension's entry files and few configuration files. Let's focus on `package.json`, `main.ts` and `renderer.tsx` which are essential to understanding the `Hello World` extension.
|
||||
|
||||
### Extension Manifest
|
||||
### Extension manifest
|
||||
|
||||
Each Lens extension must have `package.json`. The `package.json` contains a mix of Node.js fields such as scripts and dependencies and Lens specific fields such as `publisher` and `contributes`. Here are some most important fields:
|
||||
|
||||
@@ -69,7 +69,7 @@ Each Lens extension must have `package.json`. The `package.json` contains a mix
|
||||
}
|
||||
```
|
||||
|
||||
## Extension Entry Files
|
||||
## Extension entry files
|
||||
Lens extensions can have two separate entry files. One file that is used in `main` process of Lens application and antoher that is used in `renderer` process. `main` entry file should export class that extends `LensMainExtension` and `renderer` entry file should export class that extends `LensRendererExtension`.
|
||||
|
||||
Both extensions classes have `onActivate` and `onDeactivate` methods. `onActivate` is executed when your extension activation happens. You may want to initialize something in your extension at this point. `onDeactivate` gives you a chance to clean up before your extension becomes deactivated. For many extensions, explicit cleanup may not be required, and you don't need to override this method. However, if an extension needs to perform an operation when Lens is shutting down or the extension is disabled or uninstalled, this is the method to do so.
|
||||
|
||||
@@ -1,16 +1,16 @@
|
||||
# Wrapping Up
|
||||
# Wrapping up
|
||||
|
||||
In the [Your First Extension](your-first-extension.md) topic, you learned how to create and run an extension. In the [Extension Anatomy](anatomy.md) topic, you learned fundamental concepts to Lens extension development. However, this is just a small glimpse of what can be created with Lens Extensions. Below are some suggested routes for furthering your Lens extension development skills.
|
||||
|
||||
## Extension Capabilities
|
||||
## Extension capabilities
|
||||
|
||||
In this section, we split the Lens extension points into a few categories, each with short descriptions as to what your extension could achieve. Validate that your extension idea is achievable by reading the [Extension Capabilities](../capabilities/overview.md) section for new extension ideas.
|
||||
|
||||
## Guides & Samples
|
||||
## Guides and samples
|
||||
|
||||
We have a great collection of sample extensions that you can adapt from, and some of them include a detailed guide that explains the source code. You can find all Samples & Guides in the [lens-extension-samples](https://github.com/lensapp/lens-extension-samples) repository.
|
||||
|
||||
## Testing and Publishing
|
||||
## Testing and publishing
|
||||
|
||||
This section includes topics that help you develop high-quality Lens extensions. For example, you can learn
|
||||
|
||||
|
||||
@@ -1,8 +1,8 @@
|
||||
# Your First Extension
|
||||
# Your first extension
|
||||
|
||||
In this topic, we'll teach you the fundamental concepts for building extensions.
|
||||
|
||||
## Installing and Building the extension
|
||||
## Installing and building the extension
|
||||
|
||||
Simple Lens extension that adds "Hello World" page to a cluster menu.
|
||||
|
||||
|
||||
Reference in new issue
Block a user