Opened 17 years ago
Closed 17 years ago
#7393 closed (wontfix)
0.96 documentation problems
Reported by: | Owned by: | nobody | |
---|---|---|---|
Component: | Documentation | Version: | 0.96 |
Severity: | Keywords: | ||
Cc: | Triage Stage: | Unreviewed | |
Has patch: | no | Needs documentation: | no |
Needs tests: | no | Patch needs improvement: | no |
Easy pickings: | no | UI/UX: | no |
Description
If the tutorial is followed to the letter, it will fail to create a working Django app. That's fairly severe, given that the tutorial is for first-time users who may have difficulty troubleshooting Django.
The tutorial doesn't explicitly state the need for:
- The creation of a 500.html file in the templates directory (the tutorial implies it is needed, but should explicitly say so).
- The creation of a detail.html file in the polls directory (I think; I'm still troubleshooting this myself!).
Also, at http://www.djangoproject.com/documentation/0.96/tutorial01/ , the code box under the heading 'The development server' includes the line
Django version 0.95, using settings 'mysite.settings'
... which doesn't seem correct for a tutorial on 0.96. Presumably it should be updated to match the latest version of 0.96.x, and should therefore read
Django version 0.96.2, using settings 'mysite.settings'
until/unless 0.96.3 comes out.
Change History (7)
comment:1 by , 17 years ago
comment:2 by , 17 years ago
Here's another problem with the 0.96 tutorial:
At http://www.djangoproject.com/documentation/0.96/tutorial01/ under 'If you’re interested, also run the following commands:' there is listed the command
python manage.py sqlinitialdata polls
Running this command produces
This action has been renamed. Try './manage.py sqlcustom polls'.
Presumably the relevant line in the tutorial should be updated to read,
python manage.py sqlcustom polls
comment:3 by , 17 years ago
Another one:
At http://www.djangoproject.com/documentation/0.96/tutorial02/ under 'Customize the admin form', the user is asked to add the following code:
class Admin: fields = ( (None, {'fields': ('pub_date', 'question')}), )
but isn't told which file to add it to. I added it to mysite/polls/models.py
but it didn't change the ordering of the pub_date
and question
fields' HTML representations in the admin interface, even after I restarted the development server and refreshed the browser.
Did I add it to the wrong file, or is something else at fault? Without explicit instructions, as a newbie it's hard to know.
comment:4 by , 17 years ago
Dang, Firefox has been autocompleting the "Your email or username" field of this Trac form for me with my email address. Again, please could I ask again that the first admin who stumbles across this ticket please remove my email address from it? Many thanks in advance; and I'll try not to submit it by accident again.
Sam
comment:5 by , 17 years ago
Okay, so the 'Customize the admin form' section should say, "replace the existing lines
class Admin: pass
in mysite/polls/models.py
with the lines
class Admin: fields = ( (None, {'fields': ('pub_date', 'question')}), )
"
This will stop dumb noobs (i.e. me) from just adding
class Admin: fields = ( (None, {'fields': ('pub_date', 'question')}), )
at the end of the file, where it does no good.
comment:6 by , 17 years ago
Other than these points, I have to say the tutorial is pretty good, and Django is a pleasure to use. I'm still having difficulty deploying it on Dreamhost, but that's another issue entirely.
comment:7 by , 17 years ago
Resolution: | → wontfix |
---|---|
Status: | new → closed |
Unfortunately, the only fixes that would actually be applied to 0.96 will be security updates.
Ah, I didn't expect that submission to make my email viewable/harvestable! Please could the first admin who looks at this remove it?
Many thanks,
Sam