Re: GIT vs Other: Need argument

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

 




On Tue, 24 Apr 2007, J. Bruce Fields wrote:
> 
> Note that we almost have the tutorials for the "two very simple cases"
> that Linus identifies:
> 
> 	- case #1, the "anonymous CVS" replacement: chapter 2 of
> 	  user-manual.txt (the first chapter after the quick start) covers
> 	  this.  Perhaps in greater generality than necessary, and maybe
> 	  detached heads and/or --track should be mentioned earlier.
> 
> 	- tutorial.txt, the "how to start tracking your own project"
> 	  case, starts with git-init, git-add, etc.
> 
> One problem is that it's not immediately obvious which one to look at
> for each case.

Well, I think they really should be documents of their own, so that you 
can read about the "CVS tracking" or so without even worrying about the 
fact that you didn't read the whole thing.

And they should be easy to find. I agree that we do actually have a fair 
amount of docs, but it seems that people don't tend to *find* them. The 
user-manual, for example, is great, but I've seen people on the #git logs 
apparently not realize it exists ;)

For example, the git homepage has a "documentation" thing, which only 
lists the tutorial, not the user manual explicitly. You _can_ get to the 
user manual (go to the online version of the Documentation directory and 
note the "still work in progress"), but even if you do actually find 
yourself there, the user manual itself is actually a bit scary to start 
with.

So I think we could just make the initial impression a bit easier. The 
tutorial comes fairly close to the "tracking your own" thing, I agree, 
but maybe we could have the documentation listed in order of complexity, 
and having a way for people to know *which* doc they should start with 
when they are at http://git.or.cz/ (or the wikipedia page), so that if 
you're only interested in the "tracking somebody else", you could easily 
find and read just a single simple documentation thing. Hmm?

			Linus
-
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]