From e0e8e88bd19a68f6c0895df9cfa89effed4187b2 Mon Sep 17 00:00:00 2001
From: Varac <varac@varac.net>
Date: Mon, 16 Aug 2021 20:57:28 +0200
Subject: [PATCH] Lint and restructure usage.rst
---
docs/usage.rst | 46 ++++++++++++++++++++--------------------------
1 file changed, 20 insertions(+), 26 deletions(-)
diff --git a/docs/usage.rst b/docs/usage.rst
index 4b010619e..b99e10620 100644
--- a/docs/usage.rst
+++ b/docs/usage.rst
@@ -1,45 +1,33 @@
Usage
=====
+OAS User panel
+--------------
+
After all the applications are installed, the first thing to do is log into
-https://admin.oas.example.org. This is the "user panel", a place where
-you can create, edit and delete users. You can log in with the user "admin". The
-password can be found by running
+`https://admin.oas.example.org <https://admin.oas.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.
+You can log in with the user "admin". The password can be found by running
.. code:: bash
python3 -m openappstack oas.example.org secrets
-Search for ``userbackend_admin_password``.
+Search for `userbackend_admin_password`.
After logging in, you will see an overview of all the installed applications
your user has access to. For more information on how to create users and give
-them access to applications, take a look at the [user panel
-documentation](https://docs.openappstack.net/projects/user-panel/en/latest/).
+them access to applications, take a look at the `user panel documentation
+<https://docs.openappstack.net/projects/user-panel/en/latest>`_.
.. note::
If you don't see applications, make sure you have installed at least one
optional application in :ref:`step-5` of the installation procedure.
-Core applications
------------------
-
-These applications are available after the installation is completed
-successfully:
-
-OAS User panel
-~~~~~~~~~~~~~~
-
-The `OAS user panel <https://open.greenhost.net/openappstack/user-panel/>`__
-can be used to create and edit users. These users can be used to log into the
-applications listed below.
-The user panel is available at https://admin.oas.example.org. You can login
-as `admin` using the `userbackend_admin_password` password from your secrets
-folder.
-
-After logging in to the user panel follow the [user panel documentation](https://docs.openappstack.net/projects/user-panel/en/latest/#creating-a-new-user)
-to create a new user.
+For creating users follow the `user creation documentation
+<https://docs.openappstack.net/projects/user-panel/en/latest/#creating-a-new-user>`_.
*Note*: The email address is important because some applications need a valid
email address for notification mails.
@@ -51,6 +39,12 @@ in the last step using single sign-on.
Links to all available apps are shown in the userpanel dashboard, which can
be used to access these apps without a need to bookmark all URLs.
+Core applications
+-----------------
+
+These applications are available after the installation is completed
+successfully:
+
Grafana
~~~~~~~
@@ -99,11 +93,11 @@ RocketChat
Wekan
~~~~~
-`Wekan https://wekan.github.io/`__ is a Kanban board application.
+`Wekan <https://wekan.github.io>`__ is a Kanban board application.
WordPress
~~~~~~~~~
`WordPress <https://wordpress.com>`__ is a website content management system.
-Click the `Log in` button and then click `Login with OpenID Connect` to use
+Click the **Log in** button and then click **Login with OpenID Connect** to use
single sign-on.
--
GitLab