-
Bug
-
Resolution: Done
-
Normal
-
RHODS_1.1_GA
-
None
-
5
-
False
-
False
-
doc-ack
-
N/A
-
-
-
-
-
-
No
-
No
-
Skip
-
None
-
Comments from Erwan Granger:
- Consider changing "Importing an existing notebook file..." to "Uploading an existing notebook file..." to better match user vocab
- In the warning about running out of storage space, add some additional clarification:
"To avoid this issue, Red Hat recommends streaming (rather than downloading) larger data sets from external services where possible. Alternatively, you can proactively request more storage from your administrator when you plan to work with a very large data set, to ensure you have sufficient space. Administrators can see <link to section> for instructions on how to do this." - In "Installing Python packages on your notebook server"
- Update the note with something similar to:
"You can also install packages directly, but Red Hat recommends using a requirements.txt file so that the same packages can be easily reused across different notebooks, and even potentially if you end up using a Source2Image build in order to deploy a model." - Recommend the practice of specifying exact package versions to ensure stability over time, as new package versions can introduce undesirable changes in behavior.
- Update the note with something similar to:
- In "My notebook server does not start", add "Check the event log for any relevant messages to share with your administrator, for example:
Server requested
2021-10-28T13:31:29.830991Z [Warning] 0/7 nodes are available: 2 Insufficient memory, 2 node(s) had taint {node-role.kubernetes.io/infra: }, that the pod didn't tolerate, 3 node(s) had taint {node-role.kubernetes.io/master: }, that the pod didn't tolerate." - Consider adjusting order of sections to the following:
- Working with notebooks
- Creating and importing notebooks
- Collaborating on notebooks using Git
- Troubleshooting common problems in JupyterHub
This will depend on the general approach to document construction (frequency of user versus order of operations, etc.)