Skip to content
Snippets Groups Projects
Commit 3aa23054 authored by Taras Lazariv's avatar Taras Lazariv
Browse files

Merge branch 'issue-240-enhance-information-jupyterhub-nbpuller-URLencoding' into 'preview'

Recommend URL encoding instead plain text for jupyterhub link sharing

Closes #240

See merge request !501
parents eedb9230 453d4cd3
No related branches found
No related tags found
2 merge requests!530Automated merge from preview to main,!501Recommend URL encoding instead plain text for jupyterhub link sharing
......@@ -35,9 +35,20 @@ other material to your students.
![Git pull progress screen](misc/gitpull_progress.png)
{: align="center"}
A shareable link for this feature looks like this:
To create a shareable link, we recommend to use [URL encoding](https://en.wikipedia.org/wiki/Percent-encoding)
instead of plain text for the link in order to avoid defective links. The
[nbgitpuller link generator](https://jupyterhub.github.io/nbgitpuller/link?hub=https://taurus.hrsk.tu-dresden.de/jupyter/)
supports you in generating valid links for sharing.
<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>
??? example
A shareable link for this feature looks like this:
```
https://taurus.hrsk.tu-dresden.de/jupyter/hub/user-redirect/git-pull?repo=https%3A%2F%2Fgithub.com%2Fjdwittenauer%2Fipython-notebooks&urlpath=tree%2Fipython-notebooks%2Fnotebooks%2Flanguage%2FIntro.ipynb
```
!!! warning
For illustration purposes, we use plain text links in the following parts. In practice, we
highly recommend to use URL encoded links instead.
![URL with git-pull parameters](misc/url-git-pull.png)
{: align="center"}
......@@ -55,10 +66,6 @@ The following parameters are available:
|`urlpath` | URL to redirect the user to a certain file, [more info about parameter urlpath](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
## Spawn Options Pass-through with URL Parameters
The spawn form now offers a quick start mode by passing URL parameters.
......@@ -113,8 +120,7 @@ https://taurus.hrsk.tu-dresden.de/jupyter/hub/user-redirect/git-pull?repo=https:
With the following link you will be redirected to a certain file in your
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.
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment