Re: Documentation restructuring

2008-01-19 Thread Simon Greenhill
>4. Task-oriented indexes: "I need to unit test my application", "I >need to audit the security of my site", "I need to extend the auth >system", etc. These ones are often overlooked, I think. If you look at PHP's documentation there's a lot of "how-to"-style documents. How do I write a guest boo

Re: Documentation restructuring

2008-01-19 Thread Mark Green
On Tue, 2007-10-23 at 15:02 +0200, Nis Jørgensen wrote: > Kenneth Gonsalves skrev: > > one thing I would like to see is: table of contents available on all > > pages. Now I have to go to 'documentation' and click on dbiapi. Then, > > if I want to go to 'creating models' I go back to 'documen

Re: Documentation restructuring

2007-10-23 Thread Nis Jørgensen
Kenneth Gonsalves skrev: > one thing I would like to see is: table of contents available on all > pages. Now I have to go to 'documentation' and click on dbiapi. Then, > if I want to go to 'creating models' I go back to 'documentation' and > then to creating models. I bookmark these, but am

Re: Documentation restructuring

2007-10-19 Thread Kenneth Gonsalves
On 20-Oct-07, at 7:25 AM, James Bennett wrote: > As someone who uses Django's documentation on a daily basis, here's > what I'd like to see: one thing I would like to see is: table of contents available on all pages. Now I have to go to 'documentation' and click on dbiapi. Then, if I want t

Re: Documentation restructuring

2007-10-19 Thread James Bennett
On 10/18/07, Jeremy Dunck <[EMAIL PROTECTED]> wrote: > I'd like to improve the quality of Django's documentation. > I'm sure there will be many opinions on what "improvement" would mean. I'm also interested, though I keep running out of hours in the day to work on it :) > I'd like to solic

Re: Documentation restructuring

2007-10-19 Thread Adam Findley
Marty Alchin wrote: > So to me, PHP's documentation is better than Django's, but PHP (not > very OO) also lends itself well to that type of documentation, much > better than Python, and thus Django. But even Python's standard > library reference better suits my taste. This right here is the numb

Re: Documentation restructuring

2007-10-19 Thread Marty Alchin
On 10/19/07, Jeremy Dunck <[EMAIL PROTECTED]> wrote: > > On Oct 18, 2007, at 8:55 PM, Marty Alchin wrote: > > > On 10/18/07, Jeremy Dunck <[EMAIL PROTECTED]> wrote: > > >> I'd like to improve the quality of Django's documentation. > > > > > > I can't say I'm surprised to hear that. I've heard se

Re: Documentation restructuring

2007-10-18 Thread Jared Flatow
On Oct 19, 2007, at 12:34 AM, Jeremy Dunck wrote: > Django's docs, at one point, set the bar for open source documentation > projects. Now it is, IMHO, merely better than average. No offense > intended to anyone. :) From what I've seen I'd agree. >> While Django is excellent >> for rapidly p

Re: Documentation restructuring

2007-10-18 Thread Jeremy Dunck
On 10/19/07, Jared Flatow <[EMAIL PROTECTED]> wrote: > > On Oct 18, 2007, at 8:55 PM, Marty Alchin wrote: > > On 10/18/07, Jeremy Dunck <[EMAIL PROTECTED]> wrote: > >> I'd like to improve the quality of Django's documentation. > > > > I can't say I'm surprised to hear that. I've heard several re

Re: Documentation restructuring

2007-10-18 Thread Jared Flatow
On Oct 18, 2007, at 8:55 PM, Marty Alchin wrote: > On 10/18/07, Jeremy Dunck <[EMAIL PROTECTED]> wrote: >> I'd like to improve the quality of Django's documentation. > > I can't say I'm surprised to hear that. I've heard several requests > for changes in the documentation. Heck, I think I've eve

Re: Documentation restructuring

2007-10-18 Thread Marty Alchin
On 10/18/07, Malcolm Tredinnick <[EMAIL PROTECTED]> wrote: > I may have communicated poorly, as usual. I think we'll get lots of > information and some of it will be of great value. What I do think is > important is that we have to manage expectations a bit, because there > will be people who'll t

Re: Documentation restructuring

2007-10-18 Thread Malcolm Tredinnick
On Thu, 2007-10-18 at 21:55 -0400, Marty Alchin wrote: > On 10/18/07, Jeremy Dunck <[EMAIL PROTECTED]> wrote: > > I'd like to improve the quality of Django's documentation. > > I can't say I'm surprised to hear that. I've heard several requests > for changes in the documentation. Heck, I think

Re: Documentation restructuring

2007-10-18 Thread Marty Alchin
On 10/18/07, Jeremy Dunck <[EMAIL PROTECTED]> wrote: > I'd like to improve the quality of Django's documentation. I can't say I'm surprised to hear that. I've heard several requests for changes in the documentation. Heck, I think I've even been one of them, some time ago. I like the idea of ap

Re: Documentation restructuring

2007-10-18 Thread Tom Tobin
On Thu, 2007-10-18 at 19:18 -0500, Jeremy Dunck wrote: > Devs, > I'd like to improve the quality of Django's documentation. > I'm sure there will be many opinions on what "improvement" would mean. > > I'd like to solicit ideas from django-users regarding how people use > the docs and wish t

Re: Documentation restructuring

2007-10-18 Thread Malcolm Tredinnick
On Thu, 2007-10-18 at 19:18 -0500, Jeremy Dunck wrote: > Devs, > I'd like to improve the quality of Django's documentation. > I'm sure there will be many opinions on what "improvement" would mean. > > I'd like to solicit ideas from django-users regarding how people use > the docs and wish t

Documentation restructuring

2007-10-18 Thread Jeremy Dunck
Devs, I'd like to improve the quality of Django's documentation. I'm sure there will be many opinions on what "improvement" would mean. I'd like to solicit ideas from django-users regarding how people use the docs and wish they were different. OK? I don't want to start the torrent of su