Skip to content

Updates instructions to encourage SSH and fixes incorrect images/instructions#18

Merged
Trott merged 7 commits into
Trott:mainfrom
bmuenzenmeyer:main
Sep 17, 2022
Merged

Updates instructions to encourage SSH and fixes incorrect images/instructions#18
Trott merged 7 commits into
Trott:mainfrom
bmuenzenmeyer:main

Conversation

@bmuenzenmeyer

@bmuenzenmeyer bmuenzenmeyer commented Sep 17, 2022 •
edited
Loading

Copy link
Copy Markdown
Contributor

Today during Open Source Day I was fortunate enough to help 14 people interact with the Node project for the first time. I went through the same setup as them a week or so earlier, using this document. I glossed over much of it, already knowing or assuming things along the way. But attendees today took the advice here much more literally, and I had to help them a number of times.

I wish I'd seen this all before the event, but better late than never!

Incorrect "Clone or Download" Instruction and Image

This image and button text is from an older version of GitHub

image

someone explicitly asked me where this was

I've updated it to be accurate (and made it more clear it's from a fork). Updating the images also has the benefit of refreshing the numbers and UI chrome a bit.

image

Instructions encourage HTTPS cloning (implied by the HTTPS upstream), which is deprecated

Per this announcement and follow up, GitHub removed authenticated git actions a bit ago. We don't notice this right away because git clone is unauthenticated.

Here's a complete reproduction:

C:\src>git clone https://github.com/bmuenzenmeyer/github-https-access-test.git
Cloning into 'github-https-access-test'...
remote: Enumerating objects: 3, done.
remote: Counting objects: 100% (3/3), done.
remote: Total 3 (delta 0), reused 0 (delta 0), pack-reused 0
Unpacking objects: 100% (3/3), 612 bytes | 76.00 KiB/s, done.

C:\src>cd github-https-access-test

C:\src\github-https-access-test>echo new content > test.txt              

C:\src\github-https-access-test>dir
 Volume in drive C has no label.
 Volume Serial Number is 02BA-1C82

 Directory of C:\src\github-https-access-test      

09/16/2022  09:47 PM    <DIR>          .
09/16/2022  09:47 PM    <DIR>          ..
09/16/2022  09:45 PM                28 README.md   
09/16/2022  09:47 PM                14 test.txt    
               2 File(s)             42 bytes      
               2 Dir(s)  358,529,802,240 bytes free

C:\src\github-https-access-test>git add .

C:\src\github-https-access-test>git commit -m "doc: add new file"
[main 80caa92] doc: add new file
 1 file changed, 1 insertion(+) 
 create mode 100644 test.txt    

C:\src\github-https-access-test>git status
On branch main
Your branch is ahead of 'origin/main' by 1 commit.
  (use "git push" to publish your local commits)  

nothing to commit, working tree clean

C:\src\github-https-access-test>git push
Username for 'https://github.com': bmuenzenmeyer
Password for 'https://bmuenzenmeyer@github.com': 
remote: Support for password authentication was removed on August 13, 2021.
remote: Please see https://docs.github.com/en/get-started/getting-started-with-git/about-remote-repositories#cloning-with-https-urls for information 
on currently recommended modes of authentication.
fatal: Authentication failed for 'https://github.com/bmuenzenmeyer/github-https-access-test.git/'

two individuals came to me with this problem

I've updated the docs with a suggestion to use an SSH key. This seems like a better choice than a personal access token, but I could be swayed.

image

bmuenzenmeyer
bmuenzenmeyer commented Sep 17, 2022
View reviewed changes

@bmuenzenmeyer bmuenzenmeyer left a comment

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

self-review

noticed the images are notably smaller. I could retake them on a retina screen if needed (I did all this quick on my Windows machine after the kiddos went to bed)

Comment thread index.html
<title>Getting Started With Node.js Core Development</title>
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/normalize/3.0.3/normalize.min.css" type="text/css">
<link href="https://fonts.googleapis.com/css?family=Baloo+Tamma%7COpen+Sans" rel="stylesheet">
<link rel="stylesheet" href="../style.css" type="text/css">

@bmuenzenmeyer bmuenzenmeyer Sep 17, 2022

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

I could not render locally without this change. Perhaps I am testing it differently than expected.

@Trott Trott Sep 17, 2022

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

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

Yeah, this change is correct. I goofed this up earlier this week. It doesn't matter on the server because .. is still the root webdocs directory, but it means local testing gets messed up. Thanks for fixing it.

Trott
Trott approved these changes Sep 17, 2022
View reviewed changes

@Trott Trott left a comment

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

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

I'll land this now and someone (you, me, someone else) can replace the images in a subsequent PR if they are too small on the website.

@Trott Trott merged commit 67b1675 into Trott:main Sep 17, 2022
@Trott

Trott commented Sep 17, 2022

Copy link
Copy Markdown
Owner

Thanks for the improvements!!! ❤️

@bmuenzenmeyer bmuenzenmeyer mentioned this pull request Oct 24, 2022
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@Trott Trott Trott approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@bmuenzenmeyer @Trott