Warning: Can't synchronize with repository "(default)" (Unsupported version control system "svn": No module named svn). Look in the Trac log for more information.

Ticket #2230 (closed task: fixed)

Opened 10 years ago

Last modified 10 years ago

Placeholder ticket for Documents to check and update

Reported by: jorge.vargas Owned by:
Priority: normal Milestone: 2.1 docs
Component: TurboGears Version: trunk
Severity: blocker Keywords:
Cc:

Description

I'll like us to use this ticket to list all documents that are outdated/typos/errors/etc. So we can correct them all on the sprint.

  1. review all discus comments (and update docs, delete comment)
  2. tgext.admin  http://groups.google.com/group/turbogears-docs/browse_thread/thread/a583a3929b63aa04

Change History

comment:1 Changed 10 years ago by chrisz

Missing docs:

  • "Everything a TG2 developer needs to know about WSGI"
  • "Everything a TG2 developer needs to know about Pylons"

comment:2 Changed 10 years ago by jorge.vargas

from discus

http://turbogears.org/2.0/docs/main/Auth/Authentication.html#comment-6442216
http://turbogears.org/2.0/docs/main/ToscaWidgets/forms.html
http://turbogears.org/2.0/docs/main/ToscaWidgets/Using.html#comment-6114010
http://turbogears.org/2.0/docs/main/ToscaWidgets/Cookbook/FlexiGrid.html#comment-5836805
http://www.turbogears.org/2.0/docs/main/Controllers.html#comment-6112126
http://www.turbogears.org/2.0/docs/main/Config.html#comment-5109317
http://www.turbogears.org/2.0/docs/modules/pylons/decorators_rest.html?highlight=rest%20decorators

comment:4 Changed 10 years ago by Kylotan

I would like to see  http://turbogears.org/2.0/docs/main/SQLAlchemy.html updated to include a bit more detail along the lines of what is found in  http://docs.turbogears.org/1.0/GettingStarted/DefineDatabase, specifically:

  • short summary of available column types, and common keyword parameters (eg. nullable, default)
  • example of creating one-to-many relation between tables (eg. extend the existing Movie example to show the relation between Director and Movie)
  • example of many-to-many relation (eg. extend the Movie example to show the relation between Movie and Actor)
  • very basic query examples
    • retrieving an object by primary key/id
    • retrieving a list of objects filtered by a simple predicate
    • retrieving associated objects in a one-to-many relationship via an implicit join
  • how to update an object (should be trivial, but still needs spelling out)
  • how to delete an object

All examples would ideally be in the declarative style if that is what is generally recommended.

comment:5 Changed 10 years ago by Kylotan

comment:6 Changed 10 years ago by mramm

  • Priority changed from highest to normal

comment:7 Changed 10 years ago by percious

  • Milestone changed from 2.1a1 to 2.1 docs

comment:8 Changed 10 years ago by jorge.vargas

  • Status changed from new to closed
  • Resolution set to fixed

This has now been moved to todo.rst in the docs repo  https://bitbucket.org/turbogears/tg-docs/

Note: See TracTickets for help on using tickets.