Skip to content
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

Update ssh setup guide #64

Merged
merged 2 commits into from
Jul 16, 2024
Merged

Update ssh setup guide #64

merged 2 commits into from
Jul 16, 2024

Conversation

niksirbi
Copy link
Member

Description

What is this PR

  • Bug fix
  • Addition of a new feature
  • Other

Why is this PR needed?
See issue #61.

What does this PR do?

Closes #61 by introducing the following changes:

  • Delete section on remote ssh via VSCode, because of Docs currently suggest to use VSCode in the bastion node #62
  • Add a warning about doing tasks on the bastion and gateway nodes (with an example of how to use interactive jobs for quick tasks).
  • Add a note about managed desktop computers (because their ssh setup is much simpler, or even unnecessary).
  • Update the flowchart to distinguish between unmanaged vs managed machines.

This PR does not provide an updated "Remote development via VSCode" section, as I plan to write a new standalone how-to guide specifically on this task, based on the discussion in #62.

How to review

It's best to locally build and render the website, as the guide contains many interactive elements (from sphinx-design and myst-markdown):

git clone https://github.com/neuroinformatics-unit/HowTo.git
cd HowTo

# First time only
pip install -r docs/requirements.txt
sphinx-build docs/source docs/build

# Every time you want to update the local build
rm -rf docs/build && sphinx-build docs/source docs/build

# To view website, open docs/buid/index.html

@niksirbi niksirbi marked this pull request as ready for review July 15, 2024 16:58
@niksirbi niksirbi requested a review from lauraporta July 15, 2024 16:58
Copy link
Member

@lauraporta lauraporta left a comment

Choose a reason for hiding this comment

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

Content looks good to me 👍 Also renders well on Chrome locally

@lauraporta lauraporta merged commit 8597c6f into main Jul 16, 2024
3 checks 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.

Updates to ssh howto guide
2 participants