#33290 closed Cleanup/optimization (invalid)
Docs for versions in the extended support should indicate lack of support.
Reported by: | Roland Crosby | Owned by: | nobody |
---|---|---|---|
Component: | Documentation | Version: | 3.2 |
Severity: | Normal | Keywords: | |
Cc: | Triage Stage: | Unreviewed | |
Has patch: | no | Needs documentation: | no |
Needs tests: | no | Patch needs improvement: | no |
Easy pickings: | no | UI/UX: | no |
Description
I ended up on the Django 2.2 version of the "Writing your first Django app" tutorial via web search, and only realized I was looking at this version when I noticed it in the URL. I do see that the 1.8 version of these docs has an "unsupported version" banner at the top of the page; since 2.2 and 3.1 are out of the mainstream support period, it would be nice if these docs had some indication of that. (Probably fine to not have a "no mainstream support" indication on the reference docs pages, but might be good to at least have a warning like this on the tutorial/guides.)
Other projects have the same problem -- every time I search for Postgres docs the top-ranked result is inevitably for a version that stopped being supported in 2016 -- but the layout of the Django docs site, with the version mentioned deep in the sidebar and no indication that you're not looking at the current version, trips me up more frequently.
Change History (3)
comment:1 by , 3 years ago
Resolution: | → invalid |
---|---|
Status: | new → closed |
Type: | Uncategorized → Cleanup/optimization |
comment:2 by , 3 years ago
Summary: | Tutorial docs for non-current versions should indicate lack of support → Docs for versions in the extended support should indicate lack of support. |
---|
comment:3 by , 3 years ago
Ah sorry about that, didn't realize that "documentation" didn't cover the docs site itself! Thanks for the pointer.
Thanks for the ticket, however Django 2.2 and 3.1 are still supported. They are in the extended support and receive security fixes and data loss bugs fixes. I think there is no need to warn users about using them. Marking as "invalid" because this should be reported on djangoproject.com issue tracker.