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

Incorrect windows syntax & instructions fixed #30855

Merged
merged 2 commits into from
Jan 5, 2024
Merged

Conversation

Vortun
Copy link
Contributor

@Vortun Vortun commented Dec 29, 2023

Some of the syntax was incorrect in the instructions regarding the path to your ssh key on windows (/ used instead of , no : after drive label)

Also corrected an error where the guide suggested to use CMD instead of PowerShell for commands that only work in PowerShell.

Why: Some of the information regarding SSH connection was incorrect on Windows.

Closes:

What's being changed (if available, include any code snippets, screenshots, or gifs): Frontslashes changed to backslashes, colon added after drive name, reference to CMD removed in section with PowerShell unique commands.

Check off the following:

  • I have reviewed my changes in staging, available via the View deployment link in this PR's timeline.

    • For content changes, you will also see an automatically generated comment with links directly to pages you've modified. The comment won't appear if your PR only edits files in the data directory.
  • For content changes, I have completed the self-review checklist.

Some of the syntax was incorrect in the instructions regarding the path to your ssh key on windows (/ used instead of \, no : after drive label)

Also corrected an error where the guide suggested to use CMD instead of PowerShell for commands that only work in PowerShell.
Copy link

welcome bot commented Dec 29, 2023

Thanks for opening this pull request! A GitHub docs team member should be by to give feedback soon. In the meantime, please check out the contributing guidelines.

@github-actions github-actions bot added the triage Do not begin working on this issue until triaged by the team label Dec 29, 2023
Copy link
Contributor

github-actions bot commented Dec 29, 2023

Automatically generated comment ℹ️

This comment is automatically generated and will be overwritten every time changes are committed to this branch.

The table contains an overview of files in the content directory that have been changed in this pull request. It's provided to make it easy to review your changes on the staging site. Please note that changes to the data directory will not show up in this table.


Content directory changes

You may find it useful to copy this table into the pull request summary. There you can edit it to share links to important articles or changes and to give a high-level overview of how the changes in your pull request support the overall goals of the pull request.

Source Preview Production What Changed
authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent.md fpt
ghec
ghes@ 3.11 3.10 3.9 3.8 3.7
ghae
fpt
ghec
ghes@ 3.11 3.10 3.9 3.8 3.7
ghae

fpt: Free, Pro, Team
ghec: GitHub Enterprise Cloud
ghes: GitHub Enterprise Server
ghae: GitHub AE

@nguyenalex836
Copy link
Contributor

@Vortun Thanks so much for opening a PR! I'll get this triaged for review ✨

@nguyenalex836 nguyenalex836 added content This issue or pull request belongs to the Docs Content team waiting for review Issue/PR is waiting for a writer's review ssh Content related to SSH authentication Content relating to authentication and removed triage Do not begin working on this issue until triaged by the team labels Dec 29, 2023
@guntrip
Copy link
Contributor

guntrip commented Jan 4, 2024

Hey @Vortun! Thanks for opening this ✨ I just tested this on my own Windows machine and the prompt was a mind-bending combination of both slashes 😅

Enter file in which to save the key (C:\Users\YOU/.ssh/id_ed25519):

Did you test this yourself and see /c:\Users\YOU\.ssh\id_ALGORITHM? I know Powershell supports both / and \ in paths and it would be great to verify what this actually is.

I'm curious about the first / too in your path too. Is that a typo or was that returned too?

Your other change, removing the mention of command prompt, looks great. Once we've figured this out, I'll approve and we can get this merged!

Fixed a couple leftover frontslashes from previous commit.
@Vortun
Copy link
Contributor Author

Vortun commented Jan 4, 2024

You're absolutely correct @stevecat! I missed removing the slash before C: (fixed in a new commit), however I can't reproduce this random combination of slashes you're seeing? It displays only backslashes on both my windows and ubuntu machine.

Screenshot for reference:
Screenshot from 2024-01-04 15-35-37

Copy link
Contributor

@guntrip guntrip 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 fixing that, @Vortun! ✨

Looking around, I think my Powershell is just spectacularly misconfigured, it looks like the format you're seeing is standard.

I'll get this merged now! Thanks again for contributing to our docs! 🎉 ✨

@guntrip guntrip added the ready to merge This pull request is ready to merge label Jan 5, 2024
@guntrip guntrip added this pull request to the merge queue Jan 5, 2024
Merged via the queue into github:main with commit 4c0d5f1 Jan 5, 2024
50 checks passed
Copy link
Contributor

github-actions bot commented Jan 5, 2024

Thanks very much for contributing! Your pull request has been merged 🎉 You should see your changes appear on the site in approximately 24 hours. If you're looking for your next contribution, check out our help wanted issues

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
authentication Content relating to authentication content This issue or pull request belongs to the Docs Content team ready to merge This pull request is ready to merge ssh Content related to SSH waiting for review Issue/PR is waiting for a writer's review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants