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

Re: [ANNOUNCE] Git wiki

From
DLDavid Lang <dlang@digitalinsight.com>
Date
May 3, 2006, 19:46 UTC
Message-ID
<Pine.LNX.4.62.0605031243230.12716@qynat.qvtvafvgr.pbz>
In-Reply-To
<20060503193013.GN27689@pasky.or.cz>
On Wed, 3 May 2006, Petr Baudis wrote:
Show 25 quoted lines
> Dear diary, on Wed, May 03, 2006 at 09:21:54PM CEST, I got a letter
> where David Lang <dlang@digitalinsight.com> said that...
>> On Wed, 3 May 2006, Jakub Narebski wrote:
>>
>>> As to content, we could I think use material found at Wikipedia Git page,
>>> and on External Links in Wikipedia Git_(software) article, not repeating of
>>> course what is in official Git Documentation/
>>
>> please go ahead and put a lot of the info that is in the GIT
>> Documentation/ on the wiki. it's far easier to go to one site and browse
>> around to find things then to run into issues where you have to go
>> somewhere else (with different tools) to find the info.
>>
>> even if you just put all the documentation files there, as-is (as text
>> files even, no hyperlinks in them) they should still be there.
>
> Then who will keep it in sync (BOTH ways)? That would be quite a lot of
> work, I think.
>
> That said, having the documentation in a wiki is not a bad idea per se,
> but you need to keep things consistent and converging. And I believe
> (and hope) that killing Documentation/ directory is no option - I hate
> it when documentation of software I installed just tells me "look at
> this URI" (which documents a different version anyway, and it's all very
> useful when I'm sitting in a train with my notebook).
I agree with this completely.

as for keeping it in sync, the ideal situation would be for a documentation manager to take that job ;-) but lacking that just put the documentation in a non-editable page somewhere and link to it from the wiki (this could even be pages at kernel.org or wherever you have the raw source available outside of git itself)

David Lang
-- 
There are two ways of constructing a software design. One way is to make it so simple that there are obviously no deficiencies. And the other way is to make it so complicated that there are no obvious deficiencies.
  -- C.A.R. Hoare
Previous: Petr BaudisNext: Petr Baudis
Message 19 of 37 in “[ANNOUNCE] Git wiki”
  1. Petr BaudisMay 2, 2006
  2. Junio C HamanoMay 2, 2006
  3. Paolo CiarrocchiMay 3, 2006
  4. Petr BaudisMay 3, 2006
  5. Paolo CiarrocchiMay 3, 2006
  6. Nicolas PitreMay 3, 2006
  7. Shawn PearceMay 3, 2006
  8. Andreas EricssonMay 3, 2006
  9. Paolo CiarrocchiMay 3, 2006
  10. Jakub NarebskiMay 3, 2006
  11. Linus TorvaldsMay 3, 2006
  12. Paolo CiarrocchiMay 3, 2006
  13. Linus TorvaldsMay 3, 2006
  14. Jakub NarebskiMay 3, 2006
  15. Paolo CiarrocchiMay 3, 2006
  16. Jakub NarebskiMay 3, 2006
  17. David LangMay 3, 2006
  18. Petr BaudisMay 3, 2006
  19. David LangMay 3, 2006
  20. Petr BaudisMay 3, 2006
  21. Daniel BarkalowMay 4, 2006
  22. Theodore TsoMay 3, 2006
  23. Linus TorvaldsMay 3, 2006
  24. Theodore TsoMay 3, 2006
  25. Linus TorvaldsMay 3, 2006
  26. Sam RavnborgMay 3, 2006
  27. Petr BaudisMay 3, 2006
  28. Joel BeckerMay 3, 2006
  29. Petr BaudisMay 3, 2006
  30. Daniel BarkalowMay 3, 2006
  31. seanMay 3, 2006
  32. Junio C HamanoMay 3, 2006
  33. Junio C HamanoMay 3, 2006
  34. Linus TorvaldsMay 3, 2006
  35. [ANNOUNCE] Revamped Git homepagePetr Baudis, May 4, 2006
  36. Jakub NarebskiMay 4, 2006
  37. Petr BaudisMay 4, 2006

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.