diff --git a/docs/clusters/add-cluster.md b/docs/clusters/adding-clusters.md similarity index 96% rename from docs/clusters/add-cluster.md rename to docs/clusters/adding-clusters.md index 15381d22c1..ded093c1a6 100644 --- a/docs/clusters/add-cluster.md +++ b/docs/clusters/adding-clusters.md @@ -1,4 +1,4 @@ -# Add Cluster +# 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. diff --git a/docs/clusters/remove-cluster.md b/docs/clusters/removing-clusters.md similarity index 95% rename from docs/clusters/remove-cluster.md rename to docs/clusters/removing-clusters.md index dcdfbd975d..0a38213531 100644 --- a/docs/clusters/remove-cluster.md +++ b/docs/clusters/removing-clusters.md @@ -1,4 +1,4 @@ -# Remove Cluster +# 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. diff --git a/docs/get-started/themes.md b/docs/get-started/themes.md deleted file mode 100644 index cd7ca9d1c3..0000000000 --- a/docs/get-started/themes.md +++ /dev/null @@ -1,7 +0,0 @@ -# Color Themes - -Color themes let you modify the colors in Lens user interface to suit your preferences and work environment. - -In Lens, open the Preferences with **File** > **Preferences**. (**Code** > **Preferences** on macOS) and select your preferred theme from the **Color Theme** dropdown. -![Color Theme](images/color-theme.png) - diff --git a/docs/getting-started/downloading-lens.md b/docs/getting-started/downloading-lens.md new file mode 100644 index 0000000000..dc732d104e --- /dev/null +++ b/docs/getting-started/downloading-lens.md @@ -0,0 +1,64 @@ +# Downloading Lens + +Lens is lightweight and simple to install. You'll be up and running in just a few minutes. + + +## System requirements + +Review the [System Requirements](/supporting/requirements/) to check if your computer configuration is supported. + + +## macOS + +1. [Download Lens](https://github.com/lensapp/lens/releases) for macOS. +2. Open the browser's download list and locate the downloaded archive. +3. Select the 'magnifying glass' icon to open the archive in Finder. +4. Double-click `Lens-{version}.dmg` and drag `Lens.app` to the `Applications` folder, making it available in the macOS Launchpad. +5. Add Lens to your Dock by right-clicking on the icon to bring up the context menu and choosing **Options**, **Keep in Dock**. + + +## Windows + +1. Download the [Lens installer](https://github.com/lensapp/lens/releases) for Windows. +2. Once it is downloaded, run the installer `Lens-Setup-{version}.exe`. This will only take a minute. +3. By default, Lens is installed under `C:\users\{username}\AppData\Local\Programs\Lens`. + + +## Linux + +See the [Download Lens](https://github.com/lensapp/lens/releases) page for a complete list of available installation options. + + +### Snap + +Lens is officially distributed as a Snap package in the [Snap Store](https://snapcraft.io/store): + +[![Get it from the Snap Store](images/snap-store.png)](https://snapcraft.io/kontena-lens) + +You can install it by running: + +```bash +sudo snap install kontena-lens --classic +``` + + +## Network + +Lens is built on top of Electron and benefits from all the networking stack capabilities of Chromium. + + +### Proxy server support + +... + + +## Update cadence + +Lens releases a new version each month with new features and important bug fixes. Lens supports auto updating and you will be prompted to install the new release when it becomes available! + +To stay current with the Lens features, you can review the [release notes](https://github.com/lensapp/lens/releases). + + +## Quickstart + +Get up and running quickly by learning to [add clusters](/clusters/add-cluster/). \ No newline at end of file diff --git a/docs/get-started/images/color-theme.png b/docs/getting-started/images/color-theme.png similarity index 100% rename from docs/get-started/images/color-theme.png rename to docs/getting-started/images/color-theme.png diff --git a/docs/get-started/images/disabled-telemetry-usage-tracking.png b/docs/getting-started/images/disabled-telemetry-usage-tracking.png similarity index 100% rename from docs/get-started/images/disabled-telemetry-usage-tracking.png rename to docs/getting-started/images/disabled-telemetry-usage-tracking.png diff --git a/docs/setup/images/snap-store.png b/docs/getting-started/images/snap-store.png similarity index 100% rename from docs/setup/images/snap-store.png rename to docs/getting-started/images/snap-store.png diff --git a/docs/get-started/intro-videos.md b/docs/getting-started/introductory-videos.md similarity index 100% rename from docs/get-started/intro-videos.md rename to docs/getting-started/introductory-videos.md diff --git a/docs/get-started/telemetry.md b/docs/getting-started/preferences.md similarity index 71% rename from docs/get-started/telemetry.md rename to docs/getting-started/preferences.md index 77ecb2a2ff..96232b5f6b 100644 --- a/docs/get-started/telemetry.md +++ b/docs/getting-started/preferences.md @@ -1,10 +1,23 @@ -# Telemetry & Usage Tracking +# Preferences + + +## Color themes + +Color themes let you modify the colors in Lens user interface to suit your preferences and work environment. + +In Lens, open the Preferences with **File** > **Preferences**. (**Code** > **Preferences** on macOS) and 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. -## Disable telemetry reporting + +### 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. ![Disable Telemetry & Usage Tracking](images/disabled-telemetry-usage-tracking.png) + diff --git a/docs/index.md b/docs/index.md index 3d66242a2a..1a35e4e882 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,32 +1,19 @@ -# Getting Started +# Overview -Lens is the most powerful IDE for people who need to deal with Kubernetes clusters on a daily basis. It is a standalone application for MacOS, Windows and Linux operating systems. Ensure your clusters are properly setup and configured. Enjoy increased visibility, real time statistics, log streams and hands-on troubleshooting capabilities. With Lens, you can work with your clusters more easily and fast, radically improving productivity and the speed of business. Begin your journey with Lens with these [introductory videos](/get-started/intro-videos/). +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: +* 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. - -## Lens in Action +Watch this introductory video to see Lens in action: +## Downloading Lens -## Top Extensions +[Download Lens](https://github.com/lensapp/lens/releases) for macOS, Windows, or Linux. -- One -- Two -- Three +## Quickstart - -## First Steps - -To get the most out of Lens, start by reviewing a few introductory topics: - -[Intro Videos](get-started/intro-videos/) - Begin your journey with Lens through these introductory videos. - -[Add Clusters](clusters/add-cluster/) - Add your first Cluster to radically improve productivity and the speed of business. - -[Extension API](extensions/overview/) - Learn how to write a Lens extension. - - -## Downloads - -[Download Lens IDE](setup/overview/) - Quickly find the appropriate install for your platform (Windows, macOS and Linux) +Get up and running quickly by learning to [add clusters](/clusters/add-cluster/). diff --git a/docs/setup/linux.md b/docs/setup/linux.md deleted file mode 100644 index 252ad26899..0000000000 --- a/docs/setup/linux.md +++ /dev/null @@ -1,19 +0,0 @@ -# Lens on Linux - -## Installation - -See the [Download Lens](https://github.com/lensapp/lens/releases) page for a complete list of available installation options. - - - -### Snap - -Lens is officially distributed as a Snap package in the [Snap Store](https://snapcraft.io/store): - -[![Get it from the Snap Store](images/snap-store.png)](https://snapcraft.io/kontena-lens) - -You can install it by running: - -```bash -sudo snap install kontena-lens --classic -``` \ No newline at end of file diff --git a/docs/setup/macos.md b/docs/setup/macos.md deleted file mode 100644 index e411c8f54a..0000000000 --- a/docs/setup/macos.md +++ /dev/null @@ -1,9 +0,0 @@ -# Lens on macOS - -## Installation - -1. [Download Lens](https://github.com/lensapp/lens/releases) for macOS. -2. Open the browser's download list and locate the downloaded archive. -3. Select the 'magnifying glass' icon to open the archive in Finder. -4. Double-click `Lens-{version}.dmg` and drag `Lens.app` to the `Applications` folder, making it available in the macOS Launchpad. -5. Add Lens to your Dock by right-clicking on the icon to bring up the context menu and choosing **Options**, **Keep in Dock**. \ No newline at end of file diff --git a/docs/setup/network.md b/docs/setup/network.md deleted file mode 100644 index b31aea55a2..0000000000 --- a/docs/setup/network.md +++ /dev/null @@ -1,8 +0,0 @@ -# Network Connections in Lens - -Lens is built on top of Electron and benefits from all the networking stack capabilities of Chromium. - - -## Proxy server support - -... diff --git a/docs/setup/overview.md b/docs/setup/overview.md deleted file mode 100644 index 1e53fbb32c..0000000000 --- a/docs/setup/overview.md +++ /dev/null @@ -1,23 +0,0 @@ -# Setting up Lens - -Getting up and running with Lens is quick and easy. It is a small download so you can install in a matter of minutes and give Lens a try. - - -## Cross platform - -Lens is the most powerful IDE for people who need to deal with Kubernetes clusters on a daily basis which runs on the macOS, Linux, and Windows operating systems. - -Follow the platform-specific guides below: - -* [Linux](linux/) -* [macOS](macos/) -* [Windows](windows/) - -Lens is lightweight and should run on most available hardware and platform versions. You can review the [System Requirements](supporting/requirements/) to check if your computer configuration is supported. - - -## Update cadence - -Lens releases a new version each month with new features and important bug fixes. Lens supports auto updating and you will be prompted to install the new release when it becomes available! - -To stay current with the Lens features, you can review the [release notes](https://github.com/lensapp/lens/releases). \ No newline at end of file diff --git a/docs/setup/windows.md b/docs/setup/windows.md deleted file mode 100644 index f804eeda3d..0000000000 --- a/docs/setup/windows.md +++ /dev/null @@ -1,7 +0,0 @@ -# Lens on Windows - -## Installation - -1. Download the [Lens installer](https://github.com/lensapp/lens/releases) for Windows. -2. Once it is downloaded, run the installer `Lens-Setup-{version}.exe`. This will only take a minute. -3. By default, Lens is installed under `C:\users\{username}\AppData\Local\Programs\Lens`. \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml index 848f291021..46d16a8903 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -9,21 +9,14 @@ copyright: Copyright © 2020 Mirantis Inc.