Documentation Wish List

High Priority Docs

• TurboGears intro and overview

• Update Diagrams

  • Big Picture
  • A journey of POST variables through filters, widget methods and validators

• An introduction on how to quickstart a project #1744

• Description of available quickstart templates (see also previous list item)

• Running TurboGears Applications as Unix Daemons, or How to use Linux init scripts - #172

  I prefer http://thraxil.org/users/anders/posts/2006/09/13/TurboGears-Deployment-with-supervisord-and-workingenv-py/ which I will be porting instead - KG (see also http://paddyland.serveblog.net/article/13)

• Speed optimization techniques (caching etc.) - 1.0/RoughDocs/Optimization

• How to use Visit framework - 1.0/RoughDocs/UsingVisitFramework

• Validator documentation: we should have a page that links to the original validator's package and gives an explanation of the new ones TG has implemented.

• Complete Using JavaScript / CSS Widgets - 1.0/WidgetsWithJSAndCSS

• Document root_variable_providers - #1097

• A "How to Report A Bug" (#1747) and a "How to Ask for Support" (#1748) document.

Other Doc Requests

• Mochikit tutorial for people with ''very little or no'' javascript experience

• WSGI vs LightTPD. Pros and Cons - #193

• Create a new api reference - #104

• Full examples on the scheduler module - #883

• How to migrate/upgrade the TurboTunes project,docs - #906

• How to use the RPC widget (turbogears/widgets/rpc.py)

• Comet decorator for TurboGears - http://blog.vgod.tw/?p=166

  This will not happen until it's done in such a way that people won't shoot themselves in the foot using it. --KG

• Captcha implementation

• Provide a comparison to other Python frameworks

• Generating non-html documents

• fastCGI deployment, - #1199

  See script attached to ticket. Needs test and writing a formal doc

• Document the correct way to handle session, flush and exceptions in SA sample code at #1185

• Complete reference docs for SQLObject

• How to install and use other template engines such as Cheetah and Jinja

• Adding robots.txt

• Non-trivial use of AjaxGrid

• A learning Guide for the light user (those who have no legacy background such as 'Apache/PHP', so they could run TG stand alone. The doc should address simple & understandable functionality.

• Proper Widgets reference documentation

  The toolbox widget browser feels incomplete and clumsy. It seldomly contains any descriptive text even to what actually a widget is supposed to do (and it's not obvious from the example), let alone what the parameters really mean. What use is a widgets library if it's not documented properly?

• Add a security section, in which to explain what are the best practices to write secure code, and to do secure deployments of web applications with TurboGears; for example, to have an idea of what I mean, take a look at this PHP website: http://phpsec.org/projects/

  Moreover, it would be nice to know what are the problems due to write insecure code and to do bad deployments, and it would be good to know how TurboGears is less liable of secure issues, compared to PHP, explaining what are the TurboGears solutions that permit that.

Other Documentation Tasks

Please see the documentation team's todo list.