[Python-Dev] docs.python.org pointing to Python 3 by default?

Stefan Scherfke stefan at sofa-rockers.org
Tue May 22 09:08:25 CEST 2012


Am 2012-05-21 um 19:58 schrieb Éric Araujo:

> Le 21/05/2012 07:42, Georg Brandl a écrit :
>> What about:
>> 
>> * Canonical:
>> 
>> docs.python.org/2/
>> docs.python.org/3/
>> 
>> for latest versions of 2.x and 3.x
>> 
>> docs.python.org/2.7/ etc.
>> 
>> for latest minor versions
>> 
>> docs.python.org/dev/
>> 
>> for latest dev version.
> +1.
> 
> I’d be +1 to adding /stable but both 2.7 and 3.2 are stable at this time.
> 
>> * Redirected:
>> 
>> docs.python.org/  -->  either /2/ or /3/ or a "disambiguation page"
> Either sounds good, I’m in favor of redirecting to /2 for a few years
> still to preserve existing links and avoid the need to click on each page.
> 
>> docs.python.org/py3k/ -> /3/
> +1, the py3k name is not obvious for everyone.
> 
>> There is also /release/X.Y.Z for individual released versions, which
>> I don't want to change.
> The URIs should not change, but it seems a bit bad to me that for
> example the 2.7.1 docs don’t link to the latest 2.7 page and mention 2.6
> as stable version
> 
>> I also like Martin's idea of offering more links between individual
>> pages, not only the front-pages.
> +1
> 
> On a related note, we may want to find a way to make the version more
> prominent in the pages; I’ve seen beginners install Python 3 and use the
> Python 2 docs and fail at the first print 'Hello, world!' example.
> That’s why I support always having the version numbers in the URIs.
> 
> Cheers

I think this URL scheme looks most clean:

docs.python.org/   --> Points to recommended version(2 for now, 3 later)
docs.python.org/2/  --> Points to latest stable 2.x
docs.python.org/2.7/ 
docs.python.org/2.6/
...
docs.python.org/3/  --> Points to latest stable 3.x
docs.python.org/3.2/
...
docs.python.org/dev/  --> Points to dev version (e.g., 3.3)

Using something like docs.python.org/stable/ in books might not make sense if the book is about Python 3 and /stable/ points to Python 4 a few years later.

Imho, adding additional sub-domains also wouldn’t improve anything, but would add more clutter and confusion (what if somebody types "docs3.python.org/2/ ?)

A prominent CCS-box showing the current version and offering Links to other main versions would make it perfect (e.g. 2, 3 and dev for all versions, 3.x sub-releases only, if you are under docs.python.org/3/... and for 2.x accordingly).

Cheers,
Stefan


More information about the Python-Dev mailing list