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.

Sign up for GitHub

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

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

Merged
merged 7 commits into from
Sep 17, 2022
Merged

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
99730f1
doc: update fork image
bmuenzenmeyer Sep 17, 2022
07672f9
doc: update clone image
bmuenzenmeyer Sep 17, 2022
b3b8a0b
style: fix stylesheet link
bmuenzenmeyer Sep 17, 2022
3d74b23
doc: fix install instructions where wrong button referenced and depre…
bmuenzenmeyer Sep 17, 2022
7e6fce8
Merge branch 'Trott:main' into main
bmuenzenmeyer Sep 17, 2022
0dce475
doc: add SSH docs and fix whitespace
bmuenzenmeyer Sep 17, 2022
2477ab3
Merge branch 'main' of github.com:bmuenzenmeyer/nodetodo into main
bmuenzenmeyer Sep 17, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 8 additions & 4 deletions index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<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">
Copy link
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.

Copy link
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.

<link rel="stylesheet" href="style.css" type="text/css">
<meta property="og:title" content="Node Todo Getting Started">
<meta property="og:description" content="Getting started contributing to Node.js.">
<meta property="og:type" content="website">
Expand Down Expand Up @@ -48,11 +48,15 @@ <h2>Getting Started</h2>
<img src="zfork.png" alt="" style="max-width:100%;">
</li>

<li>On the page <em>for your own fork</em>, use the "Clone or download" button and copy the URL for cloning to your clipboard:
<li>On the page <em>for your own fork</em>, use the "Code" button and copy the URL for cloning to your clipboard:

<img src="zclone.png" alt="" style="max-width:100%;">
</li>

<li>
Recommendation: Use the <code>SSH</code> URL within the "Code" modal. Username and password authentication via <code>HTTPS</code> is <a href="https://github.blog/2020-12-15-token-authentication-requirements-for-git-operations/">no longer supported</a>, and you won't notice until you try to commit your local code back to the fork. Refer to the <a href="https://docs.github.com/en/authentication/connecting-to-github-with-ssh/about-ssh">SSH documentation on GitHub</a> if you need help setting this up.
</li>

<li>On the command line, in your home directory or a directory you have for projects, run:

<blockquote><code>git clone &lt;paste that URL here!&gt;</code></blockquote>
Expand All @@ -62,9 +66,9 @@ <h2>Getting Started</h2>
<blockquote><code>cd node</code></blockquote>
</li>

<li>Then:
<li>Then (if using <code>SSH</code> as recommended):

<blockquote><code>git remote add upstream https://github.com/nodejs/node.git</code></blockquote>
<blockquote><code>git remote add upstream git@github.com:nodejs/node.git</code></blockquote>
</li>

<li>Optional, but recommended: Configure `git` so that it knows who
Expand Down
Binary file modified zclone.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified zfork.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.