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

Document how to connect via ssh #501

Merged
merged 11 commits into from
Aug 21, 2024
Merged

Document how to connect via ssh #501

merged 11 commits into from
Aug 21, 2024

Conversation

kcpevey
Copy link
Contributor

@kcpevey kcpevey commented Aug 9, 2024

This PR documents how to connect to nebari via ssh and sftp.

Reference Issues or PRs

Resolves #377

What does this implement/fix?

Put a x in the boxes that apply

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds a feature)
  • Breaking change (fix or feature that would cause existing features not to work as expected)
  • Documentation Update
  • Code style update (formatting, renaming)
  • Refactoring (no functional changes, no API changes)
  • Build related changes
  • Other (please describe):

Testing

  • Did you test the pull request locally?
  • Did you add new tests?

Documentation

Access-centered content checklist

Text styling

  • The content is written with plain language (where relevant).
  • If there are headers, they use the proper header tags (with only one level-one header: H1 or # in markdown).
  • All links describe where they link to (for example, check the Nebari website).
  • This content adheres to the Nebari style guides.

Non-text content

  • All content is represented as text (for example, images need alt text, and videos need captions or descriptive transcripts).
  • If there are emojis, there are not more than three in a row.
  • Don't use flashing GIFs or videos.
  • If the content were to be read as plain text, it still makes sense, and no information is missing.

Any other comments?

Copy link

netlify bot commented Aug 9, 2024

Deploy Preview for nebari-docs ready!

Name Link
🔨 Latest commit 5544084
🔍 Latest deploy log https://app.netlify.com/sites/nebari-docs/deploys/66c63ef1ffe2400008d7692b
😎 Deploy Preview https://deploy-preview-501--nebari-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@kcpevey kcpevey requested a review from Adam-D-Lewis August 9, 2024 14:44
@kcpevey kcpevey added the needs: review 👀 This PR is complete and ready for reviewing label Aug 9, 2024
docs/docs/how-tos/connect-via-ssh.mdx Outdated Show resolved Hide resolved
docs/docs/how-tos/connect-via-ssh.mdx Outdated Show resolved Hide resolved
docs/docs/how-tos/connect-via-ssh.mdx Outdated Show resolved Hide resolved
docs/docs/how-tos/connect-via-ssh.mdx Outdated Show resolved Hide resolved
@viniciusdc
Copy link
Contributor

viniciusdc commented Aug 20, 2024

It looks great! And many thanks for adding these details to the documentation 🚀
My main point of feedback is the distinction between Nebari SSH and JupyterHub SSH, as they serve different purposes. Since Nebari consists of several services, some might interpret SSH-ing into Nebari as directly connecting to the cluster (nodes or pods), which is a distinction worth clarifying from what jupyterhub-ssh does

@kcpevey
Copy link
Contributor Author

kcpevey commented Aug 21, 2024

My main point of feedback is the distinction between Nebari SSH and JupyterHub SSH, as they serve different purposes. Since Nebari consists of several services, some might interpret SSH-ing into Nebari as directly connecting to the cluster (nodes or pods), which is a distinction worth clarifying from what jupyterhub-ssh does

That is an excellent point, and I didn't appreciate the difference until you pointed it out. Thanks!

kcpevey and others added 3 commits August 21, 2024 10:19
Co-authored-by: Vinicius D. Cerutti <51954708+viniciusdc@users.noreply.github.com>
Copy link
Contributor

@viniciusdc viniciusdc left a comment

Choose a reason for hiding this comment

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

Looking great! Those are my final suggestions, let me know what do you thing @kcpevey

docs/docs/how-tos/connect-via-ssh.mdx Show resolved Hide resolved
docs/docs/how-tos/connect-via-ssh.mdx Outdated Show resolved Hide resolved
docs/docs/how-tos/connect-via-ssh.mdx Outdated Show resolved Hide resolved
docs/docs/how-tos/connect-via-ssh.mdx Outdated Show resolved Hide resolved
docs/docs/how-tos/connect-via-ssh.mdx Outdated Show resolved Hide resolved
docs/docs/how-tos/connect-via-ssh.mdx Show resolved Hide resolved
kcpevey and others added 2 commits August 21, 2024 13:29
Co-authored-by: Vinicius D. Cerutti <51954708+viniciusdc@users.noreply.github.com>
Copy link
Contributor

@viniciusdc viniciusdc left a comment

Choose a reason for hiding this comment

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

Wonderful 🚀

@viniciusdc viniciusdc merged commit e111f3c into main Aug 21, 2024
6 checks passed
@viniciusdc viniciusdc deleted the juputer_ssh_instructions branch August 21, 2024 19:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: documentation 📖 needs: review 👀 This PR is complete and ready for reviewing
Projects
Status: Done 💪🏾
Development

Successfully merging this pull request may close these issues.

[DOC] - Add how-to connect using jupyterhub-ssh
3 participants