Re: A documentation to-do list

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



Hi,

On Tue, 21 Nov 2006, Chris Riddoch wrote:

> Having decided to take it on myself to improve Git's documentation, I
> asked on #git if people had particular things they felt I should focus
> on.

I have a request, which is not about _what_ to document, but _how_. People 
often complained about the bad introduction into git, pointing to 
http://www.selenic.com/mercurial/wiki/index.cgi/QuickStart for a "way 
better" tutorial.

It would be really, really easy to just copy that, and describe git 
instead of hg. (There is no mention of a license there, so that may not be 
allowed, but then, it is too short and obvious to be copyrightable, isn't 
it?) You will find that git commands are way shorter!

So, finally my request: we should _organize_ the documentation such that 
your average Joe Programmer is able to get started with git in 1 minute.

If she is interested in more subtle operations, then she should have a 
technical overview such as "Branching and merging with git", maybe a 
little stripped down to leave complicated (but for normal work 
uninteresting) issues out. With a pot of steaming coffee.

Finally, for complicated issues, there is Documentation/technical, the man 
pages, the source, and the git list (in that order).

Hmmm?

Ciao,
Dscho

-
To unsubscribe from this list: send the line "unsubscribe git" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at  http://vger.kernel.org/majordomo-info.html

[Index of Archives]     [Linux Kernel Development]     [Gcc Help]     [IETF Annouce]     [DCCP]     [Netdev]     [Networking]     [Security]     [V4L]     [Bugtraq]     [Yosemite]     [MIPS Linux]     [ARM Linux]     [Linux Security]     [Linux RAID]     [Linux SCSI]     [Fedora Users]