[Python-checkins] peps: PEP for updating the URL layout on docs.python.org

[Chris Jerdonek]

On Sat, Oct 27, 2012 at 7:36 AM, nick.coghlan
<python-checkins at python.org> wrote:
> http://hg.python.org/peps/rev/c7ba002ca91d
> changeset:   4568:c7ba002ca91d
> user:        Nick Coghlan <ncoghlan at gmail.com>
> date:        Sun Oct 28 00:36:36 2012 +1000
> summary:
>   PEP for updating the URL layout on docs.python.org

> +* ``http://docs.python.org/x/*``
> +* ``http://docs.python.org/x.y/*``
> +* ``http://docs.python.org/release/x.y.z/*``
> +* ``http://docs.python.org/devguide``
> +
> +The ``/x/`` URLs mean "give me the latest documentation for this release
> +series``. Differences relative to previous versions in the release series
> +will be available through "version added" and "version changed" markers.
> +
> +The ``/x.y/`` URLs mean "give me the latest documentation for this release".

It might be worth clarifying what "latest" means for both the "x" and
"x.y" forms.  For example, should "http://docs.python.org/3/" today
link to the released 3.3.0 version, the in-progress 3.3.1 version, or
the in-progress 3.4.0?

For the "x" form, I think we mean the second because that is what it
points to today, i.e. the in-development version of the highest
released minor version of the major version "x".

There's a slight mismatch with how we're doing it today because
"http://docs.python.org/3/" shows 3.3.0 in the title even though it's
the in-progress 3.3.1.  The title should perhaps reflect that it's
post 3.3.0 (and similarly for the 2.7 and 3.2 pages).

--Chris