[Django] #22966: Documentation on upgrading Django to a newer version should link to all release notes regardless of what version of the docs you view
Django
release notes regardless of what version of the docs you view
-------------------------+-------------------------------------------------
Reporter: | Owner: nobody
haimunt@… | Status: new
Type: Bug | Version: 1.5
Component: | Keywords: documentation, release notes,
Documentation | confusing
Severity: Normal | Has patch: 0
Triage Stage: | UI/UX: 0
Unreviewed |
Easy pickings: 1 |
-------------------------+-------------------------------------------------
Hi,
On the [https://docs.djangoproject.com/en/1.6/howto/upgrade-version/
Upgrading Django to a newer version] page, the link for the release notes
under Required Reading depends on which version of the docs you are
viewing. For example, if you are viewing the 1.5 docs, the link will take
you to the Django 1.5 version of that page. This is a feature, not a bug,
in most other cases. In this case however, going to the
[https://docs.djangoproject.com/en/1.5/releases/ Django 1.5 version of the
release notes] page gives you the false impression that no release notes
past 1.5 have been made available. The
[https://docs.djangoproject.com/en/dev/howto/upgrade-version/ dev version
of the release notes page] has all of the release notes (always).
Either the link for the release notes should always point to the dev
version of that page or there should be some text added to the top of each
release notes page telling people how to access ALL of the release notes.
It's a small issue, but it's very confusing and could be avoided with just
a small fix.
Thanks
--
Ticket URL: <https://code.djangoproject.com/ticket/22966>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.
Django
release notes regardless of what version of the docs you view
Reporter: haimunt@… | Owner: nobody
Type: Bug | Status: new
Component: Documentation | Version: 1.5
Severity: Normal | Resolution:
Keywords: documentation, | Triage Stage: Accepted
release notes, confusing | Needs documentation: 0
Has patch: 1 | Patch needs improvement: 0
Needs tests: 0 | UI/UX: 0
Easy pickings: 1 |
-------------------------------------+-------------------------------------
Changes (by timo):
* needs_better_patch: => 0
* has_patch: 0 => 1
* stage: Unreviewed => Accepted
* needs_tests: => 0
* needs_docs: => 0
Comment:
Linking to the development version of the docs would require an external
link which isn't ideal when building a local version of the docs, for
example, so I opted for a note.
--
Ticket URL: <https://code.djangoproject.com/ticket/22966#comment:1>
Django
release notes regardless of what version of the docs you view
Reporter: haimunt@… | Owner: nobody
Type: Bug | Status: new
Component: Documentation | Version: 1.5
Severity: Normal | Resolution:
Keywords: documentation, | Triage Stage: Accepted
release notes, confusing | Needs documentation: 0
Has patch: 1 | Patch needs improvement: 0
Needs tests: 0 | UI/UX: 0
Easy pickings: 1 |
-------------------------------------+-------------------------------------
Comment (by anonymous):
Thanks. Does that note appear in all older versions of the docs or just
the latest?
--
Ticket URL: <https://code.djangoproject.com/ticket/22966#comment:2>
Django
release notes regardless of what version of the docs you view
Reporter: haimunt@… | Owner: nobody
Type: Bug | Status: new
Component: Documentation | Version: 1.5
Severity: Normal | Resolution:
Keywords: documentation, | Triage Stage: Accepted
release notes, confusing | Needs documentation: 0
Has patch: 1 | Patch needs improvement: 0
Needs tests: 0 | UI/UX: 0
Easy pickings: 1 |
-------------------------------------+-------------------------------------
Comment (by timo):
I can backport it to older release, I just wanted to upload a patch first
to make sure it looked okay to you.
--
Ticket URL: <https://code.djangoproject.com/ticket/22966#comment:3>
Django
release notes regardless of what version of the docs you view
Reporter: haimunt@… | Owner: nobody
Component: Documentation | Version: 1.5
Severity: Normal | Resolution: fixed
Keywords: documentation, | Triage Stage: Accepted
release notes, confusing | Needs documentation: 0
Has patch: 1 | Patch needs improvement: 0
Needs tests: 0 | UI/UX: 0
Easy pickings: 1 |
-------------------------------------+-------------------------------------
* status: new => closed
* resolution: => fixed
Comment:
In [changeset:"e6b3d6c22f5c638b08f653bada4d51b47174852c"]:
{{{
#!CommitTicketReference repository=""
revision="e6b3d6c22f5c638b08f653bada4d51b47174852c"
Fixed #22966 -- Clarified which release notes appear for each doc version.
Thanks haimunt at yahoo.com for the suggestion.
}}}
--
Ticket URL: <https://code.djangoproject.com/ticket/22966#comment:4>
Django
release notes regardless of what version of the docs you view
Reporter: haimunt@… | Owner: nobody
Type: Bug | Status: closed
Component: Documentation | Version: 1.5
Severity: Normal | Resolution: fixed
Keywords: documentation, | Triage Stage: Accepted
release notes, confusing | Needs documentation: 0
Has patch: 1 | Patch needs improvement: 0
Needs tests: 0 | UI/UX: 0
Easy pickings: 1 |
-------------------------------------+-------------------------------------
Comment (by Tim Graham <timograham@…>):
In [changeset:"ddc715edd3e473a995f7f8a1b8277be33324641f"]:
{{{
#!CommitTicketReference repository=""
revision="ddc715edd3e473a995f7f8a1b8277be33324641f"
[1.5.x] Fixed #22966 -- Clarified which release notes appear for each doc
version.
Thanks haimunt at yahoo.com for the suggestion.
Backport of e6b3d6c22f from master
}}}
--
Ticket URL: <https://code.djangoproject.com/ticket/22966#comment:5>
Django
release notes regardless of what version of the docs you view
Reporter: haimunt@… | Owner: nobody
Type: Bug | Status: closed
Component: Documentation | Version: 1.5
Severity: Normal | Resolution: fixed
Keywords: documentation, | Triage Stage: Accepted
release notes, confusing | Needs documentation: 0
Has patch: 1 | Patch needs improvement: 0
Needs tests: 0 | UI/UX: 0
Easy pickings: 1 |
-------------------------------------+-------------------------------------
Comment (by Tim Graham <timograham@…>):
In [changeset:"85f9745807ea0042225aaf4472fb63a00f3e2bcc"]:
{{{
#!CommitTicketReference repository=""
revision="85f9745807ea0042225aaf4472fb63a00f3e2bcc"
[1.6.x] Fixed #22966 -- Clarified which release notes appear for each doc
version.
Thanks haimunt at yahoo.com for the suggestion.
Backport of e6b3d6c22f from master
}}}
--
Ticket URL: <https://code.djangoproject.com/ticket/22966#comment:6>
Django
release notes regardless of what version of the docs you view
Reporter: haimunt@… | Owner: nobody
Type: Bug | Status: closed
Component: Documentation | Version: 1.5
Severity: Normal | Resolution: fixed
Keywords: documentation, | Triage Stage: Accepted
release notes, confusing | Needs documentation: 0
Has patch: 1 | Patch needs improvement: 0
Needs tests: 0 | UI/UX: 0
Easy pickings: 1 |
-------------------------------------+-------------------------------------
Comment (by Tim Graham <timograham@…>):
In [changeset:"cf9e33f930be9032f68e12301e6d1f9f9d139f3c"]:
{{{
#!CommitTicketReference repository=""
revision="cf9e33f930be9032f68e12301e6d1f9f9d139f3c"
[1.7.x] Fixed #22966 -- Clarified which release notes appear for each doc
version.
Thanks haimunt at yahoo.com for the suggestion.
Backport of e6b3d6c22f from master
}}}
--
Ticket URL: <https://code.djangoproject.com/ticket/22966#comment:7>