diff --git a/docs/comparable_projects.md b/docs/comparable_projects.md index 81f9cf551e5abc28409c8c83161e074ae8714198..55c8bb13297c70393ffbd23b1a2edfd313568054 100644 --- a/docs/comparable_projects.md +++ b/docs/comparable_projects.md @@ -32,7 +32,7 @@ applications or more than five users. All mentioned platforms require applications running on it to be changed in some way, for example to make use of the authentication system. Stackspin tries to steer clear of changing the applications it includes. As long as they support -OpenID Connect, so you can sign into it, we can usually run the application +OpenID Connect, so you can sign in to it, we can usually run the application as-is. In most cases, Stackspin will only need one intervention before an update can be pushed to users: it needs to be tested. We want to make sure that an application works together with the platform and other applications before we diff --git a/docs/installation/_install_on_a_vps.rst b/docs/installation/_install_on_a_vps.rst index 44d6fddaecc796493657f094d017817abf44e3ca..46a74f6bad9e95c84fcaecfe8c8f4413f46d7b01 100644 --- a/docs/installation/_install_on_a_vps.rst +++ b/docs/installation/_install_on_a_vps.rst @@ -42,7 +42,7 @@ can do this by making sure ``ping`` shows your VPS's IP address: ... 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 +SSH hostkey before you can start the installation process. To be sure, log in to your VPS once before you continue: .. code:: bash diff --git a/docs/installation/_install_on_existing_cluster.rst b/docs/installation/_install_on_existing_cluster.rst index 34f09f27d9d7c590d76368423159c06cd52b0b94..80a91b9f28c804bd1a48edc220334b3fb51d8fbd 100644 --- a/docs/installation/_install_on_existing_cluster.rst +++ b/docs/installation/_install_on_existing_cluster.rst @@ -2,11 +2,12 @@ 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 is still experimental and - might not work depending on the setup of your cluster/cloud provider. - We'll be happy to receive feedback from your experiences though although - we cannot make guarantees! +.. note:: + + - Installation on an existing Kubernetes cluster is still experimental and + might not work depending on the setup of your cluster/cloud provider. + We are happy to receive feedback from your experiences but at the moment we + cannot make any guarantees! **Prerequisites** diff --git a/docs/installation/_use_greenhost_api.rst b/docs/installation/_use_greenhost_api.rst index 241761f2df63931a140d7372c41a0bbb14e3bbd2..199dcc1d6203f229d8762b00309ac229b7bb1920 100644 --- a/docs/installation/_use_greenhost_api.rst +++ b/docs/installation/_use_greenhost_api.rst @@ -80,7 +80,11 @@ Let's break down the arguments: - 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 - the Greenhost API can find your domain. Instead of using positional argument - ``stackspin.example.org`` you need to provide. If you want to host Stackspin - on a root domain, you can omit the ``subdomain`` argument. +- ``--subdomain stackspin``: Only needed when you use + ``--create-domain-records`` so the Greenhost API can find your domain. If you + use the ``--subdomain`` argument, the positional argument **must not** include + the subdomain (i.e., in the example command the positional argument is + ``example.org`` and not ``subdomain.example.org``). + + If you want to host Stackspin on a root domain, you can omit the ``subdomain`` + argument. diff --git a/docs/upgrading.rst b/docs/upgrading.rst index e446057722b70c27e4467a9529a9942fa734fff2..f2739498a83e06496d6af1b205f65ab3dadaae08 100644 --- a/docs/upgrading.rst +++ b/docs/upgrading.rst @@ -17,7 +17,7 @@ you get started!** .. code:: bash - # Log into your Stackspin server + # Log in to your Stackspin server ssh <server> # Download our upgrade script wget https://open.greenhost.net/stackspin/stackspin/-/raw/main/upgrade-scripts/to-0.8.0/rename-to-stackspin.sh @@ -83,7 +83,7 @@ to uniquely identify users. You can choose from these options: -1. Manually re-upload and re-share your files after logging into your new user +1. Manually re-upload and re-share your files after logging in to your new user for the first time. 2. It is possible to transfer files from your previous user to the new user. To do so, find your new username. It is visible in Settings -> Sharing behind diff --git a/docs/usage.rst b/docs/usage.rst index 2c72761e7651a1e6d9909fda655c464a358bb7ab..3072842db4fcbe96deb82b328a9ce2816ef2eb6c 100644 --- a/docs/usage.rst +++ b/docs/usage.rst @@ -4,10 +4,10 @@ Usage Stackspin User panel -------------------- -After all the applications are installed, the first thing to do is log into +After all the applications are installed, the first thing to do is log in to `https://admin.stackspin.example.org <https://admin.stackspin.example.org>`__. This is the "user panel" , a place where you can create, edit and delete users. -These users can be used to log into the applications listed below. +These users can be used to log in to the applications listed below. You can log in with the user "admin". The password can be found by running .. code:: bash @@ -150,9 +150,9 @@ Known issues '''''''''''' If you want admin privileges inside WordPress, you need to set this in the -Dashboard. Then, you need to log into WordPress again. +Dashboard. Then, you need to log in to WordPress again. -If this is your first time logging into WordPress, you have to log out and in +If this is your first time logging in to WordPress, you have to log out and in again for your admin privileges to be applied. For more information and technical details, refer to `the issue in our issue