Git development
 help / color / mirror / Atom feed
From: Junio C Hamano <gitster@pobox.com>
To: "Julia Evans via GitGitGadget" <gitgitgadget@gmail.com>
Cc: git@vger.kernel.org,  Julia Evans <julia@jvns.ca>
Subject: Re: [PATCH 2/2] doc: add new Git tutorial for beginners
Date: Tue, 20 Oct 2026 10:11:47 -0700	[thread overview]
Message-ID: <xmqqzew8wb3g.fsf@gitster.g> (raw)
In-Reply-To: <41dca2e8e0c5fadb8ad9ed8707029356e56cc540.1791315422.git.gitgitgadget@gmail.com> (Julia Evans via GitGitGadget's message of "Tue, 06 Oct 2026 19:37:02 +0000")

"Julia Evans via GitGitGadget" <gitgitgadget@gmail.com> writes:

> From: Julia Evans <julia@jvns.ca>
>
> This tutorial covers:
>
> 1. Creating an empty repo with `git init`
> 2. Making commits with `git add`, `git commit`, `git diff`, and
>    `git status`
> 3. Pushing to code to a Git host on the internet, including creating an
>    SSH key
>
> Signed-off-by: Julia Evans <julia@jvns.ca>
> ---

The goal is well described, and overall the tutorial is well-paced
and avoids common beginner traps.  Since Ben has covered the text
fairly well, the remainder of this message has just some leftover
nitpicks.

> +Step 10: Create an SSH key (if needed)
> +-------------------------------------

Even though AsciiDoc implementations are somewhat lenient to allow
difference by a char or two, but the number of hyphens there must
match the number of chars on the previous line, so add one '-'.

> +For Git to upload changes to another Git repository, it needs a way to
> +login to that repository. One of the most popular ways to do this is
> +with an SSH key.
> +
> +If you don't already have an SSH key, you'll need to create one. On Mac
> +or Linux, you can check if you already have an SSH key by running:
> +
> +-------------------------------------------
> +$ ls ~/.ssh/*.pub
> +-------------------------------------------
> +
> +If you don't already have an SSH key, run:
> +
> +-------------------------------------------
> +$ ssh-keygen
> +-------------------------------------------

It may depend on the system settings, but doesn't this by default
still create id_rsa.pub?  I wonder if we want

$ ssh-keygen -t ed25519

so that it will match what the users will find in the next "Step 11".

> +Step 11: Tell the Git host your SSH public key
> +----------------------------------------------
> +
> +First, find your SSH key like this (on Mac or Linux):
> +
> +-------------------------------------------
> +$ ls ~/.ssh/*.pub
> +-------------------------------------------
> +
> +That will output something like
> +
> +-------------------------------------------
> +/home/alice/.ssh/id_ed25519.pub
> +-------------------------------------------
> +
> +Copy the contents of that file to your clipboard. It's important that
> +the filename ends in `.pub` ("pub" stands for "public").

OK.  I hope users won't paste the ls output above instead by
mistake, but perhaps giving a command like "cat ~/.ssh/id_ed25519.pub"
may make this step harder to make mistakes?

> +Then login to your account on the Git host you chose and paste the SSH
> +key into the appropriate place. Depending on the Git host, it's likely
> +under "SSH keys" in your settings. If it asks you what type of SSH key,
> +look for something like "Authentication Key".
> +
> +Once you've done this, you're done! Git will automatically use your SSH
> +key to try to connect.

> +Step 14: push your changes
> +--------------------------

Upcase "Push your changes" to match other steps.

  parent reply	other threads:[~2026-10-20 17:11 UTC|newest]

Thread overview: 25+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-10-06 19:37 [PATCH 0/2] WIP: doc: add new git tutorial Julia Evans via GitGitGadget
2026-10-06 19:37 ` [PATCH 1/2] doc: remove gittutorial Julia Evans via GitGitGadget
2026-10-06 19:37 ` [PATCH 2/2] doc: add new Git tutorial for beginners Julia Evans via GitGitGadget
2026-10-07 19:48   ` D. Ben Knoble
2026-10-19 14:24     ` Julia Evans
2026-10-19 16:49       ` Ben Knoble
2026-10-19 20:42         ` Julia Evans
2026-10-19 21:14           ` D. Ben Knoble
2026-10-20 17:11   ` Junio C Hamano [this message]
2026-10-20 17:59     ` Julia Evans
2026-10-20 18:26       ` Junio C Hamano
2026-10-20 18:27       ` Junio C Hamano
2026-10-20 18:45         ` Junio C Hamano
2026-10-20 19:13           ` Junio C Hamano
2026-10-20 18:22     ` Julia Evans
2026-10-20 18:30       ` Junio C Hamano
2026-10-07 19:26 ` [PATCH 0/2] WIP: doc: add new git tutorial D. Ben Knoble
2026-10-19 14:55 ` [PATCH v2 0/2] " Julia Evans via GitGitGadget
2026-10-19 14:55   ` [PATCH v2 1/2] doc: remove gittutorial Julia Evans via GitGitGadget
2026-10-19 14:55   ` [PATCH v2 2/2] doc: add new Git tutorial for beginners Julia Evans via GitGitGadget
2026-10-20  1:24   ` [PATCH v2 0/2] doc: add new git tutorial Junio C Hamano
2026-10-20  2:24     ` Ben Knoble
2026-10-20 12:18       ` Julia Evans
2026-10-20 18:50         ` Tuomas Ahola
2026-10-20 19:13     ` Junio C Hamano

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=xmqqzew8wb3g.fsf@gitster.g \
    --to=gitster@pobox.com \
    --cc=git@vger.kernel.org \
    --cc=gitgitgadget@gmail.com \
    --cc=julia@jvns.ca \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox