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

Written content edits to Clusters and Getting Started (#1204)

Browse Source 
* Updated written content in Getting started and Clusters

* Updated written content in index.md, downloading-lens.md, and removing-clusters.md

* Fixed links to /clusters/adding-clusters.md

* Removed .md from links to /clusters/adding-clusters.md in index.md and downloading-lens.md

* Fixed links to adding-clusters.md in index.md and downloading-lens.md

Co-authored-by: Paul Williams <pawilliams@mirantis.com>
This commit is contained in:
pauljwil 2020-11-03 13:25:08 -08:00 committed by GitHub
parent 6e132e0925
commit 973ff66a9f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
6 changed files with 32 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/README.md
View File

@ -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).

13
docs/clusters/adding-clusters.md
View File

@ -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.
**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.

9
docs/clusters/removing-clusters.md
View File

@ -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)

4
docs/getting-started/downloading-lens.md
View File

@ -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/).
Get up and running quickly by learning to [add clusters](../clusters/adding-clusters.md).

2
docs/getting-started/introductory-videos.md
View File

@ -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.
<ul class="video-list">
<li class="video">

13
docs/getting-started/preferences.md
View File

@ -3,21 +3,26 @@
## Color themes
Color themes let you modify the colors in Lens user interface to suit your preferences and work environment.
The Color Themes option in Lens preferences lets you set the colors in the Lens user interface to suit your liking.
In Lens, open the Preferences with **File** > **Preferences**. (**Code** > **Preferences** on macOS) and select your preferred theme from the **Color Theme** dropdown.
1. Go to **File** > **Preferences** (**Lens** > **Preferences** on Mac).
2. Select your preferred theme from the **Color Theme** dropdown.
![Color Theme](images/color-theme.png)
## Telemetry & usage tracking
Lens collects telemetry data, which is used to help understand how to improve the product. For example, this usage data helps to debug issues, such as slow start-up times, and to prioritize new features. While we appreciate the insights this data provides, we also know that not everyone wants to send usage data and you can disable telemetry as described in [disable telemetry reporting](#disable-telemetry-reporting). You can also read our [privacy statement](https://www.mirantis.com/company/privacy-policy/) to learn more.
Lens collects telemetry data, which is used to help us understand how to improve the product. For example, this usage data helps us to debug issues and to prioritize new features. While we appreciate the insights this data provides, we also know that not everyone wants to send usage data. Please see our [privacy statement](https://www.mirantis.com/company/privacy-policy/) to learn more.
### Disable telemetry reporting
If you don't wish to send usage data to Mirantis, you can disable the "Telemetry & Usage Tracking" in the Lens preferences.
From `File > Preferences` (macOS: `Lens > Preferences`), search for `Telemetry & Usage Tracking`, and uncheck the `Allow telemetry & usage tracking`. This will silence all telemetry events from Lens going forward. Telemetry information may have been collected and sent up until the point when you disable the setting.
1. Go to **File** > **Preferences** (**Lens** > **Preferences** on Mac).
2. Scroll down to **Telemetry & Usage Tracking**
3. Uncheck **Allow telemetry & usage tracking**.
This will silence all telemetry events from Lens going forward. Telemetry information may have been collected and sent up until the point when you disable this setting.
![Disable Telemetry & Usage Tracking](images/disabled-telemetry-usage-tracking.png)