diff --git a/docs/README.md b/docs/README.md index c89c51cd3c..f8a979fb90 100644 --- a/docs/README.md +++ b/docs/README.md @@ -16,6 +16,6 @@ Watch this introductory video to see Lens in action: [Download Lens](https://github.com/lensapp/lens/releases) for macOS, Windows, or Linux. -## Quickstart +## Quick Start -Get up and running quickly by learning to [add clusters](/clusters/add-cluster/). +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 index ded093c1a6..a89afb2f25 100644 --- a/docs/clusters/adding-clusters.md +++ b/docs/clusters/adding-clusters.md @@ -1,9 +1,16 @@ # Adding clusters -Add clusters by clicking the Add Cluster button in the left-side menu. You'll need to obtain a working kubeconfig for the cluster you want to add. You can either browse it from the file system or paste it as a text from the clipboard. +Add clusters by clicking the **Add Cluster** button in the left-side menu. -Selected cluster contexts are added as a separate item in the left-side cluster menu to allow you to operate easily on multiple clusters and/or contexts. +1. Click the **Add Cluster** button (indicated with a '+' icon). +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. -**NOTE**: Any manually added cluster is not merged into your kubeconfig file. +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. -![Add Cluster](images/add-cluster.png) \ No newline at end of file +**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. \ No newline at end of file diff --git a/docs/clusters/removing-clusters.md b/docs/clusters/removing-clusters.md index 0a38213531..89b7286f99 100644 --- a/docs/clusters/removing-clusters.md +++ b/docs/clusters/removing-clusters.md @@ -1,7 +1,12 @@ # Removing clusters -You can remove a Lens Clusters from your cluster list using the context-menu of the cluster item in the left-side menu. By right-clicking the cluster of choice you can hit the `Remove` button to delete it from your list. +You can remove Lens clusters using the context menu that appears when you hover over the cluster in the left-side menu that you want to remove. By right-clicking the cluster of choice you can hit the `Remove` button to delete it from your list. -**NOTE**: This will only remove the cluster from your Lens Cluster list but not affect your actual Kubernetes Cluster or its configuration! +To remove a cluster from your cluster list: + +1. Hover over the name of the cluster you want to remove in the left side menu. A context menu will appear. +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/getting-started/downloading-lens.md b/docs/getting-started/downloading-lens.md index dc732d104e..2493edc5f6 100644 --- a/docs/getting-started/downloading-lens.md +++ b/docs/getting-started/downloading-lens.md @@ -59,6 +59,6 @@ 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). -## Quickstart +## Quick Start -Get up and running quickly by learning to [add clusters](/clusters/add-cluster/). \ No newline at end of file +Get up and running quickly by learning to [add clusters](../clusters/adding-clusters.md). \ No newline at end of file diff --git a/docs/getting-started/introductory-videos.md b/docs/getting-started/introductory-videos.md index 86fce6f8c9..fcaee999c0 100644 --- a/docs/getting-started/introductory-videos.md +++ b/docs/getting-started/introductory-videos.md @@ -1,6 +1,6 @@ # Introductory Videos -Start your journey using Lens with this set of introductory videos! These videos are designed to give you an overview of Lens various features and quickly get you familiar with them. +Continue your Lens journey with this set of introductory videos! These videos are meant to quickly familiarize you with Lens' various powerful features.