From f8ae8cc53db29d7a53c293a8ffc70c2a44f6ba97 Mon Sep 17 00:00:00 2001 From: Jari Kolehmainen Date: Thu, 5 Nov 2020 17:30:49 +0200 Subject: [PATCH] Restructure docs menu (#1235) Signed-off-by: Jari Kolehmainen --- docs/clusters/settings.md | 10 +-- docs/contributing/README.md | 1 + docs/extensions/{overview.md => README.md} | 0 docs/extensions/api/README.md | 3 + .../capabilities/{overview.md => README.md} | 0 .../guides/{overview.md => README.md} | 0 docs/extensions/usage/README.md | 3 + docs/faq/README.md | 1 + .../{downloading-lens.md => README.md} | 19 ++---- docs/helm/README.md | 3 + mkdocs.yml | 61 ++++++++++--------- 11 files changed, 50 insertions(+), 51 deletions(-) create mode 100644 docs/contributing/README.md rename docs/extensions/{overview.md => README.md} (100%) create mode 100644 docs/extensions/api/README.md rename docs/extensions/capabilities/{overview.md => README.md} (100%) rename docs/extensions/guides/{overview.md => README.md} (100%) create mode 100644 docs/extensions/usage/README.md create mode 100644 docs/faq/README.md rename docs/getting-started/{downloading-lens.md => README.md} (86%) create mode 100644 docs/helm/README.md diff --git a/docs/clusters/settings.md b/docs/clusters/settings.md index 13371ad1e4..99d083c3f2 100644 --- a/docs/clusters/settings.md +++ b/docs/clusters/settings.md @@ -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. diff --git a/docs/contributing/README.md b/docs/contributing/README.md new file mode 100644 index 0000000000..a0990367ef --- /dev/null +++ b/docs/contributing/README.md @@ -0,0 +1 @@ +TBD diff --git a/docs/extensions/overview.md b/docs/extensions/README.md similarity index 100% rename from docs/extensions/overview.md rename to docs/extensions/README.md diff --git a/docs/extensions/api/README.md b/docs/extensions/api/README.md new file mode 100644 index 0000000000..e751aa7a19 --- /dev/null +++ b/docs/extensions/api/README.md @@ -0,0 +1,3 @@ +# Lens Extension API Reference + +TBD diff --git a/docs/extensions/capabilities/overview.md b/docs/extensions/capabilities/README.md similarity index 100% rename from docs/extensions/capabilities/overview.md rename to docs/extensions/capabilities/README.md diff --git a/docs/extensions/guides/overview.md b/docs/extensions/guides/README.md similarity index 100% rename from docs/extensions/guides/overview.md rename to docs/extensions/guides/README.md diff --git a/docs/extensions/usage/README.md b/docs/extensions/usage/README.md new file mode 100644 index 0000000000..7ca1ab7e51 --- /dev/null +++ b/docs/extensions/usage/README.md @@ -0,0 +1,3 @@ +# Using Extensions + +TBD diff --git a/docs/faq/README.md b/docs/faq/README.md new file mode 100644 index 0000000000..a0990367ef --- /dev/null +++ b/docs/faq/README.md @@ -0,0 +1 @@ +TBD diff --git a/docs/getting-started/downloading-lens.md b/docs/getting-started/README.md similarity index 86% rename from docs/getting-started/downloading-lens.md rename to docs/getting-started/README.md index 2493edc5f6..e4c6c38bec 100644 --- a/docs/getting-started/downloading-lens.md +++ b/docs/getting-started/README.md @@ -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). \ No newline at end of file diff --git a/docs/helm/README.md b/docs/helm/README.md new file mode 100644 index 0000000000..c6ea505cc3 --- /dev/null +++ b/docs/helm/README.md @@ -0,0 +1,3 @@ +# Using Helm Charts + +TBD diff --git a/mkdocs.yml b/mkdocs.yml index 07d6cfe7a7..96218f318d 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -8,33 +8,35 @@ repo_url: https://github.com/lensapp/lens copyright: Copyright © 2020 Mirantis Inc. - 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 \ No newline at end of file + method: mike