classification
Title: Out of date links in the sidebar of the documentation index of versions 3.1 and 3.2
Type: Stage:
Components: Documentation Versions: Python 3.1, Python 3.2
process
Status: open Resolution:
Dependencies: Superseder:
Assigned To: docs@python Nosy List: docs@python, ezio.melotti, georg.brandl, pitrou, sandro.tosi, smarnach, terry.reedy
Priority: normal Keywords:

Created on 2011-10-07 15:02 by smarnach, last changed 2012-01-16 09:17 by terry.reedy.

Messages (12)
msg145084 - (view) Author: Sven Marnach (smarnach) Date: 2011-10-07 15:02
The sidebar on http://docs.python.org/release/3.1.3/ names 3.2 as the development version of Python, while the link points to 3.3.  The sidebar on http://docs.python.org/py3k/ links to 3.1 as the "stable version" -- obviously a relict from the time when 3.2 was in development.  (This could be fixed in Doc/tools/sphinxext/indexsidebar.html of the respective branches.)
msg145148 - (view) Author: Ezio Melotti (ezio.melotti) * (Python committer) Date: 2011-10-07 21:59
AFAIK the doc for 3.1 is not rebuilt anymore, so even if it's fixed, the change won't have any visible effect -- unless someone manually triggers a rebuild.
Regarding the 3.1 link on the py3k page: I think 'stable' still applies, even if it only receives security fixes.
msg145154 - (view) Author: Terry J. Reedy (terry.reedy) * (Python committer) Date: 2011-10-08 02:04
I disagree about 3.2 not being 'stable'. With more bugs fixes, it should be more stable. People should be encouraged to download 3.2. 2.7 came out 8 months before, and that should be updated (and again when 3.3 comes out).
msg145162 - (view) Author: Georg Brandl (georg.brandl) * (Python committer) Date: 2011-10-08 07:38
Nobody said 3.2 was not stable...
msg150862 - (view) Author: Sandro Tosi (sandro.tosi) * (Python committer) Date: 2012-01-08 12:03
Hi all, how can we fix it? or better, should we fix it? From a user POV, it is a weird to see 3.1 doc referring to 3.2 doc as "in development" then clicking on that link, being redirect to 3.3a0 doc and see there that 3.2 is stable (with no reference back to 3.1).

Maybe we can adjust the sidebar in 3.1 references and do a manual rebuild or just wait for another security release? maybe we can discuss a policy for such things and write it in stone (aka devguide).
msg150904 - (view) Author: Terry J. Reedy (terry.reedy) * (Python committer) Date: 2012-01-08 21:11
http://docs.python.org/release/2.6.7/
has the same problem that the 3.x 'in development' version is called 3.2, while there is no link to current stable 3.2.2 except indirectly by going to 'old versions' (which perhaps should be 'other versions'). I do not know enough about frames to know how to future-proof the sidebar better.
msg150905 - (view) Author: Antoine Pitrou (pitrou) * (Python committer) Date: 2012-01-08 21:14
> Nobody said 3.2 was not stable...

Well, the sidebar says it's in development while 2.7 is stable :)
msg150906 - (view) Author: Terry J. Reedy (terry.reedy) * (Python committer) Date: 2012-01-08 21:17
Well, actually I do have an idea. When 3.3 comes out, I think docs.python.org should point to that, and another url should point to the most recent 2.7.x release. The url for all versions is already stable. Then the sidebar could have entries for most recent 3.x and 2.x releases (without specifying) and other versions.
msg150907 - (view) Author: Terry J. Reedy (terry.reedy) * (Python committer) Date: 2012-01-08 21:28
My specific suggestion is that the sidebar be time-independent (for at least a decade, until Python 4 ;-) and say

Docs for other versions
  Current Python 3
  Current Python 2
  In development
  Everything else

with stable links for each.
msg150909 - (view) Author: Georg Brandl (georg.brandl) * (Python committer) Date: 2012-01-08 21:32
Sounds good.
msg150911 - (view) Author: Terry J. Reedy (terry.reedy) * (Python committer) Date: 2012-01-08 21:41
To make my idea work both now and after we switch docs.python.org, that url should not be used as either of the first two links. Rather there should be a docs.python.org/py2k (or whatever) that is the permanent 'latest Python 2 release' docs link.
msg151345 - (view) Author: Terry J. Reedy (terry.reedy) * (Python committer) Date: 2012-01-16 09:17
'All Releases' rather than 'Everything else' is both more accurate and to me, more graceful.
History
Date User Action Args
2012-01-16 09:17:54terry.reedysetmessages: + msg151345
2012-01-16 05:45:50eric.araujolinkissue13791 superseder
2012-01-08 21:41:41terry.reedysetmessages: + msg150911
2012-01-08 21:32:47georg.brandlsetmessages: + msg150909
2012-01-08 21:28:02terry.reedysetmessages: + msg150907
2012-01-08 21:17:46terry.reedysetmessages: + msg150906
2012-01-08 21:14:39pitrousetnosy: + pitrou
messages: + msg150905
2012-01-08 21:11:49terry.reedysetmessages: + msg150904
2012-01-08 12:03:19sandro.tosisetnosy: + sandro.tosi
messages: + msg150862
2011-10-08 07:38:06georg.brandlsetmessages: + msg145162
2011-10-08 02:04:37terry.reedysetnosy: + terry.reedy
messages: + msg145154
2011-10-07 21:59:34ezio.melottisetnosy: + ezio.melotti
messages: + msg145148
2011-10-07 19:25:27ned.deilysetnosy: + georg.brandl
2011-10-07 15:02:19smarnachcreate