Django

Code

Ticket #5195 (closed: fixed)

Opened 1 year ago

Last modified 1 year ago

Add multiple glaring warnings about doing SVN tutorial with Django 0.96

Reported by: ubernostrum Assigned to: jacob
Milestone: Component: Documentation
Version: SVN Keywords:
Cc: Triage Stage: Design decision needed
Has patch: 1 Needs documentation: 0
Needs tests: 0 Patch needs improvement: 1

Description

We've had at least five tickets opened by people who downloaded Django 0.96 and then tried to work through the SVN version of the tutorial, which caused 0.96 to blow up on the keyword argument max_length. Similarly, people pop up on IRC and complain that adding a __unicode__ method to their models has no effect.

Adding admonitions to the appropriate places would hopefully help with this.

Attachments

tutorial01.diff (2.3 kB) - added by ubernostrum on 08/17/07 11:53:56.
Tutorial adding admonitions about using old Django with SVN tutorial

Change History

08/17/07 11:53:56 changed by ubernostrum

  • attachment tutorial01.diff added.

Tutorial adding admonitions about using old Django with SVN tutorial

08/17/07 12:59:49 changed by http://daniel.hahler.de/

  • needs_better_patch changed.
  • needs_tests changed.
  • needs_docs changed.

Please replace "of of" with "of" (2 times).

08/17/07 13:00:13 changed by dAniel hAhler <django-bugs@thequod.de>

  • needs_better_patch set to 1.
  • has_patch set to 1.

08/17/07 20:14:15 changed by SmileyChris

  • stage changed from Unreviewed to Design decision needed.

08/17/07 22:54:50 changed by gwilson

Or maybe it's time we just release a new version?

08/17/07 22:59:43 changed by ubernostrum

New version's not ready, so constructive suggestions that don't involve a release would be welcome ;)

08/18/07 00:42:21 changed by Simon G. <dev@simon.net.nz>

This is a generic docs issue & not just the tutorials (although this is probably where people first encounter it) - there are plenty of tickets here that have been opened because people use the 0.97-pre docs instead of the one for their version. I would suggest that the best way to solve this would be to tweak the short notice on each doc page to point out that the user should choose the appropriate docs version to use. e.g.:

The current version of the docs has this prepended to each doc page on the site:

 This document is for Django's SVN release, which can be significantly different than previous releases. Get old docs here: 0.96, 0.95.

& change it to something like:

 This document is for Django's SVN release, which can be significantly different than previous releases. Please make sure to use the documentation version that matches the version of Django you are using. The docs for older versions are here: 0.96, 0.95.

Another idea would be to mention this in the obtaining/installing django pages.

08/18/07 14:12:43 changed by gwilson

This might just be one of those cases where no matter how many warnings we put up, it's not going to help the fact that people don't read.

We could maybe force people to choose a version, by having /documentation/ just be a listing of the different versions of documentation, something like http://www.postgresql.org/docs/.

Or what about making the latest released version be the default for showing at /documentation/. People using an SVN checkout would probably have less problems knowing where the correct documentation is.

08/18/07 20:14:22 changed by Simon G. <dev@simon.net.nz>

Here's another example: #5201, #5205 (clean_data should be cleaned_data).

08/18/07 20:16:07 changed by Simon G. <dev@simon.net.nz>

Sorry, that should be #5205, #5021, and #4927

08/25/07 13:43:32 changed by adrian

  • status changed from new to closed.
  • resolution set to fixed.

(In [6006]) Fixed #5195 -- Added notes to docs/tutorial01.txt about max_length and unicode() changes and 0.96 vs. development version. Thanks, ubernostrum


Add/Change #5195 (Add multiple glaring warnings about doing SVN tutorial with Django 0.96)




Change Properties
Action