Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

cache version selection for documentation #66466

Closed
jj mannequin opened this issue Aug 24, 2014 · 5 comments
Closed

cache version selection for documentation #66466

jj mannequin opened this issue Aug 24, 2014 · 5 comments
Labels
docs Documentation in the Doc dir type-feature A feature request or enhancement

Comments

@jj
Copy link
Mannequin

jj mannequin commented Aug 24, 2014

BPO 22270
Nosy @terryjreedy, @benjaminp

Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.

Show more details

GitHub fields:

assignee = None
closed_at = <Date 2014-08-29.19:52:21.113>
created_at = <Date 2014-08-24.23:33:46.566>
labels = ['type-feature', 'docs']
title = 'cache version selection for documentation'
updated_at = <Date 2014-08-29.19:52:21.110>
user = 'https://bugs.python.org/jj'

bugs.python.org fields:

activity = <Date 2014-08-29.19:52:21.110>
actor = 'terry.reedy'
assignee = 'docs@python'
closed = True
closed_date = <Date 2014-08-29.19:52:21.113>
closer = 'terry.reedy'
components = ['Documentation']
creation = <Date 2014-08-24.23:33:46.566>
creator = 'jj'
dependencies = []
files = []
hgrepos = []
issue_num = 22270
keywords = []
message_count = 5.0
messages = ['225847', '225849', '225850', '225851', '226070']
nosy_count = 4.0
nosy_names = ['terry.reedy', 'benjamin.peterson', 'docs@python', 'jj']
pr_nums = []
priority = 'normal'
resolution = 'rejected'
stage = 'needs patch'
status = 'closed'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue22270'
versions = ['Python 3.5']

@jj
Copy link
Mannequin Author

jj mannequin commented Aug 24, 2014

The Python version selection for the documentation should be cached.
It's very annoying having to select the preferred version each time one follows a link, e.g. search result, irc post, etc.

I'd like to see caching the preferred version in a cookie and automatically switching to this python version when opening doc pages.

@jj jj mannequin assigned docspython Aug 24, 2014
@jj jj mannequin added docs Documentation in the Doc dir type-feature A feature request or enhancement labels Aug 24, 2014
@benjaminp
Copy link
Contributor

I don't think that makes much sense. People often link to a particular version of the documentation and making the version "sticky" to a particular user could be confusing.

@jj
Copy link
Mannequin Author

jj mannequin commented Aug 24, 2014

it should rather be a opt-in feature. and when the redirection triggered, one should be able do click (you know it from wikipedia) back to page where one was redireced from.

@benjaminp
Copy link
Contributor

On Sun, Aug 24, 2014, at 16:39, Jonas Jelten wrote:

Jonas Jelten added the comment:

it should rather be a opt-in feature. and when the redirection triggered,
one should be able do click (you know it from wikipedia) back to page
where one was redireced from.

That would interact poorly with linking to particular sections with a #.

@terryjreedy
Copy link
Member

I agree that this is a bad idea.

  1. Cookies are generally a nuisance. I like the fact that docs.python.org is (apparently) cookie free and that python sites only use a few short-lived cookies. The complications you propose would be a nuisance to create and maintain.

  2. Not too long ago, we created docs.python.org/2/ and /3/ so people can use generic links to the latest docs for the latest released version of either Python 2 or 3. The aim was to reduce the problem of links to stale docs. Both sets of docs have version added notes for changes within a series. Those two docs are not interchangeable and should not be automatically switched.

If someone links now to a fixed version of the docs, they are either ignorant of the new system *or* they have a purpose that should not be over-riden.

If someone quotes or paraphrases a portion of a page (which is a claim about what the page says) or otherwise makes a claim about Python, and posts a link as evidence of the claim, clicking the link should take one to the 'evidence', not one's preferred version.

@ezio-melotti ezio-melotti transferred this issue from another repository Apr 10, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation in the Doc dir type-feature A feature request or enhancement
Projects
None yet
Development

No branches or pull requests

2 participants