#20667 closed Cleanup/optimization (fixed)
Remove discussion of DEBUG from the tutorial
Reported by: | Owned by: | ||
---|---|---|---|
Component: | Documentation | Version: | dev |
Severity: | Normal | Keywords: | |
Cc: | timograham@… | Triage Stage: | Ready for checkin |
Has patch: | yes | Needs documentation: | no |
Needs tests: | no | Patch needs improvement: | no |
Easy pickings: | yes | UI/UX: | no |
Description
Hey,
Just finished reading tutorial 6 - one of the earlier tutorials alluded to switching the 'debug' flag to false, which I did - problematically, this stops automatic static file hosting on the development server! (I found this out by looking at the linked notes on static hosting, which were very good though.)
Would it be worth including a note about the setting of the debug flag in tutorial 6?
Cheers!
Attachments (1)
Change History (12)
follow-up: 2 comment:1 by , 11 years ago
comment:2 by , 11 years ago
Replying to timo:
I'd actually be more inclined to remove the mention of turning
DEBUG
toFalse
as that has caused other problems in the past, most notably withALLOWED_HOSTS
. Of course if we did that, we'd probably want to remove the sections about "Write a 404 (page not found) view" and "Write a 500 (server error) view". Not sure these topics really need to be mentioned in the tutorial though. Curious to hear other opinions.
I agree. These topics are out of place in the tutorial. Now that we have a deployment checklist (which already discusses ALLOWED_HOSTS
and DEBUG
anyway) I think it would make a lot more sense to move the discussion of writing 404 and 500 templates there, and don't change DEBUG
in the tutorial at all.
I think the tutorial should also link to the deployment checklist prominently in the "what to read next" page ("when you're ready to deploy this project for public use, here are the steps you'll need to think about").
comment:3 by , 11 years ago
+1 on Carl's plan.
The section about 404 and 500 templates that comes very early in the tutorial often confuses beginners.
comment:4 by , 11 years ago
Triage Stage: | Unreviewed → Accepted |
---|
comment:5 by , 11 years ago
Cc: | added |
---|---|
Has patch: | set |
Summary: | Tutorial 6: Note on debug flag → Remove discussion of DEBUG from the tutorial |
Type: | New feature → Cleanup/optimization |
Version: | 1.5 → master |
comment:6 by , 11 years ago
Owner: | changed from | to
---|---|
Status: | new → assigned |
comment:7 by , 11 years ago
Patch needs improvement: | set |
---|
+1 to remove the matching sections in the tutorial. However, in the checklist, I'd rather stress the usefulness of custom templates (404.html
, 500.html
) instead of custom views (which as stated are OK for 99% of cases).
by , 11 years ago
Attachment: | 20667.diff added |
---|
comment:8 by , 11 years ago
Patch needs improvement: | unset |
---|
comment:9 by , 11 years ago
Owner: | removed |
---|---|
Status: | assigned → new |
Triage Stage: | Accepted → Ready for checkin |
Great, thanks!
comment:10 by , 11 years ago
Owner: | set to |
---|---|
Resolution: | → fixed |
Status: | new → closed |
I'd actually be more inclined to remove the mention of turning
DEBUG
toFalse
as that has caused other problems in the past, most notably withALLOWED_HOSTS
. Of course if we did that, we'd probably want to remove the sections about "Write a 404 (page not found) view" and "Write a 500 (server error) view". Not sure these topics really need to be mentioned in the tutorial though. Curious to hear other opinions.