1
0
mirror of https://github.com/lensapp/lens.git synced 2025-05-20 05:10:56 +00:00

Restructure docs menu (#1235)

Signed-off-by: Jari Kolehmainen <jari.kolehmainen@gmail.com>
This commit is contained in:
Jari Kolehmainen 2020-11-05 17:30:49 +02:00 committed by GitHub
parent 3bc45218c1
commit f8ae8cc53d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
11 changed files with 50 additions and 51 deletions

View File

@ -20,7 +20,7 @@ The cluster name is inheritated from the kubeconfig by default. You can change t
### Workspace
This is the Lens Workspace that the cluster is associated with. You can change to another workspace or create a new workspace - this option will take you the Workspaces editor where you can create a new workspace and then
This is the Lens Workspace that the cluster is associated with. You can change to another workspace or create a new workspace - this option will take you the Workspaces editor where you can create a new workspace and then
navigate back to the cluster settings.
### Cluster Icon
@ -50,14 +50,6 @@ The terminat working directory can be configured here - by default it is set to
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.
## Removal
Remove the current cluster.

View File

@ -0,0 +1 @@
TBD

View File

@ -0,0 +1,3 @@
# Lens Extension API Reference
TBD

View File

@ -0,0 +1,3 @@
# Using Extensions
TBD

1
docs/faq/README.md Normal file
View File

@ -0,0 +1 @@
TBD

View File

@ -1,4 +1,4 @@
# Downloading Lens
# Getting Started
Lens is lightweight and simple to install. You'll be up and running in just a few minutes.
@ -41,17 +41,6 @@ You can install it by running:
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!
@ -59,6 +48,8 @@ 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).
## Quick Start
## Next Steps
- [Add clusters](../clusters/adding-clusters.md)
- [Watch introductory videos](./introductory-videos.md)
Get up and running quickly by learning to [add clusters](../clusters/adding-clusters.md).

3
docs/helm/README.md Normal file
View File

@ -0,0 +1,3 @@
# Using Helm Charts
TBD

View File

@ -8,33 +8,35 @@ repo_url: https://github.com/lensapp/lens
copyright: Copyright &copy; 2020 <a href="https://mirantis.com/">Mirantis Inc.</a> - All rights reserved.
edit_uri: ""
nav:
- Overview: README.md
- Getting started:
- Downloading Lens: getting-started/downloading-lens.md
- Preferences: getting-started/preferences.md
- Introductory videos: getting-started/introductory-videos.md
- Clusters:
- Adding clusters: clusters/adding-clusters.md
- Removing cluster: clusters/removing-clusters.md
- Settings: clusters/settings.md
- Extensions:
- Overview: extensions/overview.md
- Get Started:
- Your First Extension: extensions/get-started/your-first-extension.md
- Extension Anatomy: extensions/get-started/anatomy.md
- Wrapping Up: extensions/get-started/wrapping-up.md
- Extension Capabilities:
- Overview: extensions/capabilities/overview.md
- Common Capabilities: extensions/capabilities/common-capabilities.md
- Theming: extensions/capabilities/theming.md
- Extension Guides:
- Overview: extensions/guides/overview.md
- Renderer Extension: extensions/guides/renderer-extension.md
- Testing and Publishing:
- Testing Extensions: extensions/testing-and-publishing/testing.md
- Publishing Extensions: extensions/testing-and-publishing/publishing.md
- Bundling Extensions: extensions/testing-and-publishing/bundling.md
- Lens Website: https://k8slens.dev
- Overview: README.md
- Getting Started: getting-started/README.md
- Managing Clusters:
- Adding clusters: clusters/adding-clusters.md
- Removing cluster: clusters/removing-clusters.md
- Settings: clusters/settings.md
- Using Helm Charts: helm/README.md
- Using Extensions: extensions/usage/README.md
- Preferences: getting-started/preferences.md
- Extension Development:
- Overview: extensions/README.md
- Get Started:
- Your First Extension: extensions/get-started/your-first-extension.md
- Extension Anatomy: extensions/get-started/anatomy.md
- Wrapping Up: extensions/get-started/wrapping-up.md
- Extension Capabilities:
- Overview: extensions/capabilities/README.md
- Common Capabilities: extensions/capabilities/common-capabilities.md
- Theming: extensions/capabilities/theming.md
- Extension Guides:
- Overview: extensions/guides/README.md
- Renderer Extension: extensions/guides/renderer-extension.md
- Testing and Publishing:
- Testing Extensions: extensions/testing-and-publishing/testing.md
- Publishing Extensions: extensions/testing-and-publishing/publishing.md
- Bundling Extensions: extensions/testing-and-publishing/bundling.md
- API Reference: extensions/api/README.md
- Contributing: contributing/README.md
- FAQ: faq/README.md
theme:
name: 'material'
highlightjs: true
@ -81,5 +83,8 @@ extra:
- icon: fontawesome/brands/slack
link: http://k8slens.slack.com/
name: Lens on Slack
- icon: fontawesome/solid/link
link: https://k8slens.dev/
name: Lens Website
version:
method: mike
method: mike