Install tutorial name alignment Install document name changes and min…

…or content changes. Signed-off-by: mviitanen <[email protected]>
k0sproject · Mar 9, 2021 · 3bb24b7 · 3bb24b7
1 parent 513aef0
commit 3bb24b7
Show file tree

Hide file tree

Showing 5 changed files with 13 additions and 11 deletions.
diff --git a/docs/install.md b/docs/install.md
@@ -1,9 +1,11 @@
-# Quick Start Guide
+# Getting Started
 
  In this tutorial you'll create a full Kubernetes cluster with just one node including both the controller and the worker. This is well suited for environments where the high-availability and multiple nodes are not needed. This is the easiest install method to start experimenting k0s.
 
 ### Prerequisites
 
+This tutorial has been written for Debian/Ubuntu, but it can be used for any Linux running one of the supported init systems: Systemd or OpenRC.
+
 Before proceeding, make sure to review the [System Requirements](system-requirements.md).
 
 ### Installation steps
@@ -88,7 +90,7 @@ $ sudo k0s reset
 
 ### Next Steps
 
-- [Automated Cluster Setup](k0sctl-install.md) for deploying and upgrading multi-node clusters with k0sctl
+- [Installing with k0sctl](k0sctl-install.md) for deploying and upgrading multi-node clusters with one command
 - [Manual Install](k0s-multi-node.md) for advanced users for manually deploying multi-node clusters
 - [Control plane configuration options](configuration.md) for example for networking and datastore configuration
 - [Worker node configuration options](worker-node-config.md) for example for node labels and kubelet arguments

diff --git a/docs/k0s-in-docker.md b/docs/k0s-in-docker.md
@@ -4,7 +4,7 @@ In this tutorial you'll create a k0s cluster on top of docker. By default, both
 
 ### Prerequisites
 
-Docker environment on top of Mac, Windows or Linux. [Get Docker](https://docs.docker.com/get-docker/).
+Docker environment on Mac, Windows or Linux. [Get Docker](https://docs.docker.com/get-docker/).
 
 ### Container images
 
@@ -84,8 +84,7 @@ Currently, we cannot run k0s nodes if the containers are configured to use custo
 
 ### Next Steps
 
-- [Automated Cluster Setup](k0sctl-install.md) for deploying and upgrading multi-node clusters with k0sctl
-- [Manual Install](k0s-multi-node.md) for advanced users for manually deploying multi-node clusters
+- [Installing with k0sctl](k0sctl-install.md) for deploying and upgrading multi-node clusters with one command
 - [Control plane configuration options](configuration.md) for example for networking and datastore configuration
 - [Worker node configuration options](worker-node-config.md) for example for node labels and kubelet arguments
 - [Support for cloud providers](cloud-providers.md) for example for load balancer or storage configuration

diff --git a/docs/k0s-multi-node.md b/docs/k0s-multi-node.md
@@ -4,6 +4,8 @@ In this tutorial you'll create a multi-node cluster, which is locally managed in
 
 ### Prerequisites
 
+This tutorial has been written for Debian/Ubuntu, but it can be used for any Linux running one of the supported init systems: Systemd or OpenRC.
+
 Before proceeding, make sure to review the [System Requirements](system-requirements.md).
 
 To speed-up the usage of `k0s` command, you may want to enable [shell completion](shell-completion.md).
@@ -140,7 +142,7 @@ and paste it to LENS. Note that in the kubeconfig you need add your controller's
 
 ### Next Steps
 
-- [Automated Cluster Setup](k0sctl-install.md) for deploying and upgrading multi-node clusters with k0sctl
+- [Installing with k0sctl](k0sctl-install.md) for deploying and upgrading multi-node clusters with one command
 - [Control plane configuration options](configuration.md) for example for networking and datastore configuration
 - [Worker node configuration options](worker-node-config.md) for example for node labels and kubelet arguments
 - [Support for cloud providers](cloud-providers.md) for example for load balancer or storage configuration

diff --git a/docs/k0sctl-install.md b/docs/k0sctl-install.md
@@ -1,4 +1,4 @@
-# Automated Cluster Setup Using k0sctl
+# Installing with k0sctl
 
 This tutorial is based on k0sctl tool and it's targeted for creating a multi-node cluster for remote hosts. It describes an install method, which is automatic and easily repeatable. This is recommended for production clusters and the automatic upgrade requires using this install method. The automatic upgrade process is also described in this tutorial.
 
@@ -170,7 +170,6 @@ INFO[0027]      k0sctl kubeconfig
 
 ### Next Steps
 
-- [Manual Install](k0s-multi-node.md) for advanced users for manually deploying multi-node clusters
 - [Control plane configuration options](configuration.md) for example for networking and datastore configuration
 - [Worker node configuration options](worker-node-config.md) for example for node labels and kubelet arguments
 - [Support for cloud providers](cloud-providers.md) for example for load balancer or storage configuration

diff --git a/mkdocs.yml b/mkdocs.yml
@@ -11,10 +11,10 @@ edit_uri: ""
 nav:
   - Overview: README.md
   - Install:
-      - Quick Start Guide:                install.md
-      - Automated Cluster Setup:          k0sctl-install.md
-      - Manual Install:                   k0s-multi-node.md
+      - Getting Started:                  install.md
+      - Installing with k0sctl:           k0sctl-install.md
       - Alternative Install Methods:
+          - Manual Install:               k0s-multi-node.md
           - Docker:                       k0s-in-docker.md
           - Windows (experimental):       experimental-windows.md
   - Architecture: