Opened 5 years ago

Closed 4 years ago

#17385 closed New feature (fixed)

Make sure the documentation search version field honor the browsed version.

Reported by: charettes Owned by: nobody
Component: * Version:
Severity: Normal Keywords: search documentation version
Cc: Triage Stage: Accepted
Has patch: no Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: no UI/UX: no


It can get a bit confusing/frustrating to users browsing the documentation for a specific version (say 1.1) to keep switching the search version to the one they're browsing.

I've been bitten by this quite a few times when maintaining a 1.2.X app and I've helped some people on #django irc who we're a bit confused about that.

Change History (5)

comment:1 Changed 5 years ago by aaugustin

  • Needs documentation unset
  • Needs tests unset
  • Patch needs improvement unset
  • Triage Stage changed from Unreviewed to Accepted

comment:2 Changed 5 years ago by jezdez

  • Resolution set to fixed
  • Status changed from new to closed

comment:3 Changed 5 years ago by jezdez

  • Resolution fixed deleted
  • Status changed from closed to reopened

comment:4 Changed 4 years ago by anonymous

Google seems to prefer the /dev version of the documentation. It should prefer the latest stable version.

Suggestion (using a cookie, e.g. "document_version"):

  • Default to latest stable if no "document_version" cookie — This should keep the latest stable as Google's preferred version
  • If visitor manually selects a different documentation version, set "document_version=X" cookie as a user's preference
  • If visitor loads a page which is not the version they have manually set through the "document_version" cookie, redirect them to desired version using JavaScript

comment:5 Changed 4 years ago by aaugustin

  • Resolution set to fixed
  • Status changed from reopened to closed

Fixed in 82d1ff051b51561806ed027b92619e64af50bebe.

The fix addresses the original problem ie. the search field. I haven't followed the anonymous suggestion.

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