Hi, Mimi et al Sorry for the delay: I thought I'd sent this off on Friday already. Some answers inline below.
--Grant On 19 Feb, 2009, at 10:23, Mimi Yin wrote: > Hi Jeffrey, > > Thanks for starting this thread. I'm wondering if a good way to think > about how to organize the documentation is to map out a workflow. > > Where does the person get started? > Right now, I think the 2 most obvious entry points for developers > are: "Get Involed" page and the "Developers Wiki Area". > > http://chandlerproject.org/getinvolved > http://chandlerproject.org/Developers/WebHome > > The "Get Involved" page really just points you to the "Developers > Wiki Area", if you're interested in development work. > > If the "Developers Wiki Area" is still the starting point, then > that's really where we should provide the context necessary for > understanding: > > 1. Difference between Desktop + Server > 2. Difference between Desktop 1.0 and 2.0 > 3. Technologies used for each: Desktop + Server > > If our goal is still: Get people oriented and set up to start playing > around with the code as quickly as possible. What other things should > be extra accessible? > e.g. > - Downloading 1.0 app and downloading the source and building it? > (for both 1.0 and 2.0). > - Tutorials? Development Tools? > > I guess my question is: Does the Desktop 2.0 documentation include > this stuff or is it more analogous to the "Reference Material" > portion of the 1.0 documentation? It's somewhere in between: i.e. the docs are written to explain the APIs, but they're not comprehensive method-by-method documentation. We could think about generating this kind of thing for chandler2 (probably there's a way to do it in Sphinx). > (I imagine that the "Reference Material" portion of the Chandler > Desktop column of the "Developers Wiki Area" homepage can be shuttled > off to a separate page dedicated to Desktop 1.0 documentation?) Yes, I think so. And we could even generate the docs for 1.0.x instead of 0.7! > I think once we have the Developers "Starting Point" ironed out, then > we can figure out how to link to it from other places like the > landing page, wiki homepage, "Get Involved", etc. > > If you or Grant can get the scaffolding up for a "Developers Starting > Point", then we could ask people on the list to provide input? Yes, at the very least we need an Installation guide (or a setting up the development environment guide). --Grant _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ Open Source Applications Foundation "chandler-dev" mailing list http://lists.osafoundation.org/mailman/listinfo/chandler-dev
