Opened 10 years ago

Closed 10 years ago

Last modified 10 years ago

#22966 closed Bug (fixed)

Documentation on upgrading Django to a newer version should link to all release notes regardless of what version of the docs you view

Reported by: haimunt@… Owned by: nobody
Component: Documentation Version: 1.5
Severity: Normal Keywords: documentation, release notes, confusing
Cc: Triage Stage: Accepted
Has patch: yes Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: yes UI/UX: no

Description

Hi,
On the 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 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 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

Attachments (1)

22966.diff (424 bytes ) - added by Tim Graham 10 years ago.

Download all attachments as: .zip

Change History (8)

comment:1 by Tim Graham, 10 years ago

Has patch: set
Triage Stage: UnreviewedAccepted

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.

by Tim Graham, 10 years ago

Attachment: 22966.diff added

comment:2 by anonymous, 10 years ago

Thanks. Does that note appear in all older versions of the docs or just the latest?

comment:3 by Tim Graham, 10 years ago

I can backport it to older release, I just wanted to upload a patch first to make sure it looked okay to you.

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

Resolution: fixed
Status: newclosed

In e6b3d6c22f5c638b08f653bada4d51b47174852c:

Fixed #22966 -- Clarified which release notes appear for each doc version.

Thanks haimunt at yahoo.com for the suggestion.

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

In 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

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

In 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

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

In 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

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