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

Updated Extensions docs

Browse Source
This commit is contained in:
Steve Richards 2020-10-28 15:29:05 +00:00
parent 4069e69e45
commit 008b3bfea7
2 changed files with 66 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

45
docs/extensions/get-started/your-first-extension.md
View File

@ -2,20 +2,45 @@
In this topic, we'll teach you the fundamental concepts for building extensions. Make sure you have [Node.js](https://nodejs.org/en/) and [Git](https://git-scm.com/) installed....
## Installing and Building the extension
Simple Lens extension that adds "hello-world" page to a cluster menu.
### Linux
```sh
mkdir -p ~/.k8slens/extensions
git clone https://github.com/lensapp/lens-extension-samples.git ~/.k8slens/extensions
```
To build the extension you can use `make` or run the `npm` commands manually:
```sh
cd ~/.k8slens/extensions/helloworld-sample
make build
```
OR
```sh
cd ~/.k8slens/extensions/helloworld-sample
npm install
npm run build
```
Open Lens application and navigate to a cluster. You should see "Hello World" in the Lens sidebar menu.
## Developing the extension
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nullam non ligula id tellus vehicula vestibulum sed quis neque. Pellentesque sed mollis augue, sit amet condimentum enim. Morbi commodo risus gravida dui gravida, ac vulputate erat consectetur. Class aptent taciti sociosqu ad litora torquent per conubia nostra, per inceptos himenaeos. Morbi dapibus molestie augue.
## Debugging the extension
And now this:
- One
- Two
- Three
Let's make a change to the message:
* Change the message from Hello World from HelloWorld! to **Hello Lens Extensions** in `page.tsx`
* Rebuild the extension
* Reload the Lens window
* You should see the updated message showing up.
## Next steps
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nullam non ligula id tellus vehicula vestibulum sed quis neque. Pellentesque sed mollis augue, sit amet condimentum enim. Morbi commodo risus gravida dui gravida, ac vulputate erat consectetur. Class aptent taciti sociosqu ad litora torquent per conubia nostra, per inceptos himenaeos. Morbi dapibus molestie augue.
In the next topic, [Extension Anatomy](anatomy.md), we'll take a closer look at the source code of the Hello World sample and explain key concepts.
You can find the source code of this tutorial at: [lensapp/lens-extension-samples](https://github.com/lensapp/lens-extension-samples/tree/master/helloworld-sample). The [Extension Guides](../guides/overview.md) topic contains other samples, each illustrating a different Lens Extension API.

43
docs/extensions/overview.md
View File

@ -1,29 +1,48 @@
# Lens Extension API
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nullam non ligula id tellus vehicula vestibulum sed quis neque. Pellentesque sed mollis augue, sit amet condimentum enim. Morbi commodo risus gravida dui gravida, ac vulputate erat consectetur. Class aptent taciti sociosqu ad litora torquent per conubia nostra, per inceptos himenaeos. Morbi dapibus molestie augue. Donec rutrum ultricies elit, sed posuere libero placerat quis. Ut sodales quam vel odio luctus, ut pharetra dui vestibulum. Nam pulvinar scelerisque erat sit amet vestibulum. Nullam posuere ac justo nec scelerisque. Fusce in congue odio.
The Extensions API in Lens allows users to customize and enhance the Lens experience by creating their own menus or page content that is extended from the existing pages. Many of the core features of Lens are built as extensions and use the same Extension API.
## What can extensions do?
This documentation describes:
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nullam non ligula id tellus vehicula vestibulum sed quis neque. Pellentesque sed mollis augue, sit amet condimentum enim. Morbi commodo risus gravida dui gravida, ac vulputate erat consectetur. Class aptent taciti sociosqu ad litora torquent per conubia nostra, per inceptos himenaeos. Morbi dapibus molestie augue.
* How to build, run, test and publish an extension
* How to take advantage of Lens's Extension API
* Where to find [guides](guides/overview.md) and [code samples](https://github.com/lensapp/lens-extension-samples) to help get you started
## How to build extensions?
Code samples are available at [lensapp/lens-extension-samples](https://github.com/lensapp/lens-extension-samples).
And now this:
## What can extensions do
- One
- Two
- Three
Here are some examples of what you can achieve with the Extension API:
* Add custom components & views in the UI - Extending the Lens Workbench
## What's new?
If you'd like to have a more comprehensive overview of the Extension API, refer to the [Extension Capabilities Overview](capabilities/overview.md) page. [Extension Guides Overview](guides/overview.md) also includes a list of code samples and guides that illustrate various Extension API usage.
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nullam non ligula id tellus vehicula vestibulum sed quis neque. Pellentesque sed mollis augue, sit amet condimentum enim. Morbi commodo risus gravida dui gravida, ac vulputate erat consectetur. Class aptent taciti sociosqu ad litora torquent per conubia nostra, per inceptos himenaeos. Morbi dapibus molestie augue.
## How to build extensions
Building a good extension can take a lot of effort. Here is what each section of the API doc can help you with:
* **Get Started** teaches fundamental concepts for building extensions with the Hello World sample.
* **Extension Capabilities** dissects Lens's Extension API into smaller categories and points you to more detailed topics.
* **Extension Guides** includes guides and code samples that explain specific usages of Lens Extension API.
* **Testing and Publishing** includes in-depth guides on various extension development topics, such as testing and publishing extensions.
* **Advanced Topics** explains advanced concepts such as integrating with 3rd party applications/services.
* **References** contains exhaustive references for the Lens Extension API, Contribution Points, and many other topics.
## What's new
Lens updates on a monthly cadence, and that applies to the Extension API as well. New features and APIs become available every month to increase the power and scope of Lens extensions.
To stay current with the Extension API and Lens features in general, you can review the [release notes](https://github.com/lensapp/lens/releases).
## Looking for help
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nullam non ligula id tellus vehicula vestibulum sed quis neque. Pellentesque sed mollis augue, sit amet condimentum enim. Morbi commodo risus gravida dui gravida, ac vulputate erat consectetur. Class aptent taciti sociosqu ad litora torquent per conubia nostra, per inceptos himenaeos. Morbi dapibus molestie augue.
If you have questions for extension development, try asking on:
* [Lens Dev Slack](http://k8slens.slack.com/): Public chatroom for Lens developers. Some Lens team members chime in on conversations.
## Download Lens K8s IDE
To provide feedback on the documentation or issues with the Lens Extension API, create new issues at [lensapp/lens](https://github.com/lensapp/lens/issues) with the labels `area/documentation` and/or `area/extension`.
## Download Lens - The Kubernetes IDE
Go to [Lens](https://k8slens.dev)