diff --git a/docs/your_first_extension.md b/docs/extensions/get-started/your-first-extension.md similarity index 100% rename from docs/your_first_extension.md rename to docs/extensions/get-started/your-first-extension.md diff --git a/docs/extensions_overview.md b/docs/extensions/overview.md similarity index 100% rename from docs/extensions_overview.md rename to docs/extensions/overview.md diff --git a/docs/index.md b/docs/index.md index e978e1716d..6c6351f7f0 100644 --- a/docs/index.md +++ b/docs/index.md @@ -18,10 +18,10 @@ Lens is the most powerful IDE for people who need to deal with Kubernetes cluste To get the most out of Lens, start by reviewing a few introductory topics: -[Extension API](https://docs.k8slens.dev) - Learn how to write a Lens extension. +[Extension API](/extensions/overview/) - Learn how to write a Lens extension. ... ## Downloads -[Download Lens IDE](https://github.com/lensapp/lens/releases/tag/v3.6.7) - Quickly find the appropriate install for your platform (Windows, macOS and Linux) \ No newline at end of file +[Download Lens IDE](https://github.com/lensapp/lens/releases) - Quickly find the appropriate install for your platform (Windows, macOS and Linux) \ No newline at end of file diff --git a/docs/setup/images/snap-store.png b/docs/setup/images/snap-store.png new file mode 100644 index 0000000000..5e652132c3 Binary files /dev/null and b/docs/setup/images/snap-store.png differ diff --git a/docs/setup/linux.md b/docs/setup/linux.md new file mode 100644 index 0000000000..252ad26899 --- /dev/null +++ b/docs/setup/linux.md @@ -0,0 +1,19 @@ +# 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 new file mode 100644 index 0000000000..e411c8f54a --- /dev/null +++ b/docs/setup/macos.md @@ -0,0 +1,9 @@ +# 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 new file mode 100644 index 0000000000..b31aea55a2 --- /dev/null +++ b/docs/setup/network.md @@ -0,0 +1,8 @@ +# 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 new file mode 100644 index 0000000000..f8f929843e --- /dev/null +++ b/docs/setup/overview.md @@ -0,0 +1,21 @@ +# 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](/setup/linux/) +* [macOS](/setup/macos/) +* [Windows](/setup/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 + +... \ No newline at end of file diff --git a/docs/setup/windows.md b/docs/setup/windows.md new file mode 100644 index 0000000000..f804eeda3d --- /dev/null +++ b/docs/setup/windows.md @@ -0,0 +1,7 @@ +# 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/docs/supporting/requirements.md b/docs/supporting/requirements.md new file mode 100644 index 0000000000..6eb929a3b3 --- /dev/null +++ b/docs/supporting/requirements.md @@ -0,0 +1,26 @@ +# Requirements for Lens + +## Hardware + +Lens is a small download (< 300 MB) and has a disk footprint of 600 MB. Lens is lightweight and should easily run on today's hardware. + +We recommend: + +* 2 GHz or faster processor +* 1 GB of RAM + +## Platforms + +Lens has been tested on the following platforms: + +* OS X +* Windows +* Linux + +### Additional Windows requirements + +... + +### Additional Linux requirements + +... diff --git a/mkdocs.yml b/mkdocs.yml index e7014ff400..905d7b44a0 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -9,8 +9,27 @@ copyright: Copyright © 2020 Mirantis Inc.