diff --git a/docs/CNAME b/docs/CNAME index 12bc650410..f51f3799f9 100644 --- a/docs/CNAME +++ b/docs/CNAME @@ -1 +1 @@ -docs.k8slens.dev +api-docs.k8slens.dev diff --git a/docs/README.md b/docs/README.md index 1a13ddb6a9..f98403eb75 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,21 +1,46 @@ -# Overview +# Lens Extension API -Lens is the most powerful Kubernetes IDE on the market. It is a standalone application, and it is available on macOS, Windows, and Linux. Some of the benefits of using Lens include: +Customize and enhance the Lens experience with the Lens Extension API. +Use the extension API to create menus or page content. +The same extension API was used to create many of Lens's core features. +To install your first extension you should goto the [extension page](lens://app/extensions) in lens. -* Confidence that your clusters are properly setup and configured. -* Increased visibility, real time statistics, log streams, and hands-on troubleshooting capabilities. -* The ability to work with your clusters quickly and easily, radically improving productivity and the speed of business. +This documentation describes: -Watch this introductory video to see Lens in action: +* How to build, run, test, and publish an extension. +* How to take full advantage of the Lens Extension API. +* Where to find [guides](extensions/guides/README.md) and [code samples](https://github.com/lensapp/lens-extension-samples) to help get you started. -[![Screenshot](img/lens-intro-video-screenshot.png)](https://www.youtube.com/watch?v=eeDwdVXattc) +## What Extensions Can Do -**Note:** Use CTRL+click (on Windows and Linux) or CMD+click (on MacOS) to open the above in a new tab +Here are some examples of what you can achieve with the Extension API: + +* Add custom components & views in the UI - Extending the Lens Workbench + +For an overview of the Lens Extension API, refer to the [Common Capabilities](extensions/capabilities/common-capabilities.md) page. [Extension Guides Overview](extensions/guides/README.md) also includes a list of code samples and guides that illustrate various ways of using the Lens Extension API. + +## How to Build Extensions + +Here is what each section of the Lens Extension API docs can help you with: + +* **Getting 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. +* **API Reference** contains exhaustive references for the Lens Extension API, Contribution Points, and many other topics. + +## What's New + +Just like Lens itself, the extension API updates on a monthly cadence, rolling out new features with every release. + +Keep up with Lens and the Lens Extension API by reviewing the [release notes](https://github.com/lensapp/lens/releases). + +## Looking for Help + +If you have questions for extension development, try asking on the [Lens Dev Slack](http://k8slens.slack.com/). It's a public chatroom for Lens developers, where Lens team members chime in from time to time. + +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). Please use the labels `area/documentation` and/or `area/extension`. ## Downloading Lens [Download Lens](https://github.com/lensapp/lens/releases) for macOS, Windows, or Linux. - -## Quick Start - -Get up and running quickly by learning to [add clusters](clusters/adding-clusters.md). diff --git a/docs/clusters/adding-clusters.md b/docs/clusters/adding-clusters.md deleted file mode 100644 index c9a533a700..0000000000 --- a/docs/clusters/adding-clusters.md +++ /dev/null @@ -1,22 +0,0 @@ -# Adding Clusters - -Add clusters by clicking the **Add Cluster** button in the left-side menu. - -1. Click the **Add Cluster** button (indicated with a '+' icon). Or [click here](lens://app/cluster). -2. Enter the path to your kubeconfig file. You'll need to have a kubeconfig file for the cluster you want to add. You can either browse for the path from the file system or or enter it directly. - -Selected [cluster contexts](https://kubernetes.io/docs/concepts/configuration/organize-cluster-access-kubeconfig/#context) are added as a separate item in the left-side cluster menu to allow you to operate easily on multiple clusters and/or contexts. - -**NOTE**: Any cluster that you added manually will not be merged into your kubeconfig file. - -![Add Cluster](images/add-cluster.png) - -For more information on kubeconfig see [Kubernetes docs](https://kubernetes.io/docs/concepts/configuration/organize-cluster-access-kubeconfig/). - -To see your currently-enabled config with `kubectl`, enter `kubectl config view --minify --raw` in your terminal. - -When connecting to a cluster, make sure you have a valid and working kubeconfig for the cluster. Following lists known "gotchas" in some authentication types used in kubeconfig with Lens app. - -## Exec auth plugins - -When using [exec auth](https://kubernetes.io/docs/reference/access-authn-authz/authentication/#configuration) plugins make sure the paths that are used to call any binaries are full paths as Lens app might not be able to call binaries with relative paths. Make also sure that you pass all needed information either as arguments or env variables in the config, Lens app might not have all login shell env variables set automatically. diff --git a/docs/clusters/images/add-cluster.png b/docs/clusters/images/add-cluster.png deleted file mode 100644 index fa7b632026..0000000000 Binary files a/docs/clusters/images/add-cluster.png and /dev/null differ diff --git a/docs/clusters/images/cluster-context-menu.png b/docs/clusters/images/cluster-context-menu.png deleted file mode 100644 index d733840df3..0000000000 Binary files a/docs/clusters/images/cluster-context-menu.png and /dev/null differ diff --git a/docs/clusters/images/cluster-settings-features.png b/docs/clusters/images/cluster-settings-features.png deleted file mode 100644 index 3a8066309d..0000000000 Binary files a/docs/clusters/images/cluster-settings-features.png and /dev/null differ diff --git a/docs/clusters/images/cluster-settings-general.png b/docs/clusters/images/cluster-settings-general.png deleted file mode 100644 index d7de0a1a35..0000000000 Binary files a/docs/clusters/images/cluster-settings-general.png and /dev/null differ diff --git a/docs/clusters/images/cluster-settings-removal.png b/docs/clusters/images/cluster-settings-removal.png deleted file mode 100644 index badcbcc6e0..0000000000 Binary files a/docs/clusters/images/cluster-settings-removal.png and /dev/null differ diff --git a/docs/clusters/images/cluster-settings-status.png b/docs/clusters/images/cluster-settings-status.png deleted file mode 100644 index af8e939e35..0000000000 Binary files a/docs/clusters/images/cluster-settings-status.png and /dev/null differ diff --git a/docs/clusters/images/cluster-settings.png b/docs/clusters/images/cluster-settings.png deleted file mode 100644 index 27a4a72ff9..0000000000 Binary files a/docs/clusters/images/cluster-settings.png and /dev/null differ diff --git a/docs/clusters/images/remove-cluster.png b/docs/clusters/images/remove-cluster.png deleted file mode 100644 index bcaa69c44a..0000000000 Binary files a/docs/clusters/images/remove-cluster.png and /dev/null differ diff --git a/docs/clusters/removing-clusters.md b/docs/clusters/removing-clusters.md deleted file mode 100644 index 3ec0d3a1cd..0000000000 --- a/docs/clusters/removing-clusters.md +++ /dev/null @@ -1,12 +0,0 @@ -# Removing Clusters - -Remove Lens clusters using the context menu that appears when you right-click the cluster in the left-side menu that you want to remove. - -To remove a cluster from your cluster list: - -1. Right-click the name of the cluster in the left-side menu that you want to remove. -2. Click **Remove**. - -**NOTE**: This will only remove the cluster from your Lens cluster list. It will not affect your actual Kubernetes cluster or its configuration. - -![Remove Cluster](images/remove-cluster.png) \ No newline at end of file diff --git a/docs/clusters/settings.md b/docs/clusters/settings.md deleted file mode 100644 index 351c0babeb..0000000000 --- a/docs/clusters/settings.md +++ /dev/null @@ -1,75 +0,0 @@ -# Settings - -It is easy to configure Lens Clusters to your liking through its various settings. - -1. Right-click the name of the cluster in the left-side menu that you want to open the settings for. -2. Click **Settings**. - -![Cluster settings](images/cluster-context-menu.png) - -## Status - -Overview of the cluster status - -### Cluster Status - -Cluster status information including the detected distribution, kernel version, API endpoint, and online status - -![Cluster settings status](images/cluster-settings-status.png) - -## General - -General cluster settings - -### Cluster Name - -The cluster name is inheritated by default from the kubeconfig file. Change the cluster name to another value by updating it here. Note that doing so does not update your kubeconfig file. - -### Workspace - -This is the Lens workspace that the cluster is associated with. Change workspaces by selecting a different workspace from the dropdown menu. Create a new workspace by clicking **workspace** in "Define cluster workspace" above the dropdown menu. This option will take you the workspaces editor. Create a new workspace and then navigate back to cluster settings. - -### Cluster Icon - -Lens randomly generates an icon to associate with each newly-created cluster. Use this setting to choose your own icon. - -### HTTP Proxy - -Some users will need to define an HTTP proxy for communicating with the Kubernetes API. Use this setting to do so. - -### Prometheus - -Lens can be configured to query a Prometheus server installed in the cluster. Select a query format by choosing either to auto-detect or from the following configurations: - -* Lens -* Helm Operator -* Prometheus Operator -* Stacklight - -To learn more about custom Prometheus configurations, please refer to this [guide](https://github.com/lensapp/lens/blob/master/troubleshooting/custom-prometheus.md). - -### Working Directory - -Use this field to set the terminal working directory. The default is `$HOME`. - -![Cluster settings general](images/cluster-settings-general.png) - -## Features - -Additional Lens features that can be installed by the user - -### Metrics - -Enable timeseries data visualization (Prometheus stack) for your cluster. Install this only if you don't have existing Prometheus stack installed. - -### User Mode - -User Mode feature enables non-admin users to see namespaces they have access to. This is achieved by configuring RBAC rules so that every authenticated user is granted to list namespaces. - -![Cluster settings features](images/cluster-settings-features.png) - -## Removal - -Use this setting to remove the current cluster. - -![Cluster settings removal](images/cluster-settings-removal.png) diff --git a/docs/contributing/README.md b/docs/contributing/README.md deleted file mode 100644 index 6cf7053fb8..0000000000 --- a/docs/contributing/README.md +++ /dev/null @@ -1,17 +0,0 @@ -# Contributing - -There are multiple ways you can contribute to Lens. Even if you are not a developer, you can still contribute. We are always looking for assistance with creating or updating documentation, testing the application, reporting, and troubleshooting issues. - -Here are some ways you can contribute! - -* [Development](./development.md) – Help make Lens better. -* [Maintaining the Project](./maintainers.md) – Become a community maintainer and help us maintain the project. -* [Extension Development](../extensions) – Add integrations via Lens Extensions. -* [Documentation](./documentation.md) – Help improve Lens documentation. -* [Promotion](./promotion.md) – Show your support, be an ambassador to Lens, write blogs, and make videos! - -If you are an influencer, blogger, or journalist, feel free to [spread the word](./promotion.md)! - -## 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/development.md b/docs/contributing/development.md deleted file mode 100644 index 89a9b898cd..0000000000 --- a/docs/contributing/development.md +++ /dev/null @@ -1,43 +0,0 @@ -# Development - -Thank you for taking the time to make a contribution to Lens. The following document is a set of guidelines and instructions for contributing to Lens. - -When contributing to this repository, please consider first discussing the change you wish to make by opening an issue. - -## Recommended Reading: - -- [TypeScript](https://www.typescriptlang.org/docs/home.html) (front-end/back-end) -- [ReactJS](https://reactjs.org/docs/getting-started.html) (front-end, ui) -- [MobX](https://mobx.js.org/) (app-state-management, back-end/front-end) -- [ElectronJS](https://www.electronjs.org/docs) (chrome/node) -- [NodeJS](https://nodejs.org/dist/latest-v12.x/docs/api/) (api docs) - -## Local Development Environment - -> Prerequisites: Nodejs v12, make, yarn - -* `make dev` - builds and starts the app -* `make clean` - cleanup local environment build artifacts - -### Developing on Windows - -On Windows we only support [Git Bash](https://gitforwindows.org/) (or similar shell) for running commands. - -## Github Workflow - -We Use [Github Flow](https://guides.github.com/introduction/flow/index.html), so all code changes are tracked via Pull Requests. -A detailed guide on the recommended workflow can be found below: - -* [Github Workflow](./github_workflow.md) - -## Code Testing - -All submitted PRs go through a set of tests and reviews. You can run most of these tests *before* a PR is submitted. -In fact, we recommend it, because it will save on many possible review iterations and automated tests. -The testing guidelines can be found here: - -* [Contributor's Guide to Testing](./testing.md) - -## License - -By contributing, you agree that your contributions will be licensed as described in [LICENSE](https://github.com/lensapp/lens/blob/master/LICENSE). diff --git a/docs/contributing/documentation.md b/docs/contributing/documentation.md deleted file mode 100644 index 501c57779f..0000000000 --- a/docs/contributing/documentation.md +++ /dev/null @@ -1,33 +0,0 @@ -# Documentation - -We are glad to see you're interested in contributing to the Lens documentation. If this is the first Open Source project you've contributed 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 - -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: - -1. Express your interest to start working on an issue via comments. -2. One of the maintainers will assign the issue for you. -3. You can start working on the issue. When you're done, simply submit a pull request. - -## Requirements for Documentation Pull Requests - -When you create a new pull request, we expect some requirements to be met. - -* Follow this naming convention for Pull Requests: - * When adding new documentation, add `New Documentation:` before the title. E.g. `New Documentation: Getting Started` - * When fixing documentation, add `Fix Documentation:` before the title. E.g. `Fix Documentation: Getting Started` - * When updating documentation, add `Update Documentation:` before the title. E.g. `Update Documentation: Getting Started` -* If your Pull Request closes an issue, you must write `Closes #ISSUE_NUMBER` where the ISSUE_NUMBER is the number in the end of the link url or the relevent issue. This will link your pull request to the issue, and when it is merged, the issue will close. -* For each pull request made, we run tests to check if there are any broken links, the markdown formatting is valid, and the linter is passing. - - -## Testing Documentation Site Locally - -Run a local instance of `mkdocs` in a docker container for developing the Lens Documentation. - -> Prerequisites: docker, yarn - -* `make docs` - local build and serve of mkdocs with auto update enabled - -Go to [localhost:8000](http://127.0.0.1:8000). diff --git a/docs/contributing/github_workflow.md b/docs/contributing/github_workflow.md deleted file mode 100644 index 3509645b47..0000000000 --- a/docs/contributing/github_workflow.md +++ /dev/null @@ -1,148 +0,0 @@ -# Github Workflow - - -- [Fork The Project](#fork-the-project) -- [Adding the Forked Remote](#adding-the-forked-remote) -- [Create & Rebase Your Feature Branch](#create--rebase-your-feature-branch) -- [Commit & Push](#commit--push) -- [Open a Pull Request](#open-a-pull-request) - - [Get a code review](#get-a-code-review) - - [Squash commits](#squash-commits) - - [Push Your Final Changes](#push-your-final-changes) - - -This guide assumes you have already cloned the upstream repo to your system via git clone. - -## Fork The Project - -1. Go to [http://github.com/lensapp/lens](http://github.com/lensapp/lens) -2. On the top, right-hand side, click on "fork" and select your username for the fork destination. - -## Adding the Forked Remote - -``` -export GITHUB_USER={ your github's username } - -cd $WORKDIR/lens -git remote add $GITHUB_USER git@github.com:${GITHUB_USER}/lens.git - -# Prevent push to Upstream -git remote set-url --push origin no_push - -# Set your fork remote as a default push target -git push --set-upstream $GITHUB_USER master -``` - -Your remotes should look something like this: - -``` -➜ git remote -v -origin https://github.com/lensapp/lens (fetch) -origin no_push (push) -my_fork git@github.com:{ github_username }/lens.git (fetch) -my_fork git@github.com:{ github_username }/lens.git (push) -``` - -## Create & Rebase Your Feature Branch - -Create a feature branch: - -``` -git branch -b my_feature_branch -``` - -Rebase your branch: - -``` -git fetch origin - -git rebase origin/master -Current branch my_feature_branch is up to date. -``` - -Please don't use `git pull` instead of the above `fetch / rebase`. `git pull` does a merge, which leaves merge commits. These make the commit history messy and violate the principle that commits ought to be individually understandable and useful. - -## Commit & Push - -Commit and sign your changes: - -``` -git commit -m "my commit title" --signoff -``` - -You can go back and edit/build/test some more, then `commit --amend` in a few cycles. - -When ready, push your changes to your fork's repository: - -``` -git push --set-upstream my_fork my_feature_branch -``` - -## Open a Pull Request - -See [Github Docs](https://docs.github.com/en/free-pro-team@latest/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request-from-a-fork). - -### Get a code review - -Once your pull request has been opened it will be assigned to one or more reviewers, and will go through a series of smoke tests. - -Commit changes made in response to review comments should be added to the same branch on your fork. - -Very small PRs are easy to review. Very large PRs are very difficult to review. - -### Squashing Commits -Commits on your branch should represent meaningful milestones or units of work. -Small commits that contain typo fixes, rebases, review feedbacks, etc should be squashed. - -To do that, it's best to perform an [interactive rebase](https://git-scm.com/book/en/v2/Git-Tools-Rewriting-History): - -#### Example -If you PR has 3 commits, count backwards from your last commit using `HEAD~3`: -``` -git rebase -i HEAD~3 -``` -Output would be similar to this: -``` -pick f7f3f6d Changed some code -pick 310154e fixed some typos -pick a5f4a0d made some review changes - -# Rebase 710f0f8..a5f4a0d onto 710f0f8 -# -# Commands: -# p, pick = use commit -# r, reword = use commit, but edit the commit message -# e, edit = use commit, but stop for amending -# s, squash = use commit, but meld into previous commit -# f, fixup = like "squash", but discard this commit's log message -# x, exec = run command (the rest of the line) using shell -# b, break = stop here (continue rebase later with 'git rebase --continue') -# d, drop = remove commit -# l, label