Merge branch 'documentation-fixes' into 'master'

Fix some mistakes/inregularities in installation instructions

See merge request openappstack/openappstack!515

docs/installation/create_cluster.rst

@@ -5,7 +5,7 @@ Create a kubernetes cluster
 ===========================
 
 This document describes how you can use OpenAppStack to install
-`k3s <https://k3s.io/>`_, a lightweight Kubernetes distribution on a virtual
+`k3s`_, a lightweight Kubernetes distribution on a virtual
 private server.
 
 For OpenAppStack we will set up a "single-node" kubernetes cluster. This means
@@ -123,13 +123,14 @@ OpenAppStack.
     $ python -m openappstack oas.example.org install
 
 
-This will take a few minutes. It installs `link <k3s_>`_, a lightweight
+This will take a few minutes. It installs `k3s`_, a lightweight
 Kubernetes and useful tools like `kubectl`_ (Kubernetes cli tool), `krew`_
 (a kubectl plugin manager), `flux`_ (used for automated updates) and `velero`_
 (Kubernetes resources and persistent volumes backup) on it.
 
 .. _kubectl: https://kubernetes.io/docs/reference/kubectl/overview
 .. _flux: https://fluxcd.io
+.. _k3s: https://k3s.io/
 .. _krew: https://krew.sigs.k8s.io
 .. _velero: https://velero.io
 

docs/installation/install_oas.rst

@@ -6,16 +6,16 @@ Install OpenAppStack
 
 This guide explains how to install OpenAppStack either on an existing Kubernetes
 cluster that you have setup entirely yourself, or on a cluster you created
-following the OpenAppStack :ref:`create_cluster` guide.
+following the OpenAppStack :ref:`create_kubernetes_cluster` guide.
 Please choose one of the below options:
 
 .. tab-set::
 
-    .. tab-item:: A. Install on cluster created by OpenAppStack cli
+    .. tab-item:: A. Install on cluster created with OpenAppStack cli
 
-        If you followed the :ref:`create_cluster` guide to setup a Kubernetes cluster
-        using the OpenAppStack CLI tool you're all set and can continue with the
-        next step (:ref:`flux_config`).
+        If you followed the :ref:`create_kubernetes_cluster` guide to setup a
+        Kubernetes cluster using the OpenAppStack CLI tool you're all set and
+        can continue by following the steps below.
 
     .. tab-item:: B. Install on existing cluster
 
@@ -36,11 +36,11 @@ Please choose one of the below options:
 
         - Create a directory containing your cluster configuration, i.e.
           ``mkdir -p clusters/oas.example.org``
-        - Copy your `kube_config.yml` file inside your cluster config directory and
-          rename it on the way to `` kube_config_cluster.yml``:
-          ``mv kube_config.yml clusters/oas.example.org/kube_config_cluster.yml``
+        - Copy your ``kube_config.yml`` file inside your cluster config directory
+          and rename it to ``kube_config_cluster.yml``:
+          ``cp kube_config.yml clusters/oas.example.org/kube_config_cluster.yml``
 
-        **Installation**: Please continue with the next step (:ref:`flux_config`).
+        Continue by following the steps below.
 
 .. _flux_config:
 
@@ -134,8 +134,9 @@ and configure the settings with the ``backup_s3_`` prefix.
 Then continue with the installation procedure as described below. At the end of
 the installation procedure, you have to install the ``velero`` application.
 
+.. _install_core_apps:
 
-Step 5: Install core applications
+Step 1: Install core applications
 =================================
 
 Before you can start, you need to execute a few commands from the installation
@@ -170,14 +171,14 @@ Next, run:
 
    ./install/install-openappstack.sh
 
-This installs the *core* of OpenAppStack into your ``k3s`` cluster. To see
-what's included, check the ``flux2/infrastructure`` and the ``flux2/core``
-folders.
+This installs the *core* of OpenAppStack into your cluster. To see what's
+included, check the ``flux2/infrastructure`` and the ``flux2/core`` folders in
+the `git repository <https://open.greenhost.net/openappstack/openappstack>`__.
 
-.. _additional_apps:
+.. _install_additional_apps:
 
-Install additional applications
-===============================
+Step 2: Install additional applications
+=======================================
 
 After the script completes, you can install applications by running the other
 installation scripts in the ``install`` folder. At the moment, we have scripts
@@ -198,16 +199,18 @@ updates). If all kustomizations have been applied correctly, you can monitor
 specific application releases by running ``watch flux get helmreleases
 --all-namespaces``.
 
-.. _step-6:
+.. _validate_setup:
 
-Step 6: Validate setup
+Step 3: Validate setup
 ======================
 
 Because OpenAppStack is still under development, we would like you to
 follow our `testing instructions <testing.html>`__ to make sure
 that the setup process went well.
 
-Step 7: Let us know!
+.. _let_us_know:
+
+Step 4: Let us know!
 ====================
 
 We would love to hear about your experience installing OpenAppStack.  If you

docs/installation/overview.rst

@@ -99,7 +99,7 @@ Installation options
 ====================
 
 1. If you want to create a Kubernetes cluster from scratch on a dedicated server
-   or virtual machine please start with :ref:`create_cluster` and
+   or virtual machine please start with :ref:`create_kubernetes_cluster` and
    then continue with :ref:`install_oas`.
 #. If you want to install Openappstack on an existing Kubernetes cluster you can
    skip the above instructions and start with :ref:`install_oas`.