Re: [jgit-dev] JGit User Guide

[Shawn Pearce <spearce@xxxxxxxxxxx>]

On Mon, Sep 6, 2010 at 7:34 PM, Chris Aniszczyk <caniszczyk@xxxxxxxxx> wrote:
> I've started work on an initial JGit User Guide
>   http://wiki.eclipse.org/JGit/User_Guide
>
> I would appreciate thoughts on what you think would make it more
> useful. I'm thinking of adding some more useful examples that people
> can start with for common operations. However, as we get a better
> porcelain API, we should point people there as much as possible (and
> document it).
>
> And if there are any other better ways to organize the content.

*sigh*

You are going to shame me into writing this myself, aren't you?  Using
JGit could have a book written about it.  And we're not even done
implementing features yet.

Personally, I think the more book-like tutorial started over at the
code.google.com project [1] is a better way to approach this.  Show by
example, working up from the "say hello to git" to doing complex
things like embedding JGit into your own server process, or
implementing your own network transport.  (FWIW, I've done a smart git
on top of a different type of RPC than HTTP.  Its a nightmare, I had
to steal a ton of code from our own transport classes.  I need to
rethink how we do the RPC wrapping.)

[1] http://code.google.com/p/egit/wiki/TableOfContents

-- 
Shawn.