From 63c3088b6f5436bdaf7d554cad5b3bb2d7d0f6c8 Mon Sep 17 00:00:00 2001
From: Maarten de Waard <maarten@greenhost.nl>
Date: Fri, 14 Jan 2022 11:27:53 +0100
Subject: [PATCH] fix some mistakes, add a precursor to "existing cluster"
installation option
---
docs/index.rst | 10 +++++-----
docs/installation/_install_on_existing_cluster.rst | 7 ++++++-
docs/installation/install_cli.rst | 8 +-------
3 files changed, 12 insertions(+), 13 deletions(-)
diff --git a/docs/index.rst b/docs/index.rst
index fa8f3ea26..a6c9c7c17 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -4,12 +4,12 @@
contain the root `toctree` directive.
Welcome to Stackspin's documentation!
-========================================
+=====================================
-Stackspin (Stackspin) is a platform that will offer self-managed, click-and-play
-provisioning of online applications for Civil Society Organisations (CSOs).
-Users will be able to easily set up a self-hosted instance of Stackspin, so
-they can keep control over the data that gets entered into these applications.
+Stackspin is a platform that offers self-managed, click-and-play
+provisioning of online applications for Civil Society Organisations (CSOs).
+Users will be able to easily set up a self-hosted instance of Stackspin, so
+they can keep control over the data that gets entered into these applications.
Stackspin is:
diff --git a/docs/installation/_install_on_existing_cluster.rst b/docs/installation/_install_on_existing_cluster.rst
index 74461986c..8cc477a88 100644
--- a/docs/installation/_install_on_existing_cluster.rst
+++ b/docs/installation/_install_on_existing_cluster.rst
@@ -1,3 +1,7 @@
+Below, we describe how you can install Stackspin on an existing Kubernetes
+cluster. This process can be followed if you have a "managed Kubernetes"
+setup, or if you want to use a Kubernetes version other than K3s.
+
.. Note::
- Installation on an existing Kubernetes cluster ist still experiental and
might not work depending on the setup of your cluster/cloud provider.
@@ -6,7 +10,8 @@
**Prerequisites**
-- A single-node Kubernetes cluster
+- A single-node Kubernetes cluster (multi-node support has not been tested by
+ the Stackspin team)
- A ``kube_config.yml`` file for API access
**Configure DNS**
diff --git a/docs/installation/install_cli.rst b/docs/installation/install_cli.rst
index 4cb34dfb6..6278611d2 100644
--- a/docs/installation/install_cli.rst
+++ b/docs/installation/install_cli.rst
@@ -15,9 +15,6 @@ Installation overview
please do not use a server that functions as anything other than a
testing ground.
-Setup
-=====
-
This page will guide you through the installation of the "Stackspin CLI". The
CLI can be used to set up Stackspin on a different machine that is connected to
the internet. It also functions as a starting point for running tests.
@@ -25,7 +22,7 @@ the internet. It also functions as a starting point for running tests.
Common prerequisites
--------------------
-Wether you want to create a kubernetes cluster first or want to install
+Whether you want to create a Kubernetes cluster first or want to install
Stackspin on an existing cluster, these are the common prerequisites:
- You need Python 3 with its development files, Pip and Git installed
@@ -101,8 +98,5 @@ directory of the git repository. In this tutorial, we're using
$ python -m stackspin stackspin.example.org --help
-Kubernetes Cluster
-==================
-
The next chapter, :ref:`create_kubernetes_cluster`, will explain setting up
and/or configuring a Kubernetes cluster to install Stackspin on.
--
GitLab