-
Notifications
You must be signed in to change notification settings - Fork 41
Add jupyterlab docs #107
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add jupyterlab docs #107
Conversation
|
preview available: https://docs.tds.cscs.ch/107 |
msimberg
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is very nice, thanks @rsarm!
It looks like most of the content between the daint and eiger pages is identical or at least similar. Do you think it'd make sense to combine the two into one page (probably directly on the root jupyterlab page?), only highlighting the differences? You could use tabs like e.g. https://eth-cscs.github.io/cscs-docs/software/devtools/linaro-uenv/#install-and-configure-the-linaro-client-on-your-local-machine (source:
cscs-docs/docs/software/devtools/linaro-uenv.md
Lines 102 to 159 in 7723124
| === "Daint" | |
| !!! warning | |
| The `Remote Installation Directory` will change if you are using a different version of the `linaro-forge` uenv. | |
| Please use the appropriate version for your setup. | |
| | Field | Value | | |
| | ----------- | --------------------------------------- | | |
| | Connection | `daint` | | |
| | Host Name | `cscsusername@ela.cscs.ch cscsusername@daint.cscs.ch` | | |
| | Remote Installation Directory | `uenv run linaro-forge/24.1.2:/user-tools -- /user-tools/env/forge/` | | |
| | Private Key | `~/.ssh/cscs-key` | | |
| === "Santis" | |
| !!! warning | |
| The `Remote Installation Directory` will change if you are using a different version of the `linaro-forge` uenv. | |
| Please use the appropriate version for your setup. | |
| | Field | Value | | |
| | ----------- | --------------------------------------- | | |
| | Connection | `santis` | | |
| | Host Name | `cscsusername@ela.cscs.ch cscsusername@santis.cscs.ch` | | |
| | Remote Installation Directory | `uenv run linaro-forge/24.1.2:/user-tools -- /user-tools/env/forge/` | | |
| | Private Key | `~/.ssh/cscs-key` | | |
| === "Clariden" | |
| !!! warning | |
| The `Remote Installation Directory` will change if you are using a different version of the `linaro-forge` uenv. | |
| Please use the appropriate version for your setup. | |
| | Field | Value | | |
| | ----------- | --------------------------------------- | | |
| | Connection | `clariden` | | |
| | Host Name | `cscsusername@ela.cscs.ch cscsusername@clariden.cscs.ch` | | |
| | Remote Installation Directory | `uenv run linaro-forge/24.1.2:/user-tools -- /user-tools/env/forge/` | | |
| | Private Key | `~/.ssh/cscs-key` | | |
| === "Eiger" | |
| !!! warning | |
| The `Remote Installation Directory` will change if you are using a different version of the `linaro-forge` uenv. | |
| Please use the appropriate version for your setup. | |
| | Field | Value | | |
| | ----------- | --------------------------------------- | | |
| | Connection | `eiger` | | |
| | Host Name | `cscsusername@ela.cscs.ch cscsusername@eiger.cscs.ch` | | |
| | Remote Installation Directory | `uenv run linaro-forge/24.1.2:/user-tools -- /user-tools/env/forge/` | | |
| | Private Key | `~/.ssh/cscs-key` | |
Also, would you mind adding yourself to CODEOWNERS for these pages?
bcumming
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for the contribution!
A general comment is to check out the contributing guide:
https://eth-cscs.github.io/cscs-docs/contributing/
For example: https://eth-cscs.github.io/cscs-docs/contributing/#text-formatting
Also, because these docs will replace the KB docs when Eiger has been redeployed in the same style as Daint, we don't need to include docs for "old Eiger"
|
Thanks for the review @msimberg and @bcumming! I removed the docs for Eiger. I had the two separate versions because Eiger's deployment is going to be changed soon. I couldn't find how to set the Regarding code blocks: I didn't put the |
|
preview available: https://docs.tds.cscs.ch/107 |
|
preview available: https://docs.tds.cscs.ch/107 |
👍
Add your github username to this file: https://github.com/eth-cscs/cscs-docs/blob/main/.github/CODEOWNERS.
I think what you've done follows the guidelines just fine for exactly the reasons you described. Rule 0 is: they're just guidelines. |
| ## Access and setup | ||
|
|
||
| The JupyterHub service enables the interactive execution of JupyterLab on [Daint][ref-cluster-daint] on a single compute node. | ||
|
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Not a must, just thinking out loud: would it still make sense to add a !!! note saying something about jypyterhub on eiger?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
|
preview available: https://docs.tds.cscs.ch/107 |
Co-authored-by: Mikael Simberg <mikael.simberg@iki.fi>
|
preview available: https://docs.tds.cscs.ch/107 |
|
From my part this is ready. |
Co-authored-by: Mikael Simberg <mikael.simberg@iki.fi>
|
preview available: https://docs.tds.cscs.ch/107 |
No description provided.