docs icon indicating copy to clipboard operation
docs copied to clipboard

Update shell commands for Mac OS after 12.0

Open madbernard opened this issue 3 years ago â€ĸ 7 comments

The syntax has changed and this docs update highlights the new syntax.

Why:

Closes https://github.com/github/docs/issues/19156

What's being changed (if available, include any code snippets, screenshots, or gifs):

This shifts the focus of the doc so that modern working shell commands are given the spotlight.

Check off the following:

  • [x] I have reviewed my changes in staging (look for the "Automatically generated comment" and click the links in the "Preview" column to view your latest changes).
  • [x] For content changes, I have completed the self-review checklist.

Writer impact (This section is for GitHub staff members only):

  • [ ] This pull request impacts the contribution experience
    • [ ] I have added the 'writer impact' label
    • [ ] I have added a description and/or a video demo of the changes below (e.g. a "before and after video")

madbernard avatar Jul 19 '22 23:07 madbernard

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.

welcome[bot] avatar Jul 19 '22 23:07 welcome[bot]

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.6 3.5 3.4 3.3 3.2
ghae
fpt
ghec
ghes@ 3.6 3.5 3.4 3.3 3.2
ghae

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

github-actions[bot] avatar Jul 19 '22 23:07 github-actions[bot]

@madbernard Thanks for opening a PR and linking it to your issue! 💖

I'll get this triaged for review ⚡

cmwilson21 avatar Jul 20 '22 13:07 cmwilson21

👋 @madbernard. Thanks for your patience as we work through our backlog 💛

I noticed that the link in the note states -k is Apple's standard version of ssh-add. The note points to this page when receiving an error. Does the wording of this error match the document it points to involving the -k? Or should that article be updated to reflect --apple-use-keychain, too?

cmwilson21 avatar Aug 11 '22 20:08 cmwilson21

Good point @cmwilson21 ! I tried an option flag that doesn't exist in ssh-add, $ ssh-add -y and got ssh-add: invalid option -- y so probably if someone didn't have Apple's version of ssh-add as the main one in their path, then they'd see ssh-add: invalid option -- apple-use-keychain, so we should update that doc also.

madbernard avatar Aug 15 '22 18:08 madbernard

Ok, I took a stab at updating that doc as well. Please further adapt it as you like (I left the primary URL/filename the same)

madbernard avatar Aug 15 '22 20:08 madbernard

@madbernard Thanks for doing this! I'll have the team take a look 👀

cmwilson21 avatar Aug 16 '22 15:08 cmwilson21

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 :zap:

github-actions[bot] avatar Sep 30 '22 23:09 github-actions[bot]