Git development
 help / color / mirror / Atom feed
From: "Julia Evans" <julia@jvns.ca>
To: "Junio C Hamano" <gitster@pobox.com>
Cc: git@vger.kernel.org
Subject: Re: Rewriting the Git tutorial to cover less content
Date: Fri, 25 Sep 2026 13:25:10 -0400	[thread overview]
Message-ID: <4c9f0480-768a-48ba-9753-b4d34188b1a1@app.fastmail.com> (raw)
In-Reply-To: <xmqq7bk9wa4y.fsf@gitster.g>

> Omitting some material that is covered in the current tutorial from
> the new one would mean that the topics covered by the remainder of
> the current tutorial have to be sifted into three buckets: one that
> is to be discarded because it is no longer useful to the target
> audience, another that needs to be described somewhere in our
> documentation set, and the rest that need to be taught elsewhere,

I do think there's a cost to keeping guides around that are outdated
and difficult for users to understand.

For example right now `man git` says:

> See gittutorial(7) to get started, then see giteveryday(7) for
> a useful minimum set of commands.

This is a nice friendly statement, but in my opinion `gittutorial` and
`giteveryday` really do not live up to what it promises, and I think
it undermines trust in the documentation.

> though that may be beyond the scope of the project documentation
> and better left to other projects that produce "books on Git".  It
> is somewhat unclear from your description what your plan is to cover
> other topics that should still be taught.

I see a couple of possible strategies.

* We can write new guides which are clearer
* We can link to outside resources (via https://git-scm.com/learn)
  which we think do a good job. Right now that page is pretty
  out of date and it would be very easy to improve.

I think a mix of both is probably most realistic right now.

  reply	other threads:[~2026-09-25 17:25 UTC|newest]

Thread overview: 22+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-09-22 19:29 [PATCH] doc: add more AsciiDoc cross-references Julia Evans via GitGitGadget
2026-09-22 20:20 ` Junio C Hamano
2026-09-22 20:54   ` Julia Evans
2026-09-23 21:40     ` Jeff King
2026-09-24 12:30       ` Julia Evans
2026-09-24 15:55         ` Jeff King
2026-09-24 17:15         ` Junio C Hamano
2026-09-24 17:22           ` Julia Evans
2026-09-24 18:17             ` Junio C Hamano
2026-09-24 18:42             ` Jeff King
2026-09-23 19:06 ` Kristoffer Haugsbakk
2026-09-23 22:00 ` Jeff King
2026-09-25  0:52 ` [PATCH v2] " Julia Evans via GitGitGadget
2026-09-25  8:27   ` Jeff King
2026-09-25 16:08     ` Rewriting the Git tutorial to cover less content Julia Evans
2026-09-25 16:47       ` Junio C Hamano
2026-09-25 17:25         ` Julia Evans [this message]
2026-09-25 18:23           ` Junio C Hamano
2026-09-25 19:22             ` Julia Evans
2026-09-25 19:34               ` Junio C Hamano
2026-09-28 12:21                 ` Julia Evans
2026-09-28 15:16                   ` 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=4c9f0480-768a-48ba-9753-b4d34188b1a1@app.fastmail.com \
    --to=julia@jvns.ca \
    --cc=git@vger.kernel.org \
    --cc=gitster@pobox.com \
    /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