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 #1737 (closed task: fixed)

Opened 11 years ago

Last modified 9 years ago

Review "1.0/CreatingBigApplications"

Reported by: randomandy Owned by: Chris Arndt
Priority: normal Milestone: 1.0.x bugfix
Component: Documentation Version: 1.0
Severity: normal Keywords: doc review
Cc:

Description

In an attempt to streamline TG Getting Started, I pulled out a portion that wasn't really needed to get started pertaining to breaking the controller apart into separate subclasses and I put it on its  own page.

This is almost entirely a cut an paste, so the material is not new. It is merely moved into a separate document. The only changes from this portion of the  previous Getting Started were to add a link to another pre-existing doc  Creating Big Applications.

The discussion on the contents of this document may be less of a priority than discussing where this topic should be placed. I am not convinced it really belongs in Getting Started. I haven't yet formed an opinion on where is should go though.

Change History

comment:1 Changed 11 years ago by randomandy

03/06/08 11:00:00 changed by Chris Arndt copied from Ticket 1734

Some remarks on part two:

1) Quote: "In a small application, one module of controllers is all you need. In a larger application, you will likely want to break up your application into separate packages."

Then you go on to show how to split the app into several controller classes not modules. This is confusing. Maybe put the first two paragraphs in the last ("Builing Even Larger") section. Then insert a new introductory paragraph.

2) The page title does not really describe the content of this page properly. Subdividing what? You only handle splitting up into several controllers.

3) "Building Even Larger" - Please use more descriptive section titles.

4) The default method signature has *args and kwgars but the concept of default arguments and getting arguments through URLs has not been explained yet (applies also to part one). Maybe just leave this out for now?

comment:2 Changed 11 years ago by randomandy

After reading a bit closer, I decided to discard this document and just merge it into  Creating Big Applications where it makes more sense in context anyway - addressing Arndt remark #1.

The first section on splitting into sub classes is probably needed a lot sooner than the rest of the document, but I linked to it from the Getting Started page, so hopefully that will get readers there soon enough while not forcing them into it unnecessarily.

Remark #4: Aren't these needed to really serve as a catch all? Otherwise, something like http://domain.com:8080/bogus/argument/path will result not in the default page but with a server error.

comment:3 Changed 11 years ago by Chris Arndt

 Creating Big Applications need s more work, before it can be marked offical:

  • Section "Dividing the Controller into Separate Classes" needs an introduction.
  • In section "Splitting the Controller" and "Splitting the Model" the explanation about Python packages should come first and then how turn controllers/model into packages with the tgbig qs template and then manually.
  • A section about having subdirectories in the templates package is missing.

Remark #4 is now obsolete, since this document is independent from the GettingStarted? guide.

comment:4 Changed 11 years ago by Chris Arndt

  • Summary changed from Review "1.0/RoughDocs/GettingStartedPart2 to Review "1.0/CreatingBigApplications"

Changed ticket title to reflect moving of document.

comment:5 Changed 11 years ago by Chris Arndt

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

Changes to CreatingBigApplications:

  • Added introduction to and expanded "Dividing controllers..." section.
  • Re-structured section "Dividing the project into separate modules"
  • Added a section about template sub-directories.

I have now marked this doc as "Official" (doc revision 9).

comment:6 Changed 9 years ago by chrisz

  • Milestone changed from __unclassified__ to 1.0.x bugfix
Note: See TracTickets for help on using tickets.