Opened 12 years ago

Closed 11 years ago

Last modified 11 years ago

#17048 closed New feature (fixed)

Add Docs for Guidelines for Upgrading an Existing Project's Django

Reported by: Donald Stufft Owned by: anonymous
Component: Documentation Version: dev
Severity: Normal Keywords: upgrading
Cc: timograham@… Triage Stage: Accepted
Has patch: yes Needs documentation: no
Needs tests: no Patch needs improvement: yes
Easy pickings: yes UI/UX: no

Description

A decent addition to the docs would be a short page about the general process to go about replacing a projects version of django with a new one.

It would include any concerns/considerations that a developer should look at when doing the upgrade. One such thing is that starting with python 2.7, Deprecation warnings are silenced by default (the thinking being that end users don't care about them). So when upgrading Django you should use something like python -Wall manage.py test or python -Wd manage.py test to check for any warnings.

Change History (10)

comment:1 by Carl Meyer, 12 years ago

Triage Stage: UnreviewedAccepted

We already have a note about running with -Wall on the testing page, but that's not a place someone upgrading is likely to look. I think a short "Django upgrade checklist" page would be a good addition to the docs.

comment:2 by Susan Tan, 11 years ago

Owner: changed from nobody to Susan Tan
Status: newassigned

comment:3 by anonymous, 11 years ago

I've attempted to resolve this ticket in my PR: https://github.com/django/django/pull/1012 Feel free to code review.

comment:4 by Tim Graham, 11 years ago

Has patch: set

comment:5 by Daniele Procida, 11 years ago

I have tentatively reserved this ticket for first-time committers who take part in the Don't be afraid to commit workshop at the DjangoCon Europe 2013 sprints on 18th and 19th May.

If you want to tackle this ticket before then, please don't let the fact that it's assigned to me stop you. Feel free to re-assign it to yourself and do whatever you like to it.

comment:6 by Daniele Procida, 11 years ago

Owner: changed from Susan Tan to Daniele Procida

comment:7 by crainbf@…, 11 years ago

Owner: changed from Daniele Procida to anonymous

comment:8 by Tim Graham, 11 years ago

Cc: timograham@… added
Patch needs improvement: set

Updated pull request (still needs some polish): https://github.com/django/django/pull/1173

comment:9 by Tim Graham <timograham@…>, 11 years ago

Resolution: fixed
Status: assignedclosed

In ef8a9bc7fafc394f2c413a6ad4057d67134d742b:

Fixed #17048 - Added docs for upgrading Django.

Thanks Donald Stufft for the suggestion and
Susan Tan and Brian Fabian Crain for the patch.

comment:10 by Tim Graham <timograham@…>, 11 years ago

In 1add64684cef6877bf0faeb4a205be6ae07fc98e:

[1.5.x] Fixed #17048 - Added docs for upgrading Django.

Thanks Donald Stufft for the suggestion and
Susan Tan and Brian Fabian Crain for the patch.

Backport of ef8a9bc7fa from master.

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