Re: [Twisted-Python] Task-based documentation started

2011-02-06 Thread Tom Davis
On Tue, Feb 1, 2011 at 5:15 PM, Glyph Lefkowitz wrote: > > On Feb 1, 2011, at 10:53 AM, Tom Davis wrote: > > On Tue, Feb 1, 2011 at 12:58 PM, Glyph Lefkowitz > wrote: > >> >> On Jan 31, 2011, at 11:41 AM, Tom Davis wrote: >> >> Thoughts? >> >> >> Priority #1 for most people who are enthusiastic a

Re: [Twisted-Python] Task-based documentation started

2011-02-01 Thread Kevin Horn
On Tue, Feb 1, 2011 at 4:15 PM, Glyph Lefkowitz wrote: > > OK. For what it's worth I share your desire for a new / better term but I > can't think of one. > > Recipes? Snippets? Tidbits? Morsels? Quickies? "How do I..."s? Quick Examples? Simple Examples? Examples? Blurbs? A lot of the va

Re: [Twisted-Python] Task-based documentation started

2011-02-01 Thread Andrew Bennetts
Tom Davis wrote: [...] >* .rpy scripts are for deployment, not debugging; I was a little > concerned seeing that bullet point on the outline. �(See > > <[2]http://twistedmatrix.com/documents/10.2.0/web/howto/web-in-60/rpy-scripts.html>.) > >Huh? The docs you link to

Re: [Twisted-Python] Task-based documentation started

2011-02-01 Thread Glyph Lefkowitz
On Feb 1, 2011, at 10:53 AM, Tom Davis wrote: > On Tue, Feb 1, 2011 at 12:58 PM, Glyph Lefkowitz > wrote: > > On Jan 31, 2011, at 11:41 AM, Tom Davis wrote: > >> Thoughts? > > > Priority #1 for most people who are enthusiastic about documentation is to > come in and write a ton of addition

Re: [Twisted-Python] Task-based documentation started

2011-02-01 Thread Tom Davis
On Tue, Feb 1, 2011 at 12:58 PM, Glyph Lefkowitz wrote: > > On Jan 31, 2011, at 11:41 AM, Tom Davis wrote: > > Thoughts? > > > Priority #1 for most people who are enthusiastic about documentation is to > come in and write a ton of additional documentation. But this is a lot like > trying to fix a

Re: [Twisted-Python] Task-based documentation started

2011-02-01 Thread Jason J. W. Williams
On Jan 31, 2011, at 11:41 AM, Tom Davis wrote: > > Thoughts? Overall I think the layout and structure is a big improvement over the current Twisted documentation. It's easier to navigate and grok where you want to go. While the content of the web tutorial is thin, I think Jean-Paul's Twisted Web i

Re: [Twisted-Python] Task-based documentation started

2011-02-01 Thread Kevin Horn
On Tue, Feb 1, 2011 at 11:55 AM, Glyph Lefkowitz wrote: > > On Jan 31, 2011, at 3:19 PM, exar...@twistedmatrix.com wrote: > > On 10:39 pm, t...@recursivedream.com wrote: > > > Take < > > http://twistedmatrix.com/documents/10.2.0/web/howto/web-in-60/static- > > content.html > > : > > > Tell me the

Re: [Twisted-Python] Task-based documentation started

2011-02-01 Thread Glyph Lefkowitz
On Jan 31, 2011, at 11:41 AM, Tom Davis wrote: > Thoughts? Priority #1 for most people who are enthusiastic about documentation is to come in and write a ton of additional documentation. But this is a lot like trying to fix a large, broken, untested system by writing a pile of new, untested

Re: [Twisted-Python] Task-based documentation started

2011-02-01 Thread Glyph Lefkowitz
On Jan 31, 2011, at 3:19 PM, exar...@twistedmatrix.com wrote: > On 10:39 pm, t...@recursivedream.com wrote: >> >> Take < >> http://twistedmatrix.com/documents/10.2.0/web/howto/web-in-60/static- >> content.html >>> : >> >> Tell me the one command I need to serve a directory, *then* show me the

Re: [Twisted-Python] Task-based documentation started

2011-02-01 Thread Albert Brandl
On Tue, Feb 01, 2011 at 09:05:32AM -0500, Tom Davis wrote: > The "breadcrumbs" on the main page look like this: > "Contents :: Serving on the Web HTML, CGI, WSGI, etc." > Might be a problem with the Sphinx configuration. > > Yeah, this is just how the Sphinx template lays thi

Re: [Twisted-Python] Task-based documentation started

2011-02-01 Thread Tom Davis
On Mon, Jan 31, 2011 at 6:19 PM, wrote: > On 10:39 pm, t...@recursivedream.com wrote: > > > >Take < > >http://twistedmatrix.com/documents/10.2.0/web/howto/web-in-60/static- > >content.html > >>: > > > >Tell me the one command I need to serve a directory, *then* show me the > >code > >that one com

Re: [Twisted-Python] Task-based documentation started

2011-02-01 Thread Tom Davis
On Tue, Feb 1, 2011 at 3:44 AM, Albert Brandl wrote: > On Mon, Jan 31, 2011 at 02:41:38PM -0500, Tom Davis wrote: > > Thoughts? > > I think that the overview in the first two sections is very good. It > made me curious to learn more. > > The "breadcrumbs" on the main page look like this: > "Conten

Re: [Twisted-Python] Task-based documentation started

2011-02-01 Thread Albert Brandl
On Mon, Jan 31, 2011 at 02:41:38PM -0500, Tom Davis wrote: > Thoughts? I think that the overview in the first two sections is very good. It made me curious to learn more. The "breadcrumbs" on the main page look like this: "Contents :: Serving on the Web — HTML, CGI, WSGI, etc. » " Might be

Re: [Twisted-Python] Task-based documentation started

2011-01-31 Thread exarkun
On 10:39 pm, t...@recursivedream.com wrote: > >Take < >http://twistedmatrix.com/documents/10.2.0/web/howto/web-in-60/static- >content.html >>: > >Tell me the one command I need to serve a directory, *then* show me the >code >that one command effectively runs and vaguely what it does. I think thi

Re: [Twisted-Python] Task-based documentation started

2011-01-31 Thread Tom Davis
On Mon, Jan 31, 2011 at 5:22 PM, Glyph Lefkowitz wrote: > > On Jan 31, 2011, at 11:41 AM, Tom Davis wrote: > > Thoughts? > > > I'll have to write more later, but maybe you should read *all* of the > existing twisted.web documentation first? I am sorry to say it, but this > seems like a less infor

Re: [Twisted-Python] Task-based documentation started

2011-01-31 Thread Glyph Lefkowitz
On Jan 31, 2011, at 11:41 AM, Tom Davis wrote: > Thoughts? I'll have to write more later, but maybe you should read all of the existing twisted.web documentation first? I am sorry to say it, but this seems like a less informative and more confusing version of

[Twisted-Python] Task-based documentation started

2011-01-31 Thread Tom Davis
I have the beginnings of some task-based documentation available in twisted-docs (https://github.com/tdavis/twisted-docs) now. You can find the built version in the usual place (http://docs.recursivedream.com/twisted/) -- just remember to bust the cache. I chose serving web content as a starting p