diff --git a/book.toml b/book.toml
index 2bbfb89b3f902ea04029dfa5445432674e02249e..c43215367dd2910c54a9ddcd12956e657c67b0ef 100644
--- a/book.toml
+++ b/book.toml
@@ -1,5 +1,5 @@
[book]
-title = "RWTH JupyterHub Documentation"
+title = "RWTHjupyter User Documentation"
author = "Steffen Vogel"
description = "Documentation for students and instructors."
src = "src"
diff --git a/src/Access.md b/src/Access.md
index dbc7698bafa7dffae58716cb5cb0df0844c15c70..6f764c15cf90de8b1ced473280652050b81b7725 100644
--- a/src/Access.md
+++ b/src/Access.md
@@ -1,8 +1,8 @@
# Access
-The JupyterHub cluster is accessable world-wide over the internet via [jupyter.rwth-aachen.de](https://jupyter.rwth-aachen.de).
+_RWTHjupyter_ is accessable world-wide over the internet via [jupyter.rwth-aachen.de](https://jupyter.rwth-aachen.de).
-To be able to use the JupyterHub cluster a registration in our Identity Management with a TIM-ID is necessary.
+Access to _RWTHjupyter_ is granted via the universities Identity Management using a TIM-ID.
By default all employes and students are given access to the cluster without any additional registration.
The use of this cluster is limited to teaching related activities.
diff --git a/src/Contact.md b/src/Contact.md
index 0d6992396bcc11c617fe4278fbdb3059ecf893cb..39730bba3267bed441d1ed48e198a6cb85a2293c 100644
--- a/src/Contact.md
+++ b/src/Contact.md
@@ -1,7 +1,7 @@
# Support
-Support for the JupyterHub cluster is provided on a best-effort basis by an open Jupyter user-group.
-Please not that its not (yet) an official service provided by the RWTH IT Center.
+Support for _RWTHjupyter_ is provided on a best-effort basis by the RWTH Jupyter user-group.
+Please note that it is not yet provided as an official service by the RWTH IT Center.
You can contact the group via its mailing list: [jupyter@lists.rwth-aachen.de](mailto:jupyter@lists.rwth-aachen.de).
A subscription to this list is possible via the following link: https://lists.rwth-aachen.de/postorius/lists/jupyter.lists.rwth-aachen.de/
diff --git a/src/FAQ.md b/src/FAQ.md
index af15600bd7d4b795412f89df71f66e39f0f3e4a0..c8eab529501e6f96ef5d6d79615d88bd4bde95e8 100644
--- a/src/FAQ.md
+++ b/src/FAQ.md
@@ -1,6 +1,6 @@
-# Frequently Asked Questions
+# Frequently Asked Questions (FAQ)
-### Are there any resource quotas/limits enforced on singleuser containers on this JupyterHub instance?
+### Are there any resource quotas/limits enforced on singleuser containers on RWTHjupyter?
Yes, we currently provide each user container with a maximum of 64 GiB RAM, 32 CPU cores and a 4 GiB of persistent storage space for your home directory.
@@ -13,7 +13,7 @@ Please consult the [Terms of Use](TermsOfUse.md) for details.
This is only possible to a limited extend.
We encourage all instructors and professors to [apply for a customized profile for their course](instructors/PerperationNewCourses.md).
-Students who which to use the JupyterHub cluster outside of their courses, we recommend one of the [generic profiles](Profiles.md).
+Students who which to use _RWTHjupyter_ outside of their courses, we recommend one of the [generic kernel profiles](Profiles.md).
These generic profiles can by customized by installation additional packages via `pip` and `conda`.
By default, added packages are not persistent and only available until the next spawn of your Jupyter container.
You can work around this, by installing packages into your home directory:
@@ -53,7 +53,7 @@ https://jupyter.rwth-aachen.de/hub/spawn?profile=gdet3
https://jupyter.rwth-aachen.de/hub/spawn?profile=gdet3&next=/user-redirect/lab/tree/gdet3/GDET3%20Faltung%20GUI.ipynb
-### This is cool! How can I contribute or improve JupyterHub infrastructure?
+### This is cool! How can I contribute or improve RWTHjupyter?
We host most of our code, configuration and more on the [RWTH GitLab instance](https://git.rwth-aachen.de/jupyter/).
@@ -61,9 +61,9 @@ Please feel free to contribute by submitting merge requests.
We are also looking for HiWi's to support us in improving this service. Feel free to [get in touch with us](Contact.md).
-### Who is behind this JupyterHub infrastructure?
+### Who is behind RWTHjupyter?
-The RWTH JuptyerHub infrastructure was created in collaboration between the Institute for [Automation of Complex Power Systems (ACS)](https://acs.eonerc.rwth-aachen.de) and the [IT Center of RWTH Aachen University](https://itc.rwth-aachen.de).
+The _RWTHjupyter_ infrastructure was created in collaboration between the Institute for [Automation of Complex Power Systems (ACS)](https://acs.eonerc.rwth-aachen.de) and the [IT Center of RWTH Aachen University](https://itc.rwth-aachen.de).
### I've lost my changes to my notebooks. Changes to the courses Notebooks are not synchronized properly.
diff --git a/src/Profiles.md b/src/Profiles.md
index f0795f03b8535d2c84c53d66a2dde76a6d6e2f12..f148fad2b640be2a98fdab1cdce06a9475d41672 100644
--- a/src/Profiles.md
+++ b/src/Profiles.md
@@ -1,6 +1,6 @@
# Jupyter Profiles
-The RWTH Jupyter instance provides a variety of different profiles (run-time environments) for different Jupyter Kernels or lectures.
+The RWTHjupyter cluster provides a variety of different profiles (run-time environments) for different Jupyter kernels or lectures.
The following list is automatically updated by our continous integration system.
diff --git a/src/README.md b/src/README.md
index 52fa469a3f8a1a2fc44c2aeb16e6a81fcd2d959c..6032da68e0d383c63b0693dd189133641c713ad5 100644
--- a/src/README.md
+++ b/src/README.md
@@ -1,4 +1,4 @@
-# JupyterHub Cluster
+# RWTHjupyter
@@ -8,15 +8,15 @@
## Service Description
-With the JupyterHub cluster the IT Center provides in collaboration with the Institute for Automation of Complex systems all users with access to an interactive computing platform.
+With _RWTHjupyter_ the IT Center provides in collaboration with the Institute for Automation of Complex systems all users with access to an interactive computing platform.
## Costs
-The cluster has been funded by the Projekt _Digitale Lehr-/Lerninfrastrukturen DH NRW_ in 2019 and is thereby provided cost-free to all students and employees of the RWTH.
+The cluster has been initially funded by the Projekt _Digitale Lehr-/Lerninfrastrukturen DH NRW_ in 2019 and is thereby provided cost-free to all students and employees of the RWTH.
## Hardware
-The JupyterHub cluster consists of 7 Dell PowerEdge R740xd servers with the following configuration:
+The _RWTHjupyter_ cluster consists of 7 Dell PowerEdge R740xd servers with the following configuration:
7x Dell PowerEdge 740XD:
@@ -31,11 +31,11 @@ Additionally, 1 of the nodes is equipped with:
## Software Configuration
-The JupyterHub cluster runs on a [highly-available Kubernetes cluster](http://kubernetes.io) using the [Zero 2 JupyterHub](https://zero-to-jupyterhub.readthedocs.io/en/latest/) project.
+_RWTHjupyter_ runs on a [highly-available Kubernetes cluster](http://kubernetes.io) using the [Zero 2 JupyterHub](https://zero-to-jupyterhub.readthedocs.io/en/latest/) project.
## News
-### 2020-04-21: Go-live of JupyterHub pilot phase
+### 2020-04-21: Go-live of RWTHjupyter test phase
### 2020-02-28: Kick-off meeting of the RWTH Jupyter Working group
@@ -45,7 +45,7 @@ The JupyterHub cluster runs on a [highly-available Kubernetes cluster](http://ku
### 2019-10: The cluster has been specified and ordered
-### 2019-06 JupyterHub Proposal has been funded by the Project "[Digitale Lehr-/Lerninfrastrukturen DH NRW](https://www.dh.nrw/foerderung)"
+### 2019-06 The RWTHjupyter proposal has been funded by the Project "[Digitale Lehr-/Lerninfrastrukturen DH NRW](https://www.dh.nrw/foerderung)"
## Contact
diff --git a/src/TermsOfUse.md b/src/TermsOfUse.md
index 3690b0d4976d0d27c4854c0ab31af6f018845361..881529e2f0521d17ca1a5c886479ca51cb4ae839 100644
--- a/src/TermsOfUse.md
+++ b/src/TermsOfUse.md
@@ -1,31 +1,31 @@
# Terms of Use
-## § 1 Subject of the rules of use
+## §1 Subject of the rules of use
-The following rules of use describe the general conditions for the use of the pilot project "JupyterHub of RWTH Aachen University" for its higher education (especially teaching students). JupyterHub is a web-based interactive computational environment for creating Jupyter notebook documents.
+The following rules of use describe the general conditions for the use of the pilot project _RWTHjupyter_ for its higher education (especially teaching students). RWTHjupyter is a web-based interactive computational environment for creating Jupyter notebook documents.
-These rules are agreed upon for the use of the "JupyterHub" pilot project.
+These rules are agreed upon for the use of the _RWTHjupyter_ pilot project.
In the following, for a better understanding, the users are uniformly referred to as "users".
Users can be divided into two subgroups - "teachers" and "students".
-## § 2 Conditions of use
+## §2 Conditions of use
-1. The present rules refer exclusively to the use of the "JupyterHub".
-2. The use of the "JupyterHub" requires an enrollment or employment at the RWTH, the use of a browser and the use of a client software.
-3. The use of the "JupyterHub" is restricted to teaching related activities. This includes theses, student projects or autodidactic activities.
+1. The present rules refer exclusively to the use of the _RWTHjupyter_.
+2. The use of the _RWTHjupyter_ requires an enrollment or employment at the RWTH, the use of a browser and the use of a client software.
+3. The use of the _RWTHjupyter_ is restricted to teaching related activities. This includes theses, student projects or autodidactic activities.
-## § 3 Costs
+## §3 Costs
-Use of the "JupyterHub" is free of charge; there is no legal claim to registration and use.
+Use of the _RWTHjupyter_ is free of charge; there is no legal claim to registration and use.
-## § 4 Duties of care
+## §4 Duties of care
The user is obliged to treat his access data confidentially and to protect it from access by third parties. The user must therefore take all necessary measures to ensure the security and confidentiality of the access data and passwords generated by him. In case of possible misuse of his access data, the user must inform the RWTH immediately. He is also responsible for the consequences of such misuse.
-The user may not take any measures or use any software that could interfere with the functioning of the "JupyterHub" service or otherwise interfere with its availability.
+The user may not take any measures or use any software that could interfere with the functioning of the _RWTHjupyter_ service or otherwise interfere with its availability.
-In particular, the amount of data, the number of objects (number of files) and the number of simultaneous connections are subject to the specifications made previously or the standard parameters of the "JupyterHub".
+In particular, the amount of data, the number of objects (number of files) and the number of simultaneous connections are subject to the specifications made previously or the standard parameters of the _RWTHjupyter_.
Deviating uses of the provided software (e.g. the use of encryption technologies) are the sole responsibility of the user.
@@ -33,10 +33,10 @@ In case of violation by the user, the access authorization of the user will be b
Furthermore, the user must always observe and comply with the instructions given.
-## § 5 Rights and duties of the user
+## §5 Rights and duties of the user
-1. By using the "JupyterHub", the user grants the RWTH the right to store the data and work results he/she has stored in the "JupyterHub" and to view them under the following conditions.
-2. The data and work results stored by the user in the "JupyterHub" may be inspected by the RWTH JupyterHub admins, if
+1. By using the _RWTHjupyter_, the user grants the RWTH the right to store the data and work results he/she has stored in the _RWTHjupyter_ and to view them under the following conditions.
+2. The data and work results stored by the user in the _RWTHjupyter_ may be inspected by the RWTHjupyter admins, if
- the employment relationship between the user and the RWTH is terminated
- or the user is not available for more than 1 week to disclose the stored data and work results himself;
@@ -45,9 +45,9 @@ Furthermore, the user must always observe and comply with the instructions given
3. Rights of use and copyrights to the stored information remain unaffected.
4. Access to the cluster may be suspended due to excessive use, crypto miners or other types of misuse.
-## § 6 User Lifecycle
+## §6 User Lifecycle
-1. Users must log in to the JupyterHub cluster again at the latest 12 months after their last login. During this process a check is made to see whether the access conditions for using the service are still met.
+1. Users must log in to RWTHjupyter again at the latest 12 months after their last login. During this process a check is made to see whether the access conditions for using the service are still met.
2. If the access conditions (§2) after this period are not met, the access to the cluster will be disabled.
3. In case the last user activity was more than 12 months ago, the cluster access will be disabled and the user account will be deaktivated. The user will be notified via mail about a pending deletion of account 6 months after the deactivation.
4. In case the last user activity was more than 18 months ago, the user account will be finally deleted including all stored data. Shared folders are only deleted after all user accounts with access to the share have been expired.
@@ -56,7 +56,7 @@ Users who have their account deactivated due to unmet access conditions can cont
-## § 7 Liability
+## §7 Liability
The RWTH has unlimited liability in cases of intent or gross negligence, for injury to life, limb or health and according to the regulations of the Product Liability Act.
@@ -66,11 +66,11 @@ A further liability of the RWTH does not exist.
The aforementioned limitation of liability also applies to the personal liability of employees, representatives and organs of the RWTH.
-## § 8 Availability of the "JupyterHub" service
+## §8 Availability of the RWTHjupyter service
A permanent, trouble-free and/or unlimited availability of the service cannot be guaranteed or offered. Especially maintenance work or security aspects as well as force majeure and events beyond the control of the RWTH can lead to disturbances or a temporary suspension of the service.
-## § 9 Data protection
+## §9 Data protection
The collection, use and application of personal data is carried out in accordance with the relevant data protection regulations. In particular, no personal data is passed on to third parties without authorisation.
@@ -86,9 +86,9 @@ In addition, the following user identifiable information will be stored for a pe
- Time stamps of singleuser container spawns and terminations
- Timestamp of last user activity on the cluster
-All user data will be deleted after a total of 18 months of user inactivity (see § 6 User Lifecycle)
+All user data will be deleted after a total of 18 months of user inactivity (see §6 User Lifecycle)
-## § 10 Miscellaneous
+## §10 Miscellaneous
1. Changes and amendments to this contract must be made in writing. This also applies to the amendment or cancellation of this clause.
2. General terms and conditions of the user shall not apply.
diff --git a/src/usage/Links.md b/src/usage/Links.md
index 04aa980317b73682708494376c1d0005007b2391..95411cd2aab87dfe0a4c7b484c524dd05a9dfa18 100644
--- a/src/usage/Links.md
+++ b/src/usage/Links.md
@@ -1,6 +1,7 @@
-# Direct Links to Notebooks and Profiles
+# Launch Profiles and Notebooks via Links
-This page shows a few examples of permanent links for accessing certain profiles or Notebooks in the Jupyter cluster.
+This page shows a few examples of permanent links for accessing profiles or notebooks in the Jupyter cluster.
+They can be used for your README.md, Websites or Moodle.
## Link creation wizard