From d951d4b295e49c9beb52c73d8a96f25de7c6e8b1 Mon Sep 17 00:00:00 2001
From: Varac <varac@varac.net>
Date: Mon, 16 Aug 2021 17:23:15 +0200
Subject: [PATCH] Remove instructions from page titles
---
docs/index.rst | 4 ++--
...allation_instructions.rst => installation.rst} | 6 +++---
docs/{testing_instructions.md => testing.md} | 2 +-
docs/upgrading.rst | 15 +++++++--------
4 files changed, 13 insertions(+), 14 deletions(-)
rename docs/{installation_instructions.rst => installation.rst} (98%)
rename docs/{testing_instructions.md => testing.md} (97%)
diff --git a/docs/index.rst b/docs/index.rst
index 3176794a3..a02f291f7 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -26,9 +26,9 @@ For more information, go to `the OpenAppStack website`_.
:maxdepth: 2
:caption: Contents:
- installation_instructions
+ installation
advanced_installation
- testing_instructions
+ testing
usage
maintenance
troubleshooting
diff --git a/docs/installation_instructions.rst b/docs/installation.rst
similarity index 98%
rename from docs/installation_instructions.rst
rename to docs/installation.rst
index e7ee49b26..ee5dfd795 100644
--- a/docs/installation_instructions.rst
+++ b/docs/installation.rst
@@ -1,5 +1,5 @@
-OpenAppStack installation instructions
-======================================
+Installation
+============
This document describes how you can install OpenAppStack on a VPS. The
installation process will set up a "Kubernetes cluster" which runs
@@ -392,7 +392,7 @@ Step 6: Validate setup
~~~~~~~~~~~~~~~~~~~~~~
Because OpenAppStack is still under development, we would like you to
-follow our `testing instructions <testing_instructions.html>`__ to make sure
+follow our `testing instructions <testing.html>`__ to make sure
that the setup process went well.
Step 7: Let us know!
diff --git a/docs/testing_instructions.md b/docs/testing.md
similarity index 97%
rename from docs/testing_instructions.md
rename to docs/testing.md
index 698ad6de7..59572761f 100644
--- a/docs/testing_instructions.md
+++ b/docs/testing.md
@@ -14,7 +14,7 @@ name.
## Installation
First we'd like you to setup an OpenAppStack cluster by yourself, following the
-[installation tutorial](https://docs.openappstack.net/en/latest/installation_instructions.html).
+[installation instructions](https://docs.openappstack.net/en/latest/installation.html).
## Command line tests
diff --git a/docs/upgrading.rst b/docs/upgrading.rst
index 26d2da8c0..587339f2a 100644
--- a/docs/upgrading.rst
+++ b/docs/upgrading.rst
@@ -24,7 +24,7 @@ The yq needed here can be installed by running ``sudo snap install yq``,
instructions](http://mikefarah.github.io/yq/#install).
-To back-up your secrets, run the following script:
+To back-up your secrets, run the following script:
.. code:: bash
@@ -45,7 +45,7 @@ To back-up your secrets, run the following script:
kubectl get secret -o yaml -n flux-system oas-nextcloud-variables > secrets-backup/oas-nextcloud-variables.yaml
This script assumes you have all applications enabled. You might get an error
-like:
+like:
.. code:: bash
@@ -57,7 +57,7 @@ lines under "data:", rename the field to ``wekan_oauth_client_secret`` and enter
a different random password. Make sure to base64 encode it (``echo "<your random
password>" | base64``).
-If you get the error several times, that means ther
+If you get the error several times, that means ther
This script creates a directory called ``secrets-backup`` and places the secrets
that have been generated by Helm in it as ``yaml`` files.
@@ -69,7 +69,7 @@ Flux will now start updating your cluster to version 0.7. This process will fail
because it will remove the secrets that you just backed up. Make
sure that the ``oas-secrets`` helmrelease has been removed by running ``flux get
hr -A``. You might also see that some helmreleases start failing to be installed
-because important secrets do not exist anymore.
+because important secrets do not exist anymore.
As soon as the ``oas-secrets`` helmrelease does not exist anymore, you can run
the following code:
@@ -119,7 +119,7 @@ secrets. The secrets will get a value once the ``core`` *kustomization* is
reconciled: ``flux reconcile ks core`` should solve the problem.
If that does not solve the problem, you should check if the secret contains a
-value for all the apps:
+value for all the apps:
.. code::
@@ -158,8 +158,8 @@ A few things are important when upgrading to 0.6.0:
- We now use Flux 2 and the installation procedure has been overhauled. For this
reason we advice you to set up a completely new cluster.
- Copy your configuration details from ``settings.yaml`` to a new ``.flux.env``.
- See ``install/.flux.env.example`` and the :ref:`OpenAppStack installation
- instructions` for more information.
+ See ``install/.flux.env.example`` and the :ref:`Installation`
+ instructions for more information.
Please `reach out to us`_ if you are using, or plan to use OAS in
production.
@@ -271,4 +271,3 @@ intervention.
.. _reach out to us: https://openappstack.net/contact.html
.. _Flux: https://fluxcd.io
-
--
GitLab