Fixing links in documentation

[SilentGhost]

BPO	25910
Nosy	@gvanrossum, @tim-one, @warsaw, @birkenfeld, @orsenthil, @vstinner, @larryhastings, @bitdancer, @vadmium, @zware, @serhiy-storchaka, @matrixise, @willingc, @Mariatta, @CuriousLearner
PRs	bpo-25910: Link redirections in docs #1933 Update links in the documentation #2765 bpo-25910: Update LICENSE #2873 [3.6] bpo-25910: Update LICENSE (GH-2873) #2967 [3.5] bpo-25910: Update LICENSE (GH-2873) #2968 [2.7] bpo-25910: Update LICENSE (GH-2873) #2969 bpo-25910: Fixes redirection from http to https #4674
Files	linkcheck.diff output.txt: make linkcheck output after applying the patch

^{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 2018-03-10.23:41:26.215>
created_at = <Date 2015-12-19.13:09:03.795>
labels = ['3.7', 'docs']
title = 'Fixing links in documentation'
updated_at = <Date 2018-03-10.23:41:26.213>
user = 'https://bugs.python.org/SilentGhost'

bugs.python.org fields:

activity = <Date 2018-03-10.23:41:26.213>
actor = 'willingc'
assignee = 'docs@python'
closed = True
closed_date = <Date 2018-03-10.23:41:26.215>
closer = 'willingc'
components = ['Documentation']
creation = <Date 2015-12-19.13:09:03.795>
creator = 'SilentGhost'
dependencies = []
files = ['41361', '41362']
hgrepos = []
issue_num = 25910
keywords = ['patch', 'needs review']
message_count = 47.0
messages = ['256728', '260905', '260906', '260949', '260969', '260986', '263173', '263174', '263177', '263179', '263182', '263183', '263185', '263186', '263198', '263305', '265677', '265685', '265708', '265732', '265766', '270768', '295068', '295073', '295075', '295078', '295091', '295092', '295100', '295104', '295148', '295163', '295200', '295201', '299575', '299592', '299593', '299594', '299905', '307750', '310306', '310307', '310323', '310326', '310332', '310344', '313568']
nosy_count = 18.0
nosy_names = ['gvanrossum', 'tim.peters', 'barry', 'georg.brandl', 'orsenthil', 'vstinner', 'larry', 'r.david.murray', 'SilentGhost', 'docs@python', 'python-dev', 'martin.panter', 'zach.ware', 'serhiy.storchaka', 'matrixise', 'willingc', 'Mariatta', 'CuriousLearner']
pr_nums = ['1933', '2765', '2873', '2967', '2968', '2969', '4674']
priority = 'normal'
resolution = 'fixed'
stage = 'resolved'
status = 'closed'
superseder = None
type = None
url = 'https://bugs.python.org/issue25910'
versions = ['Python 3.7']

[SilentGhost]

I've run 'make linkcheck' on Doc and it highlighted a number of faulty links in documentation. I've tried fixing some of them and here is the resulting patch. It's a bit too long and touches many files, so to summarise:

• Most changes are http->https redirect (many from wikipedia and microsoft, but some from independent project)
• New domains, sometimes without redirect or any indication of how to find the same information.
• Completely new locations, only discoverable via search engine.
• Few dead links, that I removed.

I'm going to attach output.txt that is produced after running linkcheck with this patch applied, it is about three time smaller than the original one and has this types of issues:

• Dead links in licenses
• Internal redirects to versioned text
• Many python.org links in whatsnew/ that I don't know what to do about
• Spurious bad links

[python-dev]

New changeset ce5ef48b5140 by Georg Brandl in branch '3.5':
Closes bpo-25910: fix dead and permanently redirected links in the docs. Thanks to SilentGhost for the patch.
https://hg.python.org/cpython/rev/ce5ef48b5140

[birkenfeld]

Reopening, for fixing the rest of the broken ones.

[vadmium]

BTW it looks like the suspicious.csv file needs updating to compensate for this change:

http://buildbot.python.org/all/builders/Docs%203.5/builds/654/steps/suspicious/logs/stdio

WARNING: [using/unix:31] ":Packaging" found in "https://en.opensuse.org/Portal:Packaging"
WARNING: Found 1/297 unused rules:
using/unix,,:Packaging,http://en.opensuse.org/Portal:Packaging

[SilentGhost]

Perhaps, I'm misreading the log output, but it seems to me that it's Doc/tools/susp-ignored.csv that needs updating. Here is the attached patch.

[python-dev]

New changeset 8f8e86ea3abb by Georg Brandl in branch '3.5':
Update susp-ignore file (bpo-25910).
https://hg.python.org/cpython/rev/8f8e86ea3abb

[python-dev]

New changeset ce721df212cf by Serhiy Storchaka in branch '3.5':
Issue bpo-25910: Fixed dead links in the docs.
https://hg.python.org/cpython/rev/ce721df212cf

New changeset 14e00e7e4d51 by Georg Brandl in branch '2.7':
Closes bpo-25910: fix dead and permanently redirected links in the docs. Thanks to SilentGhost for the patch.
https://hg.python.org/cpython/rev/14e00e7e4d51

New changeset 00addbb47c5c by Serhiy Storchaka in branch '2.7':
Issue bpo-25910: Fixed dead links in the docs.
https://hg.python.org/cpython/rev/00addbb47c5c

New changeset 15c4557af8e0 by Serhiy Storchaka in branch 'default':
Issue bpo-25910: Fixed dead links in the docs.
https://hg.python.org/cpython/rev/15c4557af8e0

[serhiy-storchaka]

Following dead links left:

Doc/library/xmlrpc.client.rst
(line 42) broken http://ontosys.com/xml-rpc/extensions.php - <urlopen error timed out>

Doc/license.rst
(line 22) broken http://www.zope.com/ - <urlopen error [Errno -2] Name or service not known>
(line 131) broken http://www.pythonlabs.com/logos.html - HTTP Error 404: Not Found

Doc/using/windows.rst
(line 271) broken http://www.swaroopch.com/notes/python/#install_windows - Anchor 'install_windows' not found

Doc/whatsnew/2.1.rst
(line 543) broken http://www.vex.net/parnassus/ - HTTP Error 404: Not Found

Doc/whatsnew/2.6.rst
(line 174) broken http://svn.python.org/view/tracker/importer/ - HTTP Error 404: Not Found
(line 193) broken http://svn.python.org/view/tracker/importer/ - HTTP Error 404: Not Found

Doc/whatsnew/2.7.rst
(line 1529) broken http://www.openssl.org/docs/apps/ciphers.html#CIPHER_LIST_FORMAT - Anchor 'CIPHER_LIST_FORMAT' not found
(line 1618) broken http://www.openssl.org/docs/apps/ciphers.html#CIPHER_LIST_FORMAT - Anchor 'CIPHER_LIST_FORMAT' not found