mirror of
https://github.com/lensapp/lens.git
synced 2025-05-20 05:10:56 +00:00
686cb122a3
* add step to verify docs on area/documentation PRs * use GH actions to run the verification * add check if label is set to area/documentation * fix broken links in docs with WIP files * add generating API docs before verifying Signed-off-by: Sebastian Malton <sebastian@malton.name> |
||
|---|---|---|
| .. | ||
| images | ||
| anatomy.md | ||
| components.md | ||
| generator.md | ||
| kube-object-list-layout.md | ||
| main-extension.md | ||
| README.md | ||
| renderer-extension.md | ||
| stores.md | ||
| working-with-mobx.md | ||
Extension Guides
The basics of the Lens Extension API are covered in Your First Extension. In this section detailed code guides and samples are used to explain how to use specific Lens Extension APIs.
Each guide or sample will include:
- Clearly commented source code.
- Instructions for running the sample extension.
- Image of the sample extension's appearance and usage.
- Listing of Extension API being used.
- Explanation of Extension API concepts.
Guides
| Guide | APIs |
|---|---|
| Generate new extension project | |
| Main process extension | LensMainExtension |
| Renderer process extension | LensRendererExtension |
| Stores | |
| Components | |
| KubeObjectListLayout | |
| Working with mobx |
Samples
| Sample | APIs |
|---|---|
| helloworld | LensMainExtension LensRendererExtension Component.Icon Component.IconProps |
| minikube | LensMainExtension Store.clusterStore Store.workspaceStore |
| styling-css-modules-sample | LensMainExtension LensRendererExtension Component.Icon Component.IconProps |
| styling-emotion-sample | LensMainExtension LensRendererExtension Component.Icon Component.IconProps |
| styling-sass-sample | LensMainExtension LensRendererExtension Component.Icon Component.IconProps |
| custom-resource-page | LensRendererExtension K8sApi.KubeApi K8sApi.KubeObjectStore Component.KubeObjectListLayout Component.KubeObjectDetailsProps Component.IconProps |