Code

Opened 3 years ago

Closed 14 months ago

Last modified 14 months ago

#17048 closed New feature (fixed)

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

Reported by: dstufft Owned by: anonymous
Component: Documentation Version: master
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.

Attachments (0)

Change History (10)

comment:1 Changed 3 years ago by carljm

  • Needs documentation unset
  • Needs tests unset
  • Patch needs improvement unset
  • Triage Stage changed from Unreviewed to Accepted

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 Changed 16 months ago by susan

  • Owner changed from nobody to susan
  • Status changed from new to assigned

comment:3 Changed 15 months ago by anonymous

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

comment:4 Changed 15 months ago by timo

  • Has patch set

comment:5 Changed 14 months ago by EvilDMP

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 Changed 14 months ago by EvilDMP

  • Owner changed from susan to EvilDMP

comment:7 Changed 14 months ago by crainbf@…

  • Owner changed from EvilDMP to anonymous

comment:8 Changed 14 months ago by timo

  • Cc timograham@… added
  • Patch needs improvement set

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

comment:9 Changed 14 months ago by Tim Graham <timograham@…>

  • Resolution set to fixed
  • Status changed from assigned to closed

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 Changed 14 months ago by Tim Graham <timograham@…>

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.

Add Comment

Modify Ticket

Change Properties
<Author field>
Action
as closed
as The resolution will be set. Next status will be 'closed'
The resolution will be deleted. Next status will be 'new'
Author


E-mail address and user name can be saved in the Preferences.

 
Note: See TracTickets for help on using tickets.