*raises hand. I'm spending a few hours every week on this process. Also, I think we should have a doc sprint in the near future, as a prelude to TG 2.1a1 release.
cheers. -chris On Sep 2, 11:02 pm, Michael Pedersen <[email protected]> wrote: > Okay, I've been working on these docs quite a bit since I first sent this > out. As of a few minutes ago, I finally managed to complete the first file > reviews. Every single file was read by me, and quite a few "todo" items were > noted. As of right now, I've got 128 items on the todo list. That does not > cover the emails I've saved from this list as "get this documented", which > I'm now adding. Nor does it include docs tickets from trac.tg.org, which > will be forthcoming soon. > > Basically, we now have a mostly fixed target set of items for the docs. > Who's ready to help me start whittling this list down? > > > > > > On Mon, Jul 6, 2009 at 10:26 AM, Michael Pedersen <[email protected]> wrote: > > > On Mon, Jul 6, 2009 at 10:04 AM, Lukasz Szybalski > > <[email protected]>wrote: > > >> > The output is visible > >> > athttp://web.icelus.tzo.com/~marvin/tg2/<http://web.icelus.tzo.com/%7Emarvin/tg2/> > > >> How is this different then the official tg2 docs? Not sure what you're > >> plan is but wouldn't it be easier to modify the original content and > >> add the few sections that you have above. Work on the original to get > >> the pdf generated, and keep modifying until all the information is in > >> the same place? > > > As to how it's different, compare these two pages: > >http://turbogears.org/2.0/docs/index.html > >http://web.icelus.tzo.com/~marvin/tg2<http://web.icelus.tzo.com/%7Emarvin/tg2> > > > When you do, ask a couple of questions (and pretend you know nothing at all > > about TG when you do, this is your first time looking at the docs, etc): > > > 1. How do I get this installed? > > 2. What are the pieces that come with TG? > > 3. How can I use those pieces? > > 4. What are some of the common patterns for coding in TG? > > 5. What plugins are available? > > > And those are just some starter questions. Once you've started asking those > > questions, try to find the answers using the older style and the newer > > style. In my own experience, and along with the feedback I've seen so far, > > the style I'm promoting will be significantly easier to navigate. Instead of > > screens full of links, we have actual text describing what people can expect > > to find. We have (just beginning) an actual "to do list", so that we can > > identify where we've left documentation holes that need to be plugged. We > > have clearly defined areas for people to be able to submit their own docs on > > various items. > > > Personally, I find the newer style much easier to read and navigate. > > > As to "work on the original", that's exactly what I'm doing. The original > > source for the docs is available at > >http://bitbucket.org/mramm/tg_2_1_docs/This is a Mercurial repository > > which I have forked (and my fork is visible at > >http://bitbucket.org/pedersen/tg_2_1_docs/). I've even sent along a pull > > request already for the base changes I've done, and I'm looking to get back > > to the documentation much more seriously tonight than I have been for a few > > days (July 4th weekend for me was fun, but busy). > > -- > > Michael J. Pedersen > > My IM IDs: Jabber/[email protected], ICQ/103345809, > > AIM/pedermj022171 > > Yahoo/pedermj2002, MSN/[email protected] > > -- > Michael J. Pedersen > My IM IDs: Jabber/[email protected], ICQ/103345809, AIM/pedermj022171 > Yahoo/pedermj2002, MSN/[email protected] --~--~---------~--~----~------------~-------~--~----~ You received this message because you are subscribed to the Google Groups "TurboGears Trunk" group. To post to this group, send email to [email protected] To unsubscribe from this group, send email to [email protected] For more options, visit this group at http://groups.google.com/group/turbogears-trunk?hl=en -~----------~----~----~----~------~----~------~--~---
