Skip to content

Adding setup.md material#50

Open
iliomar wants to merge 6 commits intohsf-training:gh-pagesfrom
iliomar:setup-update
Open

Adding setup.md material#50
iliomar wants to merge 6 commits intohsf-training:gh-pagesfrom
iliomar:setup-update

Conversation

@iliomar
Copy link
Copy Markdown

@iliomar iliomar commented Nov 7, 2025

Summary

This PR updates the setup.md page to provide a clearer and more accessible SSH setup workflow for new users.

Key Improvements

  • Added a complete SSH practice environment using GitHub Codespaces (recommended by the training organizers).
  • Added Practice Locally section with macOS, Linux, and Windows instructions.

Please let me know if you’d like any further adjustments or refinements!

@welcome
Copy link
Copy Markdown

welcome Bot commented Nov 7, 2025

Thanks for opening your first pull request here 🚀! If you have any questions, feel free to mention one of the conveners, previous contributors, or attend our weekly meeting (see
our homepage). Also, sometimes PRs go unnoticed, so don't hesitate to @mention some of us, if we do not come back to you within a few days.

Copy link
Copy Markdown
Member

@michmx michmx left a comment

Choose a reason for hiding this comment

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

Thanks @iliomar ! It is a nice starting point. I just have comments about the flow that students must follow. We have to be explicit on what to do / what not to do (for example, if Lxplus is available they don't need to use Codespaces).

Comment thread setup.md
ssh-keygen -t ed25519 -C "your_email@example.com"
````

If `ed25519` is not available:
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Add a note on why it may not be available (like an old OS or OpenSSH version)

Comment thread setup.md

---

# 4. Using SSH Inside GitHub Codespaces (Highly Recommended)
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Call this one "Option 2". Also, notice that @ariostas added a proper Codespaces setup, and SSH work out of the box
#48

Please refer to this one instead.

Comment thread setup.md

---

# 3. Test an SSH Connection (General Form)
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Call this one "Option 1", if the student has access to a remote server like Lxplus, NAF, etc.

Comment thread setup.md

---

# 6. (Optional) Connecting to CERN or Fermilab
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Saying "Optional" contradicts the "Test an SSH Connection" part above. This would be "Option 1" for those with access to CERN, LPC, NAF @ DESY, etc.

Comment thread setup.md

---

# 2. How SSH Works
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

These are nice diagrams, but I would say they dont fit in the Setup but rather in the Introduction. Also, a bit more of context for students following async is needed.

@michmx
Copy link
Copy Markdown
Member

michmx commented Jan 5, 2026

Hi @iliomar . A reminder of the comments left in this PR

@iliomar
Copy link
Copy Markdown
Author

iliomar commented Feb 5, 2026

Hi @michmx , sorry for the delay, I missed this message. Will work on that ASAP. Thanks, and again sorry.

@michmx michmx requested a review from qdcampagna February 10, 2026 22:40
@stale
Copy link
Copy Markdown

stale Bot commented Apr 11, 2026

This issue or pull request has been automatically marked as stale because it has not had recent activity. Please manually close it, if it is no longer relevant, or ask for help or support to help getting it unstuck. Let me bring this to the attention of @amorenobr @vlukashenko @richa2710 @michmx for now.

@stale stale Bot added the stale label Apr 11, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants