docs: Update documentation (#281)

bihealth · Aug 9, 2024 · db3725e · db3725e
1 parent d787ca7
commit db3725e
Show file tree

Hide file tree

Showing 21 changed files with 41 additions and 203 deletions.
diff --git a/docs/adminsec.rst b/docs/adminsec.rst
@@ -1,6 +1,6 @@
-.. _adminsec:
+.. _admins:
 
-Admin
-=====
+Admin Manual
+============
 
 TBD
diff --git a/docs/conf.py b/docs/conf.py
@@ -7,8 +7,8 @@
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
 
 project = "HPC Access Manual"
-copyright = "2023, Berlin Institute of Health"
-author = "Oliver Stolpe"
+copyright = "2024, Berlin Institute of Health"
+author = "Oliver Stolpe, Thomas Sell"
 
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
@@ -23,4 +23,4 @@
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
 
 html_theme = "sphinx_rtd_theme"
-html_static_path = ["_static"]
+#html_static_path = ["_static"]
diff --git a/docs/howto.rst b/docs/howto.rst
diff --git a/docs/index.rst b/docs/index.rst
@@ -6,26 +6,18 @@
 HPC Access Manual
 =================
 
-HPC Access is a user access management system, developed for, but not limited to, the `BIH HPC Cluster <http://hpc.bihealth.org/>`_,
-facilitating the access managament for the principal investigators and the members of their group as well as the administrators of the cluster.
+HPC Access is a user access management system, developed for the `BIH HPC Cluster <http://hpc.bihealth.org/>`.
+It provides users with an overview of the data they have access to and informs them about quota usage.
+Principal investigators and group delegates can use HPC access to make resource requests to the administrators of the cluster.
 
 .. toctree::
    :maxdepth: 2
-   :caption: Users
+   :caption: User Manual
 
-   usersec_login
-   usersec_pis
    usersec_users
 
 .. toctree::
    :maxdepth: 2
-   :caption: Admins
+   :caption: Admin Manual
 
    adminsec
-
-Indices and tables
-==================
-
-* :ref:`genindex`
-* :ref:`modindex`
-* :ref:`search`
diff --git a/docs/make.bat b/docs/make.bat
diff --git a/docs/pycharm/configuration.rst b/docs/pycharm/configuration.rst
diff --git a/docs/pycharm/images/1.png b/docs/pycharm/images/1.png
diff --git a/docs/pycharm/images/2.png b/docs/pycharm/images/2.png
diff --git a/docs/pycharm/images/3.png b/docs/pycharm/images/3.png
diff --git a/docs/pycharm/images/4.png b/docs/pycharm/images/4.png
diff --git a/docs/pycharm/images/7.png b/docs/pycharm/images/7.png
diff --git a/docs/pycharm/images/8.png b/docs/pycharm/images/8.png
diff --git a/docs/pycharm/images/f1.png b/docs/pycharm/images/f1.png
diff --git a/docs/pycharm/images/f2.png b/docs/pycharm/images/f2.png
diff --git a/docs/pycharm/images/f3.png b/docs/pycharm/images/f3.png
diff --git a/docs/pycharm/images/f4.png b/docs/pycharm/images/f4.png
diff --git a/docs/pycharm/images/issue1.png b/docs/pycharm/images/issue1.png
diff --git a/docs/pycharm/images/issue2.png b/docs/pycharm/images/issue2.png
diff --git a/docs/users.rst b/docs/users.rst
diff --git a/docs/usersec_users.rst b/docs/usersec_users.rst
@@ -1,28 +1,31 @@
 .. _users:
 
-Users
-=====
-
-The user view is only for informational purposes for the user and serves as the plattform to accept invitations.
-The user cannot make any request or change any attribute.
-It consists of three tiles.
-
-Account information
--------------------
-
-1. The first tile contains all the information about the user.
-2. The second tile contains the information about the group you are part of.
-3. The third tile lists all the projects you are assigned to.
-
-Accept a group invitation
--------------------------
-
-When you do not have a cluster account and your PI has invited you to his group, you receive an invitation per mail once the HPC administrators have confirmed the request.
-To accept the invitation, log in to the application with your Charite or MDC credentials and a consent page will show up.
-After your confirmation, your account will be created and you are accepted to the group.
-
-Accept a project invitation
----------------------------
-
-When you have been invited to a project, it will be listed in the right-hand tile in the projects list.
-Before becoming a member of the project, you have to accept the invitation.
+Login & Account Overview
+========================
+
+Login
+-----
+
+When visiting HPC for the first time, you will be greeted by a login screen.
+Please use your Charité or MDC credentials to log in.
+If your cluster account was already created, the main user overview will be shown after login.
+It consists of two tiles: **Working Group** and **Projects**.
+
+Working group
+-------------
+Here you can see information about your main working group.
+Right next to the group's name your user status is shown.
+This is either `Member`, `Delegate`, or `Owner`.
+Below are some general facts about the group such as the group leader, delegate, and a list of members.
+Storage quotas and quota utilisation of the group workspace are shown as three-coloured bars.
+
+Projects
+--------
+This section lists all projects you are assigned to.
+After clicking to expand, each project displays information about its owner, delegate, and expiry date.
+Storage quotas and quota utilisation of the assigned data locations are shown as three-coloured bars.
+
+User Info
+---------
+By clicking the *User Info* button at the top of the page you can display more information about your user.
+You will see the location of your home directory as well as it's quota utilisation.
diff --git a/requirements/base.txt b/requirements/base.txt
@@ -26,3 +26,4 @@ ldap3==2.9.1
 
 # Documentation
 sphinx
+sphinx-rtd-theme
Original file line number	Diff line number	Diff line change
Expand Up		@@ -26,3 +26,4 @@ ldap3==2.9.1

		# Documentation
		sphinx
		sphinx-rtd-theme