git/list[1] front-page[2] threads[3] people[4] search[5] about
 

Re: Feedback outside of the user survey

From
Richard Hartmann <richih.mailinglist@gmail.com>
Date
Oct 16, 2008, 11:08 UTC
Message-ID
<2d460de70810160408x784a657fte418d41dd6a06d7f@mail.gmail.com>
In-Reply-To
<20081016102835.GC20762@sigill.intra.peff.net>
On Thu, Oct 16, 2008 at 12:28, Jeff King <peff@peff.net> wrote:
> Is there something about these that doesn't meet your criteria? Or did
> you not know about them (in which case, maybe we need to be more
> prominently pointing to them)?

In best slapstick fashion, I found the pages you mentioned in 1) and 3) after sending off my email. Maybe they did not exist back when I last looked, maybe they are easier to find now, maybe I was too stupid to look, back then. In any case, those two fit my needs nicely. In fact, I would have said as much on this list if I had not become stuck in reading said docs :)

As to the resource you mention in 2), it is nice, but it does not fit exactly to what I had in mind. You have a lot of snippets and single steps, which is fine. What I was imagining was more like a use case & workflow-driven layout. A basic or complex task could give a short overview of steps, all of which would be hyperlinked to detailed explanations. As a lot (more) documentation seems to exist since I last gave git a serious try, this is probably mainly a work of coming up with workflows and linking to the correct places, not so much of writing any actual new text.

And yes, I think the fact that these newbie-friendly docs exist these days should be pushed more agressively. As you can see from the links in my initial mail, a _lot_ of people have the same misinformation I used to have. That will mainly be due to old knowledge, but the situation exists. Worse, those people will warn others about the lack of starter-level docs, making more people shun git for all the wrong reasons.

An easy step in this direction might be to _prominently_ display direct links to the newbie docs on the entry points, for most users. I.e. the main site [1] and the wiki [2] along with the FAQ. I would edit the wiki myself, but I could not find MoinMaster:MoinPagesEditorGroup nor MoinMaster anywhere in said wiki, thus decided to heed the warning & not edit at all.

Richard

[1] http://git.or.cz/ [2] http://git.or.cz/gitwiki

Previous: Jeff KingNext: Garry Dolley
Message 3 of 17 in “Feedback outside of the user survey”
  1. Richard HartmannOct 16, 2008
  2. Jeff KingOct 16, 2008
  3. Richard HartmannOct 16, 2008
  4. Garry DolleyOct 16, 2008
  5. Richard HartmannOct 16, 2008
  6. Christian JaegerOct 16, 2008
  7. Garry DolleyOct 18, 2008
  8. Christian JaegerOct 18, 2008
  9. Andreas EricssonOct 20, 2008
  10. Christian JaegerOct 20, 2008
  11. Andreas EricssonOct 20, 2008
  12. Christian JaegerOct 20, 2008
  13. Andreas EricssonOct 20, 2008
  14. Christian JaegerOct 20, 2008
  15. Christian JaegerOct 20, 2008
  16. Junio C HamanoOct 20, 2008
  17. Christian JaegerOct 21, 2008

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.