From 20f5c4f4e0a50204a1bf20757d172e0a227fea8a Mon Sep 17 00:00:00 2001
From: Martin Schroschk <martin.schroschk@tu-dresden.de>
Date: Tue, 7 Sep 2021 15:39:17 +0200
Subject: [PATCH] Add graphics
---
.../docs/access/jupyterhub_for_teaching.md | 169 ++++++++----------
.../docs/access/misc}/url-git-pull.png | Bin
.../docs/access/misc}/url-quick-start.png | Bin
.../docs/access/misc}/url-user-redirect.png | Bin
4 files changed, 76 insertions(+), 93 deletions(-)
rename {Compendium_attachments/JupyterHubForTeaching => doc.zih.tu-dresden.de/docs/access/misc}/url-git-pull.png (100%)
rename {Compendium_attachments/JupyterHubForTeaching => doc.zih.tu-dresden.de/docs/access/misc}/url-quick-start.png (100%)
rename {Compendium_attachments/JupyterHubForTeaching => doc.zih.tu-dresden.de/docs/access/misc}/url-user-redirect.png (100%)
diff --git a/doc.zih.tu-dresden.de/docs/access/jupyterhub_for_teaching.md b/doc.zih.tu-dresden.de/docs/access/jupyterhub_for_teaching.md
index 784d52f40..7f21a044e 100644
--- a/doc.zih.tu-dresden.de/docs/access/jupyterhub_for_teaching.md
+++ b/doc.zih.tu-dresden.de/docs/access/jupyterhub_for_teaching.md
@@ -3,110 +3,100 @@
On this page we want to introduce to you some useful features if you
want to use JupyterHub for teaching.
-<span style="color:red">**PLEASE UNDERSTAND:** </span> JupyterHub uses compute resources
-from the HPC system Taurus. Please be aware of the following notes:
-
-- The HPC system operates at a lower availability level than your
-usual Enterprise Cloud VM. There can always be downtimes, e.g. of
-the file systems or the batch system.
-- Scheduled downtimes are announced by email. Please plan your courses
-accordingly.
-- Access to HPC resources is handled through projects. See your course
-as a project. Projects need to be registered beforehand (more info
-on the page [Access](./../application/access.md)).
+!!! note
+
+ JupyterHub uses compute resources from ZIH systems.
+
+Please be aware of the following notes:
+
+- ZIH HPC systems operate at a lower availability level than your usual Enterprise Cloud VM. There
+ can always be downtimes, e.g. of the filesystems or the batch system.
+- Scheduled downtimes are announced by email. Please plan your courses accordingly.
+- Access to HPC resources is handled through projects. See your course as a project. Projects need
+ to be registered beforehand (more info on the page [Access](./../application/access.md)).
- Don't forget to **TODO ANCHOR**(add your
-users)(ProjectManagement#manage_project_members_40dis_45_47enable_41)
-(eg. students or tutors) to your project.
+users)(ProjectManagement#manage_project_members_40dis_45_47enable_41) (eg. students or tutors) to
+your project.
- It might be a good idea to **TODO ANCHOR**(request a
- reservation)(Slurm#Reservations) of part of the compute resources
- for your project/course to avoid unnecessary waiting times in the
- batch system queue.
+ reservation)(Slurm#Reservations) of part of the compute resources for your project/course to
+ avoid unnecessary waiting times in the batch system queue.
-## Clone a repository with a link
+## Clone a Repository With a Link
This feature bases on
-[nbgitpuller](https://github.com/jupyterhub/nbgitpuller) (
-[documentation](https://jupyterhub.github.io/nbgitpuller/))
+[nbgitpuller](https://github.com/jupyterhub/nbgitpuller).
+Documentation can be found at
+[this page](https://jupyterhub.github.io/nbgitpuller/).
-This extension for jupyter notebooks can clone every public git
-repository into the users work directory. It's offering a quick way to
-distribute notebooks and other material to your students.
+This extension for Jupyter notebooks can clone every public git repository into the users work
+directory. It's offering a quick way to distribute notebooks and other material to your students.
-**TODO ADD IMAGE** \<a href="%ATTACHURL%/gitpull_progress.png">\<img alt="Git pull progress
-screen" width="475"
-src="<https://doc.zih.tu-dresden.de/hpc-wiki/pub/Compendium/JupyterHubForTeaching/gitpull_progress.png>"
-style="border: 1px solid #888;" title="Git pull progress screen"/>\</a>
+
+{: align="center"}
-A sharable link for this feature looks like this:
+A shareable link for this feature looks like this:
<https://taurus.hrsk.tu-dresden.de/jupyter/hub/user-redirect/git-pull?repo=https://github.com/jdwittenauer/ipython-notebooks&urlpath=/tree/ipython-notebooks/notebooks/language/Intro.ipynb>
-**TODO ADD IMAGE**\<a href="%ATTACHURL%/url-git-pull.png?t=1604588695">\<img alt="URL with
-git-pull parameters" width="100%" style="max-width: 2717px"
-src="<https://doc.zih.tu-dresden.de/hpc-wiki/pub/Compendium/JupyterHubForTeaching/url-git-pull.png?t=1604588695>"
-style="border: 1px solid #888;" title="URL with git-pull
-parameters"/>\</a>
+
+{: align="center"}
This example would clone the repository
-[https://github.com/jdwittenauer/ipython-notebooks](
- https://github.com/jdwittenauer/ipython-notebooks)
+[https://github.com/jdwittenauer/ipython-notebooks](https://github.com/jdwittenauer/ipython-notebooks)
and afterwards open the **Intro.ipynb** notebook in the given path.
The following parameters are available:
-|parameter | info |
+| Parameter | Info |
|---|---|
-|repo|path to git repository|
-|branch|branch in the repository to pull from default: `master`|
-|urlpath|URL to redirect the user to a certain file [more info](https://jupyterhub.github.io/nbgitpuller/topic/url-options.html#urlpath)|
-|depth|clone only a certain amount of latest commits not recommended|
+|`repo` | path to git repository|
+|`branch` | branch in the repository to pull from default: `master`|
+|`urlpath` | URL to redirect the user to a certain file [more info](https://jupyterhub.github.io/nbgitpuller/topic/url-options.html#urlpath)|
+|`depth` | clone only a certain amount of latest commits not recommended|
This [link
generator](https://jupyterhub.github.io/nbgitpuller/link?hub=https://taurus.hrsk.tu-dresden.de/jupyter/)
might help creating those links
-## Spawner options passthrough with URL params
+## Spawner Options Passthrough with URL Parameters
-The spawn form now offers a quick start mode by passing url
-parameters.
-An example: The following link would create a jupyter notebook session
-on the `interactive` partition with the `test` environment being loaded:
+The spawn form now offers a quick start mode by passing URL parameters.
-```
-https://taurus.hrsk.tu-dresden.de/jupyter/hub/spawn#/~(partition~'interactive~environment~'test)
-```
+!!! example
+
+ The following link would create a jupyter notebook session on the `interactive` partition with the `test`
+ environment being loaded:
-**TODO ADD IMG** \<a href="%ATTACHURL%/url-quick-start.png?t=1604586059">\<img alt="URL
-with quickstart parameters" width="100%" style="max-width: 800px"
-src="<https://doc.zih.tu-dresden.de/hpc-wiki/pub/Compendium/JupyterHubForTeaching/url-quick-start.png?t=1604586059>"
-style="border: 1px solid #888;" title="URL with quickstart
-parameters"/>\</a>
+ ```
+ https://taurus.hrsk.tu-dresden.de/jupyter/hub/spawn#/~(partition~'interactive~environment~'test)
+ ```
-Every parameter of the advanced form can
-be set with this parameter. If the parameter is not mentioned, the
-default value will be loaded.
+
+{: align="center"}
-| parameter | default value |
+Every parameter of the advanced form can be set with this parameter. If the parameter is not
+mentioned, the default value will be loaded.
+
+| Parameter | Default Value |
|:----------------|:-----------------------------------------|
-| partition | default |
-| nodes | 1 |
-| ntasks | 1 |
-| cpuspertask | 1 |
-| gres | *empty* (no generic resources) |
-| mempercpu | 1000 |
-| runtime | 8:00:00 |
-| reservation | *empty* (use no reservation) |
-| project | *empty* (use default project) |
-| modules | *empty* (do not load additional modules) |
-| environment | production |
-| launch | JupyterLab |
-| workspace_scope | *empty* (home directory) |
-
-You can use the advanced form to generate a url for the settings you
-want. The address bar contains the encoded parameters starting with
-`#/`.
-
-### Combination of quickstart and git-pull feature
+| `partition` | default |
+| `nodes` | 1 |
+| `ntasks` | 1 |
+| `cpuspertask` | 1 |
+| `gres` | *empty* (no generic resources) |
+| `mempercpu` | 1000 |
+| `runtime` | 8:00:00 |
+| `reservation` | *empty* (use no reservation) |
+| `project` | *empty* (use default project) |
+| `modules` | *empty* (do not load additional modules) |
+| `environment` | production |
+| `launch` | JupyterLab |
+| `workspace_scope` | *empty* (home directory) |
+
+You can use the advanced form to generate a URL for the settings you want. The address bar contains
+the encoded parameters starting with `#/`.
+
+### Combination of Quickstart and Git-Pull Feature
You can combine both features in a single link:
@@ -114,28 +104,21 @@ You can combine both features in a single link:
https://taurus.hrsk.tu-dresden.de/jupyter/hub/user-redirect/git-pull?repo=https://github.com/jdwittenauer/ipython-notebooks&urlpath=/tree/ipython-notebooks/notebooks/language/Intro.ipynb#/~(partition~'interactive~environment~'test)
```
-**TODO ADD IMAGE**\<a
-href="%ATTACHURL%/url-git-pull-and-quick-start.png?t=1604588695">\<img
-alt="URL with git-pull and quickstart parameters" width="100%"
-style="max-width: 3332px"
-src="<https://doc.zih.tu-dresden.de/hpc-wiki/pub/Compendium/JupyterHubForTeaching/url-git-pull-and-quick-start.png?t=1604588695>"
-style="border: 1px solid #888;" title="URL with git-pull and quickstart
-parameters"/>\</a>
+
+{: align="center"}
-## Open a notebook automatically with a single link
+## Open a Notebook Automatically with a Single Link
With the following link you will be redirected to a certain file in your
-home directory. The file needs to exist, otherwise a 404 error will be
-thrown.
+home directory.
+
+[https://taurus.hrsk.tu-dresden.de/jupyter/user-redirect/notebooks/demo.ipynb]
+(https://taurus.hrsk.tu-dresden.de/jupyter/user-redirect/notebooks/demo.ipynb)
-[https://taurus.hrsk.tu-dresden.de/jupyter/user-redirect/notebooks/demo.ipynb](https://taurus.hrsk.tu-dresden.de/jupyter/user-redirect/notebooks/demo.ipynb)
+The file needs to exist, otherwise a 404 error will be thrown.
-**TODO ADD IMAGE** \<a href="%ATTACHURL%/url-user-redirect.png">\<img alt="URL with
-git-pull and quickstart parameters" width="100%" style="max-width:
-700px"
-src="<https://doc.zih.tu-dresden.de/hpc-wiki/pub/Compendium/JupyterHubForTeaching/url-user-redirect.png?t=1604587961>"
-style="border: 1px solid #888;" title="URL with git-pull and quickstart
-parameters"/>\</a>
+
+{: align="center"}
This link would redirect to
-`https://taurus.hrsk.tu-dresden.de/jupyter/user/{login}/notebooks/demo.ipynb` .
+`https://taurus.hrsk.tu-dresden.de/jupyter/user/{login}/notebooks/demo.ipynb`.
diff --git a/Compendium_attachments/JupyterHubForTeaching/url-git-pull.png b/doc.zih.tu-dresden.de/docs/access/misc/url-git-pull.png
similarity index 100%
rename from Compendium_attachments/JupyterHubForTeaching/url-git-pull.png
rename to doc.zih.tu-dresden.de/docs/access/misc/url-git-pull.png
diff --git a/Compendium_attachments/JupyterHubForTeaching/url-quick-start.png b/doc.zih.tu-dresden.de/docs/access/misc/url-quick-start.png
similarity index 100%
rename from Compendium_attachments/JupyterHubForTeaching/url-quick-start.png
rename to doc.zih.tu-dresden.de/docs/access/misc/url-quick-start.png
diff --git a/Compendium_attachments/JupyterHubForTeaching/url-user-redirect.png b/doc.zih.tu-dresden.de/docs/access/misc/url-user-redirect.png
similarity index 100%
rename from Compendium_attachments/JupyterHubForTeaching/url-user-redirect.png
rename to doc.zih.tu-dresden.de/docs/access/misc/url-user-redirect.png
--
GitLab