Opened 15 years ago

Closed 15 years ago

Last modified 13 years ago

#12811 closed (fixed)

Tutorial 2 gets into templating details too early

Reported by: Brad Crittenden Owned by: Gabriel Hurley
Component: Documentation Version: 1.1
Severity: Keywords:
Cc: Triage Stage: Ready for checkin
Has patch: yes Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: no UI/UX: no

Description

At the very end of lesson two there is this suggestion:

"Edit the file, and you'll see it uses a template variable called app_list. That variable contains every installed Django app. Instead of using that, you can hard-code links to object-specific admin pages in whatever way you think is best."

At this point in the tutorial there has been no discussion of the template formatting language and it is unclear how one would go about completing the suggested task if he or she wanted to limit the apps to non-admin apps, for example. The means of 'hard coding' the links has not yet been addressed. Given that I think it is silly to even have this section in the tutorial.

Attachments (1)

12811_tutorial_patch.diff (1.6 KB ) - added by Gabriel Hurley 15 years ago.
Clarifies tutorial language and removes premature instructions on templating.

Download all attachments as: .zip

Change History (7)

comment:1 by Russell Keith-Magee, 15 years ago

milestone: 1.2
Triage Stage: UnreviewedAccepted

The section is still worth having -it points out that the admin can be very heavily customized. However, it should be rephrased so that newcomers don't get bogged down in the templating details they may not understand. Something along the lines of "You'll see a reference to {% for app in app_list %} - this is Django's way of iterating over the available apps. We'll talk about the template language more in the next tutorial."

by Gabriel Hurley, 15 years ago

Attachment: 12811_tutorial_patch.diff added

Clarifies tutorial language and removes premature instructions on templating.

comment:2 by Gabriel Hurley, 15 years ago

Has patch: set
Owner: changed from nobody to Gabriel Hurley
Status: newassigned
Summary: Tutorial suggestion at the end of lesson 2 is inappropriateTutorial 2 gets into templating details too early

Add a patch that clarifies tutorial language and removes premature instructions on templating. It's based on the verbiage given by Russell above. Thanks Russ!

comment:3 by Tim Graham, 15 years ago

Triage Stage: AcceptedReady for checkin

comment:4 by Russell Keith-Magee, 15 years ago

Resolution: fixed
Status: assignedclosed

(In [12710]) Fixed #12811 -- Modified Tutorial 2 to indicate that the templating language will be covered later. Thanks to bac for the suggestion, and Gabriel Hurley for the draft text.

comment:5 by Russell Keith-Magee, 15 years ago

(In [12713]) [1.1.X] Fixed #12811 -- Modified Tutorial 2 to indicate that the templating language will be covered later. Thanks to bac for the suggestion, and Gabriel Hurley for the draft text.

Backport of r12710 from trunk.

comment:6 by Jacob, 13 years ago

milestone: 1.2

Milestone 1.2 deleted

Note: See TracTickets for help on using tickets.
Back to Top