diff --git a/docs/contributing/README.md b/docs/contributing/README.md index 13a6ca8c05..ca588ab643 100644 --- a/docs/contributing/README.md +++ b/docs/contributing/README.md @@ -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)! -## 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 diff --git a/docs/contributing/documentation.md b/docs/contributing/documentation.md index 00b9f9550e..c65d4dd803 100644 --- a/docs/contributing/documentation.md +++ b/docs/contributing/documentation.md @@ -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). -## 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: @@ -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. 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. diff --git a/docs/contributing/maintainers.md b/docs/contributing/maintainers.md index a73918b272..ed542e98ab 100644 --- a/docs/contributing/maintainers.md +++ b/docs/contributing/maintainers.md @@ -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. -## Issues Triage +## Issues triage -* **Labeling Issues:** Label issues accordingly. -* **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. -* **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. +* **Labeling issues:** Label issues accordingly. +* **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. +* **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. diff --git a/docs/contributing/promotion.md b/docs/contributing/promotion.md index 34d68231bd..9e88caa5fa 100644 --- a/docs/contributing/promotion.md +++ b/docs/contributing/promotion.md @@ -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. -## 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. @@ -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 * [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: diff --git a/docs/extensions/README.md b/docs/extensions/README.md index 4a118bd4d3..223bea77ab 100644 --- a/docs/extensions/README.md +++ b/docs/extensions/README.md @@ -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. diff --git a/docs/extensions/capabilities/common-capabilities.md b/docs/extensions/capabilities/common-capabilities.md index ee8745df08..d59a8d2c53 100644 --- a/docs/extensions/capabilities/common-capabilities.md +++ b/docs/extensions/capabilities/common-capabilities.md @@ -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. -## 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. @@ -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. @@ -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. @@ -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. @@ -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. @@ -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. @@ -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. @@ -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. @@ -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. @@ -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. diff --git a/docs/extensions/capabilities/styling.md b/docs/extensions/capabilities/styling.md index c95673540c..93cc6d111a 100644 --- a/docs/extensions/capabilities/styling.md +++ b/docs/extensions/capabilities/styling.md @@ -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. -## 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: ``` const Container = styled.div(() => ({ diff --git a/docs/extensions/get-started/anatomy.md b/docs/extensions/get-started/anatomy.md index 523c6b9781..1c54081cb7 100644 --- a/docs/extensions/get-started/anatomy.md +++ b/docs/extensions/get-started/anatomy.md @@ -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. diff --git a/docs/extensions/get-started/wrapping-up.md b/docs/extensions/get-started/wrapping-up.md index 95f36dbe88..2d0feeb90d 100644 --- a/docs/extensions/get-started/wrapping-up.md +++ b/docs/extensions/get-started/wrapping-up.md @@ -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 diff --git a/docs/extensions/get-started/your-first-extension.md b/docs/extensions/get-started/your-first-extension.md index e43103c008..0b179fc763 100644 --- a/docs/extensions/get-started/your-first-extension.md +++ b/docs/extensions/get-started/your-first-extension.md @@ -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. diff --git a/docs/extensions/testing-and-publishing/testing.md b/docs/extensions/testing-and-publishing/testing.md index f96e3ce9e5..fd918049b1 100644 --- a/docs/extensions/testing-and-publishing/testing.md +++ b/docs/extensions/testing-and-publishing/testing.md @@ -1,4 +1,4 @@ -# Testing Extensions +# Testing extensions ## Console.log diff --git a/docs/extensions/usage/README.md b/docs/extensions/usage/README.md index 7ca1ab7e51..dc1501c907 100644 --- a/docs/extensions/usage/README.md +++ b/docs/extensions/usage/README.md @@ -1,3 +1,3 @@ -# Using Extensions +# Using extensions TBD diff --git a/docs/getting-started/README.md b/docs/getting-started/README.md index e4c6c38bec..fc8bb37575 100644 --- a/docs/getting-started/README.md +++ b/docs/getting-started/README.md @@ -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. @@ -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). -## Next Steps +## Next steps - [Add clusters](../clusters/adding-clusters.md) - [Watch introductory videos](./introductory-videos.md) diff --git a/docs/helm/README.md b/docs/helm/README.md index c6ea505cc3..7589d31dcd 100644 --- a/docs/helm/README.md +++ b/docs/helm/README.md @@ -1,3 +1,3 @@ -# Using Helm Charts +# Using Helm charts TBD diff --git a/mkdocs.yml b/mkdocs.yml index 021287ac94..a22052988d 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -9,33 +9,33 @@ copyright: Copyright © 2020 Mirantis Inc.