Guide users to the newer package install instructions

[ncoghlan]

BPO	26014
Nosy	@ncoghlan, @ned-deily, @ezio-melotti
Files	issue26014.diff: patch for 2.7 were fixed for the first 2 issues

^{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 2016-06-06.00:46:07.408>
created_at = <Date 2016-01-05.13:04:25.951>
labels = ['type-feature', 'docs']
title = 'Guide users to the newer package install instructions'
updated_at = <Date 2016-06-06.00:46:07.359>
user = 'https://github.com/ncoghlan'

bugs.python.org fields:

activity = <Date 2016-06-06.00:46:07.359>
actor = 'ned.deily'
assignee = 'docs@python'
closed = True
closed_date = <Date 2016-06-06.00:46:07.408>
closer = 'ned.deily'
components = ['Documentation']
creation = <Date 2016-01-05.13:04:25.951>
creator = 'ncoghlan'
dependencies = []
files = ['42148']
hgrepos = []
issue_num = 26014
keywords = ['patch']
message_count = 4.0
messages = ['257529', '261652', '267494', '267496']
nosy_count = 6.0
nosy_names = ['ncoghlan', 'ned.deily', 'ezio.melotti', 'docs@python', 'python-dev', 'Susan Sun']
pr_nums = []
priority = 'normal'
resolution = 'fixed'
stage = 'resolved'
status = 'closed'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue26014'
versions = ['Python 2.7', 'Python 3.5', 'Python 3.6']

[ncoghlan]

The up to date module installation docs are at:

• https://docs.python.org/2/installing/index.html
• https://docs.python.org/3/installing/index.html

However, legacy deep links still resolve to the old docs:

• https://docs.python.org/2/install/index.html
• https://docs.python.org/3/install/index.html

Those link out to packaging.python.org, the link is buried in a longish note, rather than being highlighted as a more obvious See Also link.

The top level landing page in the Python 2.7 docs also still links to the legacy docs rather than the new ones, and the "(Legacy)" notation hasn't been appended to the headings on the legacy docs the way it has in 3.x.

There's a few long hanging fruit for cleanup here:

• add See Also links to the modern docs from the legacy docs
• append the (Legacy) suffix in the 2.x docs
• fix the 2.x top level docs page to link to the new docs rather than the legacy ones
• link to the legacy docs from the distutils package docs in 2.7 (as has already been done in 3.x)

[SusanSun]

Below two issues are fixed.

• add See Also links to the modern docs from the legacy docs
• append the (Legacy) suffix in the 2.x docs

[python-dev]

New changeset 71fc5b246f5b by Ned Deily in branch '2.7':
Issue bpo-26014: Guide 2.7 users to the new packaging documentation:
https://hg.python.org/cpython/rev/71fc5b246f5b

New changeset f5fd646b265b by Ned Deily in branch '3.5':
Issue bpo-26014: Update 3.x packaging documentation:
https://hg.python.org/cpython/rev/f5fd646b265b

New changeset 7583d65da2ad by Ned Deily in branch 'default':
Issue bpo-26014: merge from 3.5
https://hg.python.org/cpython/rev/7583d65da2ad

[ned-deily]

Thanks, Susan, for your suggested patch. I expanded on it to address all of the issues Nick brought up and then some, such as also updating to the changed setuptools doc link. Pushed for release in 2.7.12, 3.5.2, and 3.6.0.