From 5a4fda56e7dc883157c8922076590982dfd091eb Mon Sep 17 00:00:00 2001
From: Arie Peterson <arie@greenhost.nl>
Date: Wed, 19 Jan 2022 09:31:28 +0000
Subject: [PATCH] Apply suggestions from review
---
docs/installation/_install_on_a_vps.rst | 4 ++--
docs/installation/_install_on_existing_cluster.rst | 6 +++---
docs/installation/_manual_install.rst | 2 +-
docs/installation/_use_greenhost_api.rst | 2 +-
docs/installation/create_cluster.rst | 2 +-
stackspin/__main__.py | 2 +-
6 files changed, 9 insertions(+), 9 deletions(-)
diff --git a/docs/installation/_install_on_a_vps.rst b/docs/installation/_install_on_a_vps.rst
index 623c8e7fb..44d6fddae 100644
--- a/docs/installation/_install_on_a_vps.rst
+++ b/docs/installation/_install_on_a_vps.rst
@@ -4,7 +4,7 @@ the tab *"ADVANCED: Use the Greenhost API"* to learn how to automatically create
VPSs and DNS records and install Stackspin on them.
This document describes how you can use Stackspin's CLI to install
-`k3s`_, a lightweight Kubernetes distribution on a virtual
+`k3s`_, a lightweight Kubernetes distribution, on a virtual
private server.
For Stackspin we will set up a "single-node" kubernetes cluster. This means
@@ -41,7 +41,7 @@ can do this by making sure ``ping`` shows your VPS's IP address:
64 bytes from 1.2.3.4 (1.2.3.4): icmp_seq=2 ttl=62 time=52.5 ms
...
-If you've never logged into this machine before, you might need to accept the
+If you've never logged in to this machine before, you might need to accept the
SSH hostkey before you can start the installation process. To be sure, log into
your VPS once before you continue:
diff --git a/docs/installation/_install_on_existing_cluster.rst b/docs/installation/_install_on_existing_cluster.rst
index 8cc477a88..34f09f27d 100644
--- a/docs/installation/_install_on_existing_cluster.rst
+++ b/docs/installation/_install_on_existing_cluster.rst
@@ -3,10 +3,10 @@ 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
+ - Installation on an existing Kubernetes cluster is still experimental and
might not work depending on the setup of your cluster/cloud provider.
- We'll be happy to recieve feedback from your experiences though altough
- we cannot guarrente !
+ We'll be happy to receive feedback from your experiences though although
+ we cannot make guarantees!
**Prerequisites**
diff --git a/docs/installation/_manual_install.rst b/docs/installation/_manual_install.rst
index 261cb4052..dafce1f53 100644
--- a/docs/installation/_manual_install.rst
+++ b/docs/installation/_manual_install.rst
@@ -41,7 +41,7 @@ following command:
--ip-address 1.2.3.4
This configures your cluster under the fully qualified domain name (FQDN)
-``stackspin.example.org``, To break down the command:
+``stackspin.example.org``. To break down the command:
- the first, positional argument ``stackspin.example.org`` tells the cluster the domain
it will be hosted on. This should be a (subdomain of a) domain you own.
diff --git a/docs/installation/_use_greenhost_api.rst b/docs/installation/_use_greenhost_api.rst
index 2ba2699fb..241761f2d 100644
--- a/docs/installation/_use_greenhost_api.rst
+++ b/docs/installation/_use_greenhost_api.rst
@@ -77,7 +77,7 @@ Let's break down the arguments:
you do this, you can skip *Step 2: DNS Configuration*. The following records
are automatically created:
- - An ``A`` record ``stackspin.example.org`` pointing to the VPSs IP address
+ - An ``A`` record ``stackspin.example.org`` pointing to the VPS's IP address
- A ``CNAME`` record ``*.stackspin.example.org`` pointing to ``stackspin.example.org``.
- ``--subdomain stackspin``: Only needed when you use ``--create-domain-records`` so
diff --git a/docs/installation/create_cluster.rst b/docs/installation/create_cluster.rst
index a62bd9b6e..0c9dac516 100644
--- a/docs/installation/create_cluster.rst
+++ b/docs/installation/create_cluster.rst
@@ -18,5 +18,5 @@ most tested solution.
.. include:: _install_on_existing_cluster.rst
-Now that you have a Kuberetes cluster running you can continue to
+Now that you have a Kubernetes cluster running you can continue to
:ref:`install_stackspin`.
diff --git a/stackspin/__main__.py b/stackspin/__main__.py
index 272623b2a..ac89e9de0 100755
--- a/stackspin/__main__.py
+++ b/stackspin/__main__.py
@@ -260,7 +260,7 @@ def secrets(clus, args):
def admin_credentials(clus, args):
"""
- Dumps admin username and password and then exists
+ Dumps admin username and password and then exits.
:param cluster.Cluster clus: cluster to show information about
"""
--
GitLab