[Django] #28349: Release notes should detail which version they're 'coming from' and LTS release notes should include/link all changes since previous LTS
Django
release notes should include/link all changes since previous LTS
-----------------------------------------+------------------------
Reporter: eduvik | Owner: nobody
Type: Uncategorized | Status: new
Component: Documentation | Version: 1.11
Severity: Normal | Keywords:
Triage Stage: Unreviewed | Has patch: 0
Needs documentation: 0 | Needs tests: 0
Patch needs improvement: 0 | Easy pickings: 1
UI/UX: 0 |
-----------------------------------------+------------------------
If I want to upgrade from the previous LTS (1.8) to the current (1.11)
(presumably a common upgrade path) and go to the release
notes/incompatible changes for 1.11
(https://docs.djangoproject.com/en/1.11/releases/1.11/#backwards-
incompatible-changes-in-1-11) then it doesn't specify which version the
changes are incompatible with. Firstly, (for LTS releases at least) it
would be good to say something like 'changes since version 1.10'.
Secondly, for LTS releases, it would be ideal to 'roll up' all backwards
incompatible changes (or even all changes) since the last LTS, or, failing
that, include links to all of the release notes since the previous LTS.
--
Ticket URL: <https://code.djangoproject.com/ticket/28349>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.
Django
--------------------------------------+------------------------------------
Reporter: eduvik | Owner: nobody
Type: Cleanup/optimization | Status: new
Component: Documentation | Version: 1.11
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0
Changes (by Tim Graham):
* type: Uncategorized => Cleanup/optimization
* stage: Unreviewed => Accepted
Comment:
The recommended way to upgrade from LTS to LTS is to upgrade one major
version at a time, e.g. 1.8.x -> 1.9.y -> 1.10.z -> 1.11.a. This could be
documented in `docs/howto/upgrade-version.txt`.
At the top of the release notes, it says something like "as well as some
backwards incompatible changes you’ll want to be aware of when upgrading
from Django 1.10 or older versions." I think it's fairly obvious that the
LTS release notes don't roll up all changes since the previous LTS. At
least, I haven't seen anyone else confused about that. The upgrade guide
has a link to the release notes index page, so I also don't see a need to
repeat links to the release notes for versions since the last LTS on the
release notes for an LTS.
--
Ticket URL: <https://code.djangoproject.com/ticket/28349#comment:1>
Django
--------------------------------------+------------------------------------
Type: Cleanup/optimization | Status: assigned
Component: Documentation | Version: 1.11
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0
Changes (by Emmanuel):
* owner: nobody => Emmanuel
* status: new => assigned
--
Ticket URL: <https://code.djangoproject.com/ticket/28349#comment:2>
Django
--------------------------------------+------------------------------------
Reporter: eduvik | Owner: Emmanuel
Type: Cleanup/optimization | Status: assigned
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0
Changes (by Tim Graham):
* has_patch: 0 => 1
Comment:
[https://github.com/django/django/pull/8751 PR]
--
Ticket URL: <https://code.djangoproject.com/ticket/28349#comment:3>
Django
--------------------------------------+------------------------------------
Reporter: eduvik | Owner: Emmanuel
Component: Documentation | Version: 1.11
Severity: Normal | Resolution: fixed
Keywords: | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0
Changes (by Tim Graham <timograham@…>):
* status: assigned => closed
* resolution: => fixed
Comment:
In [changeset:"27ef04bb5c3118e00d3eda4b3aa3201d18ea1785" 27ef04bb]:
{{{
#!CommitTicketReference repository=""
revision="27ef04bb5c3118e00d3eda4b3aa3201d18ea1785"
Fixed #28349 -- Doc'd how to upgrade Django from LTS to LTS.
}}}
--
Ticket URL: <https://code.djangoproject.com/ticket/28349#comment:4>
Django
--------------------------------------+------------------------------------
Reporter: eduvik | Owner: Emmanuel
Type: Cleanup/optimization | Status: closed
Severity: Normal | Resolution: fixed
Keywords: | Triage Stage: Accepted
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0
Comment (by Tim Graham <timograham@…>):
In [changeset:"b6620dee72dc44da45403ff663853bfd8421c63e" b6620de]:
{{{
#!CommitTicketReference repository=""
revision="b6620dee72dc44da45403ff663853bfd8421c63e"
[1.11.x] Fixed #28349 -- Doc'd how to upgrade Django from LTS to LTS.
Backport of 27ef04bb5c3118e00d3eda4b3aa3201d18ea1785 from master
}}}
--
Ticket URL: <https://code.djangoproject.com/ticket/28349#comment:5>
Django
--------------------------------------+------------------------------------
Reporter: eduvik | Owner: Emmanuel
Type: Cleanup/optimization | Status: closed
Severity: Normal | Resolution: fixed
Keywords: | Triage Stage: Accepted
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0
Comment (by Emmanuel):
The document was updated with the intruction to update django using pip -U
--
Ticket URL: <https://code.djangoproject.com/ticket/28349#comment:6>