Skip to content

Conversation

@rsarm
Copy link
Collaborator

@rsarm rsarm commented May 5, 2025

No description provided.

@rsarm rsarm requested review from RMeli, bcumming and msimberg as code owners May 5, 2025 12:31
@github-actions
Copy link

github-actions bot commented May 5, 2025

preview available: https://docs.tds.cscs.ch/107

Copy link
Collaborator

@msimberg msimberg left a 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:

=== "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?

Copy link
Member

@bcumming bcumming left a 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"

@rsarm
Copy link
Collaborator Author

rsarm commented May 9, 2025

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 CODEOWNERS. Could you point to an example?

Regarding code blocks: I didn't put the $ prompt on the shell commands to make simpler copying and pasting it to a terminal. Also, for single-line commands such as ln -s $SCRATCH $HOME/scratch or pip install ipcmagic-cscs I didn't put a title, since they are clear. Is that ok? I don't mind adding the titles and the prompt. Just wanted to ask first.

@github-actions
Copy link

github-actions bot commented May 9, 2025

preview available: https://docs.tds.cscs.ch/107

@github-actions
Copy link

github-actions bot commented May 9, 2025

preview available: https://docs.tds.cscs.ch/107

@msimberg
Copy link
Collaborator

msimberg commented May 9, 2025

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 CODEOWNERS. Could you point to an example?

Add your github username to this file: https://github.com/eth-cscs/cscs-docs/blob/main/.github/CODEOWNERS.

Regarding code blocks: I didn't put the $ prompt on the shell commands to make simpler copying and pasting it to a terminal. Also, for single-line commands such as ln -s $SCRATCH $HOME/scratch or pip install ipcmagic-cscs I didn't put a title, since they are clear. Is that ok? I don't mind adding the titles and the prompt. Just wanted to ask first.

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.

Copy link
Collaborator

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?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank @msimberg
I added my username there

I will ask Tim and check with @bcumming about Eiger.

@github-actions
Copy link

github-actions bot commented May 9, 2025

preview available: https://docs.tds.cscs.ch/107

Co-authored-by: Mikael Simberg <mikael.simberg@iki.fi>
@github-actions
Copy link

preview available: https://docs.tds.cscs.ch/107

@rsarm
Copy link
Collaborator Author

rsarm commented May 21, 2025

From my part this is ready.

Co-authored-by: Mikael Simberg <mikael.simberg@iki.fi>
@github-actions
Copy link

preview available: https://docs.tds.cscs.ch/107

@bcumming bcumming self-requested a review May 21, 2025 14:15
@bcumming bcumming merged commit c9e374a into eth-cscs:main May 21, 2025
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants