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

Changed titles and headings to sentence case and title/heading verbs to gerunds

Browse Source 
Signed-off-by: Paul Williams <pawilliams@mirantis.com>
This commit is contained in:
Paul Williams 2020-11-10 11:17:07 -08:00
parent 033a91f002
commit d83932b5c5
15 changed files with 60 additions and 60 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/contributing/README.md
View File

@ -12,6 +12,6 @@ Here are some ideas how you can contribute!
If you are an influencer, blogger or journalist, feel free to [spread the word](./promotion.md)! If you are an influencer, blogger or journalist, feel free to [spread the word](./promotion.md)!
## Code of Conduct ## Code of conduct
This project adheres to the [Contributor Covenant](https://www.contributor-covenant.org/) code of conduct. By participating and contributing to Lens, you are expected to uphold this code. Please report unacceptable behaviour to info@k8slens.dev This project adheres to the [Contributor Covenant](https://www.contributor-covenant.org/) code of conduct. By participating and contributing to Lens, you are expected to uphold this code. Please report unacceptable behaviour to info@k8slens.dev

4
docs/contributing/documentation.md
View File

@ -2,7 +2,7 @@
We are glad to see you are interested in contributing to Lens documentation. If this is the first Open Source project you will contribute to, we strongly suggest reading GitHub's excellent guide: [How to Contribute to Open Source](https://opensource.guide/how-to-contribute). We are glad to see you are interested in contributing to Lens documentation. If this is the first Open Source project you will contribute to, we strongly suggest reading GitHub's excellent guide: [How to Contribute to Open Source](https://opensource.guide/how-to-contribute).
## Finding Documentation Issues to Work On ## Finding documentation issues to work on
You can find a list of open documentation related issues [here](https://github.com/lensapp/lens/issues?q=is%3Aopen+is%3Aissue+label%3Aarea%2Fdocumentation). When you find something you would like to work on: You can find a list of open documentation related issues [here](https://github.com/lensapp/lens/issues?q=is%3Aopen+is%3Aissue+label%3Aarea%2Fdocumentation). When you find something you would like to work on:
@ -10,7 +10,7 @@ You can find a list of open documentation related issues [here](https://github.c
2. One of the maintainers will assign the issue for you. 2. One of the maintainers will assign the issue for you.
3. You can start working on the issue. Once done, simply submit a pull request. 3. You can start working on the issue. Once done, simply submit a pull request.
## Requirements for Documentation Pull Requests ## Requirements for documentation pull requests
When you create a new pull request, we expect some requirements to be met. When you create a new pull request, we expect some requirements to be met.

14
docs/contributing/maintainers.md
View File

@ -4,14 +4,14 @@ We are looking for community maintainers for the Lens project. Maintainers will
The responsibilities of a community maintainer are listed below. The responsibilities of a community maintainer are listed below.
## Issues Triage ## Issues triage
* **Labeling Issues:** Label issues accordingly. * **Labeling issues:** Label issues accordingly.
* **Finding Duplicates:** Finding and closing duplicate issues. * **Finding duplicates:** Finding and closing duplicate issues.
* **Doing First Level Contact:** Getting more information on the issues (like version number or asking for clarification) if needed. * **Doing first level contact:** Getting more information on the issues (like version number or asking for clarification) if needed.
* **Closing Irrelevant Issues:** Closing issues that are determined irrelevant, no longer needed, not relevant to the project and/or doesn't follow the issues guidelines. * **Closing irrelevant issues:** Closing issues that are determined irrelevant, no longer needed, not relevant to the project and/or doesn't follow the issues guidelines.
## Help with Contributions ## Help with contributions
* **Help Manage Pull Requests:** Help the author of the pull request with any problems. * **Help manage pull requests:** Help the author of the pull request with any problems.
* **Contributing:** Create pull requests to help maintain and drive the project forward. * **Contributing:** Create pull requests to help maintain and drive the project forward.

6
docs/contributing/promotion.md
View File

@ -1,8 +1,8 @@
# Promoting # Promotiion
Help promote Lens! If you are not a developer (or even if you are), you can still contribute to the project, a lot, by helping us promote it. As we are a free open source project, the community is our most important asset, so here are some ways that you can help the project continue to grow. Help promote Lens! If you are not a developer (or even if you are), you can still contribute to the project, a lot, by helping us promote it. As we are a free open source project, the community is our most important asset, so here are some ways that you can help the project continue to grow.
## Follow, Like, Recommend, Favorite, Vote and Star Us ## Follow, like, recommend, favorite, vote, and star us
There are many sites where you can vote, recommend, favorite and star us. There are many sites where you can vote, recommend, favorite and star us.
@ -13,7 +13,7 @@ There are many sites where you can vote, recommend, favorite and star us.
* [Reddit](https://www.reddit.com/search/?q=lens%20kubernetes&sort=new) - Upvote and be an ambassador of Lens by participating relevant discussions on Reddit * [Reddit](https://www.reddit.com/search/?q=lens%20kubernetes&sort=new) - Upvote and be an ambassador of Lens by participating relevant discussions on Reddit
* [Hacker News](https://hn.algolia.com/?dateRange=all&page=0&prefix=false&query=lens%20kubernetes&sort=byDate&type=story) - Upvote and be an ambassador of Lens by participating relevant discussions on Hacker News * [Hacker News](https://hn.algolia.com/?dateRange=all&page=0&prefix=false&query=lens%20kubernetes&sort=byDate&type=story) - Upvote and be an ambassador of Lens by participating relevant discussions on Hacker News
## Write Blogs or Make Videos About Us ## Write blogs or make videos about us
Here are some nice blog posts and videos about our project for you to get some inspiration: Here are some nice blog posts and videos about our project for you to get some inspiration:

2
docs/extensions/README.md
View File

@ -1,4 +1,4 @@
# Lens Extension API # Lens extension API
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. 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.

22
docs/extensions/capabilities/common-capabilities.md
View File

@ -1,8 +1,8 @@
# Common Capabilities # Common capabilities
Common Capabilities are important building blocks for your extensions. Almost all extensions use some of these functionalities. Here is how you can take advantage of them. Common Capabilities are important building blocks for your extensions. Almost all extensions use some of these functionalities. Here is how you can take advantage of them.
## Main Extension ## Main extension
A main extension runs in the background and, apart from app menu items, does not add content to the Lens UI. If you want to see logs from this extension you need to start Lens from the command line. A main extension runs in the background and, apart from app menu items, does not add content to the Lens UI. If you want to see logs from this extension you need to start Lens from the command line.
@ -34,7 +34,7 @@ export default class ExampleMainExtension extends LensMainExtension {
} }
``` ```
### App Menus ### App menus
An extension can register custom App menus that will be displayed on OS native menus. An extension can register custom App menus that will be displayed on OS native menus.
@ -56,7 +56,7 @@ export default class ExampleMainExtension extends LensMainExtension {
} }
``` ```
## Renderer Extension ## Renderer extension
A renderer extension runs in a browser context and it's visible directly via Lens main window. If you want to see logs from this extension you need to check them via View -> Toggle Developer Tools -> Console. A renderer extension runs in a browser context and it's visible directly via Lens main window. If you want to see logs from this extension you need to check them via View -> Toggle Developer Tools -> Console.
@ -88,7 +88,7 @@ export default class ExampleMainExtension extends LensRendererExtension {
} }
``` ```
### Global Pages ### Global pages
An extension can register custom global pages (views) to Lens main window. Global page is a full screen page that hides all the other content from a window. An extension can register custom global pages (views) to Lens main window. Global page is a full screen page that hides all the other content from a window.
@ -110,7 +110,7 @@ export default class ExampleRendererExtension extends LensRendererExtension {
} }
``` ```
### App Preferences ### App preferences
An extension can register custom app preferences. An extension is responsible for storing a state for custom preferences. An extension can register custom app preferences. An extension is responsible for storing a state for custom preferences.
@ -134,7 +134,7 @@ export default class ExampleRendererExtension extends LensRendererExtension {
} }
``` ```
### Cluster Pages ### Cluster pages
An extension can register custom cluster pages which are visible in a cluster menu when a cluster is opened. An extension can register custom cluster pages which are visible in a cluster menu when a cluster is opened.
@ -158,7 +158,7 @@ export default class ExampleExtension extends LensRendererExtension {
``` ```
### Cluster Features ### Cluster features
An extension can register installable features for a cluster. A cluster feature is visible in "Cluster Settings" page. An extension can register installable features for a cluster. A cluster feature is visible in "Cluster Settings" page.
@ -187,7 +187,7 @@ export default class ExampleExtension extends LensRendererExtension {
``` ```
### Status Bar Items ### Status bar items
An extension can register custom icons/texts to a status bar area. An extension can register custom icons/texts to a status bar area.
@ -212,7 +212,7 @@ export default class ExampleExtension extends LensRendererExtension {
``` ```
### Kubernetes Object Menu Items ### Kubernetes object menu items
An extension can register custom menu items (actions) for specified Kubernetes kinds/apiVersions. An extension can register custom menu items (actions) for specified Kubernetes kinds/apiVersions.
@ -235,7 +235,7 @@ export default class ExampleExtension extends LensRendererExtension {
``` ```
### Kubernetes Object Details ### Kubernetes object details
An extension can register custom details (content) for specified Kubernetes kinds/apiVersions. An extension can register custom details (content) for specified Kubernetes kinds/apiVersions.

2
docs/extensions/capabilities/styling.md
View File

@ -90,7 +90,7 @@ A complete list of all themable colors can be found in the [color reference](../
Colors values are located inside `src/renderer/themes/lens-dark.json` and `src/renderer/themes/lens-light.json` files. Colors values are located inside `src/renderer/themes/lens-dark.json` and `src/renderer/themes/lens-light.json` files.
## Using CSS Variables inside CSS-in-JS components ## Using CSS variables inside CSS-in-JS components
If a developer uses an `Emotion` (or similar) framework to work with styles inside an extension, they can use variables in the following form: If a developer uses an `Emotion` (or similar) framework to work with styles inside an extension, they can use variables in the following form:
``` ```
const Container = styled.div(() => ({ const Container = styled.div(() => ({

8
docs/extensions/get-started/anatomy.md
View File

@ -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? 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. 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 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: 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`. 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. 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.

8
docs/extensions/get-started/wrapping-up.md
View File

@ -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. 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. 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. 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 This section includes topics that help you develop high-quality Lens extensions. For example, you can learn

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

@ -1,8 +1,8 @@
# Your First Extension # Your first extension
In this topic, we'll teach you the fundamental concepts for building extensions. 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. Simple Lens extension that adds "Hello World" page to a cluster menu.

2
docs/extensions/testing-and-publishing/testing.md
View File

@ -1,4 +1,4 @@
# Testing Extensions # Testing extensions
## Console.log ## Console.log

2
docs/extensions/usage/README.md
View File

@ -1,3 +1,3 @@
# Using Extensions # Using extensions
TBD TBD

4
docs/getting-started/README.md
View File

@ -1,4 +1,4 @@
# Getting Started # Getting started
Lens is lightweight and simple to install. You'll be up and running in just a few minutes. Lens is lightweight and simple to install. You'll be up and running in just a few minutes.
@ -48,7 +48,7 @@ Lens releases a new version each month with new features and important bug fixes
To stay current with the Lens features, you can review the [release notes](https://github.com/lensapp/lens/releases). To stay current with the Lens features, you can review the [release notes](https://github.com/lensapp/lens/releases).
## Next Steps ## Next steps
- [Add clusters](../clusters/adding-clusters.md) - [Add clusters](../clusters/adding-clusters.md)
- [Watch introductory videos](./introductory-videos.md) - [Watch introductory videos](./introductory-videos.md)

2
docs/helm/README.md
View File

@ -1,3 +1,3 @@
# Using Helm Charts # Using Helm charts
TBD TBD

38
mkdocs.yml
View File

@ -9,33 +9,33 @@ copyright: Copyright &copy; 2020 <a href="https://mirantis.com/">Mirantis Inc.</
edit_uri: "" edit_uri: ""
nav: nav:
- Overview: README.md - Overview: README.md
- Getting Started: getting-started/README.md - Getting started: getting-started/README.md
- Managing Clusters: - Managing clusters:
- Adding clusters: clusters/adding-clusters.md - Adding clusters: clusters/adding-clusters.md
- Removing cluster: clusters/removing-clusters.md - Removing clusters: clusters/removing-clusters.md
- Settings: clusters/settings.md - Settings: clusters/settings.md
- Using Helm Charts: helm/README.md - Using Helm charts: helm/README.md
- Using Extensions: extensions/usage/README.md - Using extensions: extensions/usage/README.md
- Preferences: getting-started/preferences.md - Preferences: getting-started/preferences.md
- Extension Development: - Extension development:
- Overview: extensions/README.md - Overview: extensions/README.md
- Get Started: - Getting started:
- Your First Extension: extensions/get-started/your-first-extension.md - Your first extension: extensions/get-started/your-first-extension.md
- Extension Anatomy: extensions/get-started/anatomy.md - Extension anatomy: extensions/get-started/anatomy.md
- Wrapping Up: extensions/get-started/wrapping-up.md - Wrapping up: extensions/get-started/wrapping-up.md
- Extension Capabilities: - Extension capabilities:
- Overview: extensions/capabilities/README.md - Overview: extensions/capabilities/README.md
- Common Capabilities: extensions/capabilities/common-capabilities.md - Common capabilities: extensions/capabilities/common-capabilities.md
- Styling: extensions/capabilities/styling.md - Styling: extensions/capabilities/styling.md
- Color reference: extensions/capabilities/color-reference.md - Color reference: extensions/capabilities/color-reference.md
- Extension Guides: - Extension guides:
- Overview: extensions/guides/README.md - Overview: extensions/guides/README.md
- Renderer Extension: extensions/guides/renderer-extension.md - Renderer extension: extensions/guides/renderer-extension.md
- Testing and Publishing: - Testing and publishing:
- Testing Extensions: extensions/testing-and-publishing/testing.md - Testing extensions: extensions/testing-and-publishing/testing.md
- Publishing Extensions: extensions/testing-and-publishing/publishing.md - Publishing extensions: extensions/testing-and-publishing/publishing.md
- Bundling Extensions: extensions/testing-and-publishing/bundling.md - Bundling extensions: extensions/testing-and-publishing/bundling.md
- API Reference: extensions/api/README.md - API reference: extensions/api/README.md
- Contributing: - Contributing:
- Overview: contributing/README.md - Overview: contributing/README.md
- Development: contributing/development.md - Development: contributing/development.md