#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: | 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)
Change History (8)
comment:1 by , 10 years ago
Has patch: | set |
---|---|
Triage Stage: | Unreviewed → Accepted |
by , 10 years ago
Attachment: | 22966.diff added |
---|
comment:2 by , 10 years ago
Thanks. Does that note appear in all older versions of the docs or just the latest?
comment:3 by , 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 , 10 years ago
Resolution: | → fixed |
---|---|
Status: | new → closed |
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.