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|
|Severity:||Normal||Keywords:||documentation, release notes, confusing|
|Has patch:||yes||Needs documentation:||no|
|Needs tests:||no||Patch needs improvement:||no|
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.
Change History (8)
comment:1 Changed 12 months ago by timo
- Has patch set
- Needs documentation unset
- Needs tests unset
- Patch needs improvement unset
- Triage Stage changed from Unreviewed to Accepted
Changed 12 months ago by timo
comment:4 Changed 12 months ago by Tim Graham <timograham@…>
- Resolution set to fixed
- Status changed from new to closed