Tornado Documentation

[Eli James]

Hi guys,

I'm new to Tornado, so I won't presume to know how things work around here. Please do tell me if I'm suggesting something dumb, or if it's already been done before.

I was working on my first Tornado project over the past week and I've found the documentation to be somewhat ... lacking. Learning the framework requires one to Google a lot - and the information related to Tornado is spread out across many different locations. So far I've found useful information in i) tornadoweb.org ii) googling this Group iii) reading the source code, iv) comments in the source code v) the github wiki (for links to async db drivers) vi) random blogs around the web and I just recently found out about vii) Ben's Tornado Production Skeleton project on Github.

This is terribly confusing for a beginner such as myself. Anyway, I'm emailing to say that I've got time on my hands (3 month summer break!), and I won't mind collating, writing and uploading documentation for Tornado - perhaps to a Wiki, or whatever system (Sphinx?) you'd like to use.

Would there be a place for such an effort?

Regards,

Eli

[Ben Darnell]

Yes, absolutely.  The website as it currently exists was never really intended to be more than an overview, with the docstrings (and to a lesser extent the source code) as the "real" docs.  I've been meaning to set up sphinx or something to at least get the docstrings visible online (without clicking through the source on github), but haven't gotten around to it.  Contributions of improved documentation are always welcome.

-Ben

[Eli James]

@Ben: I've sent you an email. :) 

By the way: anyone here have any other links that you think I should look at? I've been doing extensive Googling over the past week, so I think I've seen most of the written material on Tornado out there by now, but I may have missed out on some.

-Eli

[Adil Khashtamov]

2011/5/8 Eli James <shado...@gmail.com>

@Ben: I've sent you an email. :) 

By the way: anyone here have any other links that you think I should look at? I've been doing extensive Googling over the past week, so I think I've seen most of the written material on Tornado out there by now, but I may have missed out on some.

-Eli

Take a look at http://golubenco.org/?p=16

--

Adil Khashtamov, http://khashtamov.kz/

skype: adilkhashtamov

[Didip Kerabat]

The community have been using http://tornadogists.org/ to consolidate all of our paste boards. If you need sample codes, that's a great place to search from.

- Didip -

[Eli James]

Thanks Didip! 

@Adil: Yeah I saw that; HN commenters say it's a little out-of-date. But will read all the same.

[Arek Bochinski]

FYI,
I wanted to login and the request failed with a  500 error. If the owner subscribes to this list, take a look at that Github login code and log.
It failed about 8:35am est if that helps in grepping the log.

[pivt]

For the poor engineer from China,

i)tornadoweb.org was always blocked by GFW

ii)This Group was often blocked by GFW

iii)Github was sometimes blocked by GFW

[Peter Bengtsson]

I'm here! I'll look into setting up email alerts on errors.