opening-sessions: custom jupyter image requirements #168
Conversation
| - have Jupyter installed | ||
| - expose port `8888` | ||
| - use the `HTTPS` protocol | ||
| - provide the [`start-notebook.sh`](https://github.com/jupyter/docker-stacks/blob/main/base-notebook/start-notebook.sh) script |
There was a problem hiding this comment.
I'm not sure whether it is better to mention this script and then recommend below to use an image based on one of the official Jupyter images, or to directly say that, as a requisite, the custom image should be based upon an official Jupyter one. What do you think?
There was a problem hiding this comment.
I would go for the latter, i.e. speak of official Jupyter based image, and only then perhaps mention in parentheses that this means listening on port XXXX and having start notebook script.
giuseppe-steduto
force-pushed
the
jupyter-custom-image
branch
from
cb941b3
to
01247f2
Compare
giuseppe-steduto
force-pushed
the
jupyter-custom-image
branch
from
01247f2
to
0d9adb5
Compare
| @@ -25,6 +25,19 @@ https://reana.cern.ch/f8be55e4-5d18-43f9-b977-f773fdcab163?token=<your-reana-tok | |||
| It could take several minutes to start the interactive session. | |||
| ``` | |||
|
|
|||
| !!! note | |||
There was a problem hiding this comment.
Instead of using !!! note I would simply promote this information into the main text, and reformat its flow by reordering paragraphs:
- start with the leading paragraph ("you can open...")
- continue with the paragraph showing that clicking on the printed link would open a notebook ("By clicking on the link..."
- only now display the information about started environment ("by default, newly opened...")
- ... and continue smoothly saying how people can customise it:
If you would like to open another custom notebook image, please note that it has to follow Jupyter image conventions (port 8000, start-notebook) etc etc etc.
(BTW I would also promote the other note "Keep in mind..." into the main text. The notes are visually rather highlighted from the main text, and simple phrases like that are more a normal continuation of the main text... It's not necessary to
highligtht them separately?)
| - have Jupyter installed | ||
| - expose port `8888` | ||
| - use the `HTTPS` protocol | ||
| - provide the [`start-notebook.sh`](https://github.com/jupyter/docker-stacks/blob/main/base-notebook/start-notebook.sh) script |
There was a problem hiding this comment.
I would go for the latter, i.e. speak of official Jupyter based image, and only then perhaps mention in parentheses that this means listening on port XXXX and having start notebook script.
giuseppe-steduto
force-pushed
the
jupyter-custom-image
branch
2 times, most recently
from
b23ca5a
to
6febb46
Compare
giuseppe-steduto
force-pushed
the
jupyter-custom-image
branch
from
6febb46
to
aacaeb4
Compare
|
|
||
| {.screenshot-browser-mockup} | ||
|
|
||
| Keep in mind that starting the notebook might take a minute, if you see "Service unavailable", just wait and retry. |
There was a problem hiding this comment.
After seeing the updated version, I would delete the "Keep in mind" phrase, because it disturbs the reading flow. We are already warning about this in the console output shown above, so it should not be necessary to add it also here!
| {.screenshot-browser-mockup} | ||
|
|
||
| Keep in mind that starting the notebook might take a minute, if you see "Service unavailable", just wait and retry. | ||
|
|
||
| !!! warning |
There was a problem hiding this comment.
The Warning box also disrupts the reading flow. I would do put it at the end of the CLI chapter, i.e. right before the "Open from web interface" section. And I would add "Please note that it will be automatically closed after 7 days of inactivity" to the last example (using custom image) as well. WDYT?
giuseppe-steduto
force-pushed
the
jupyter-custom-image
branch
from
aacaeb4
to
ee6d48a
Compare
Closes #163