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

[SilentGhost]

Licence text shouldn't be touched, I think.

http://www.openssl.org/docs/apps/ciphers.html#CIPHER_LIST_FORMAT became https://www.openssl.org/docs/manmaster/apps/ciphers.html#CIPHER-LIST-FORMAT

If Martin still have the importer code somewhere, he probably could provide an up to date link.

[vadmium]

The bug tracker importer still exists if you know what revision to look it up in: <http://svn.python.org/view/tracker/importer/?pathrev=88980\>

[python-dev]

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

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

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

[SilentGhost]

Serhiy, the OpenSSL links are now https

[serhiy-storchaka]

Fixed links to "A Byte of Python" and OpenSSL.

Not fixed dead links:

http://www.zope.com/
http://www.pythonlabs.com/logos.html (http://www.pythonlabs.com/ exists but is not too useful)
http://www.vex.net/parnassus/ (looks as this project is dead)
http://ontosys.com/xml-rpc/extensions.php (sad, this was a specification)
http://svn.python.org/view/tracker/importer/ (removed in r88981 and not moved to https://hg.python.org/tracker)

[serhiy-storchaka]

Serhiy, the OpenSSL links are now https

They works with http.

Some links (including python.org) are now redirected from http to https. It may be worth to add https explicitly.

[serhiy-storchaka]

For XML-RPC extensions we can use a web archive: https://web.archive.org/web/20130120074804/http://ontosys.com/xml-rpc/extensions.php. There are precedences of using it for other dead links.

Opened separate bpo-26736 for https-zation.

[python-dev]

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

[serhiy-storchaka]

XML-RPC link was fixed in bpo-26889 (using the a web archive).

Left links are http://www.zope.com/, http://www.pythonlabs.com/logos.html, and links to dead projects. What can we do with Zope and PythonLabs links?

[orsenthil]

zope should be http://www.zope.org/
The pythonlabs link could be removed.
The logos at pythonlabs link does not exist. Reference for pythonlab exists in a humorous form here: http://www.pythonlabs.com/

[SilentGhost]

Does it not matter that the link to pythonlabs is a part of the official license text? Besides, it's not an actual html a tag, but rather a verbatim text, surely the only correction here is to make sure that the linkcheck doesn't check links within pre, code and similar tags.

[serhiy-storchaka]

zope should be http://www.zope.org/

Isn't this is a different legal entity?

[orsenthil]

On Mon, May 16, 2016 at 08:40:51PM +0000, Serhiy Storchaka wrote:

> zope should be http://www.zope.org/

Isn't this is a different legal entity?

Is it? I don't know. I can find no references to zope.com being
different than zope.org in my google searches and from wikipedia
article.

[matrixise]

maybe we can continue on this issue and close it asap.

what do you think ?

[serhiy-storchaka]

I think only lawyers or people related to the Zope Corporation and the BeOpen PythonLabs team can help with fixing the links to http://www.zope.com/ and http://www.pythonlabs.com/logos.html.

[warsaw]

Adding Jim Fulton (for Zope) and Guido (for Pythonlabs). I don't know who owns the former, but I'm fairly sure Guido owns the pythonlabs domain.

[gvanrossum]

www.pythonlabs.com still exists. (The www. is mandatory.) And zope.org also
still works.

On Jun 3, 2017 7:52 AM, "Barry A. Warsaw" <report@bugs.python.org> wrote:

Barry A. Warsaw added the comment:

Adding Jim Fulton (for Zope) and Guido (for Pythonlabs). I don't know who
owns the former, but I'm fairly sure Guido owns the pythonlabs domain.

----------
nosy: +gvanrossum, j1m

---

Python tracker <report@bugs.python.org>
<http://bugs.python.org/issue25910\>

---

[jimfulton]

Zope Corporation no longer exists. Any references to it should be in the past tense and without a link.

(The http://www.zope.org is for the Zope Foundation, which is a different thing.)

[serhiy-storchaka]

www.pythonlabs.com still exists. (The www. is mandatory.)

But http://www.pythonlabs.com/logos.html doesn't. And since this link is a part of the BeOpen.com license, changing it changes the license. I don't know whether this part of the license is valid if the referred resource no longer available.

[gvanrossum]

I can make the logos.html page appear. Just keep the link in the license as
it is.

On Jun 3, 2017 1:05 PM, "Sanyam Khurana" <report@bugs.python.org> wrote:

Changes by Sanyam Khurana <sanyam.khurana01@gmail.com>:

----------
pull_requests: +2010

---

Python tracker <report@bugs.python.org>
<http://bugs.python.org/issue25910\>

---

[gvanrossum]

I've done what I can for the logos: http://www.pythonlabs.com/logos.html

[serhiy-storchaka]

Thank you!

What is left:

• Rewrite the text of license.rst for referring the Zope Corporation in the past tense and remove the link (and maybe add the reference to the Zope Foundation if it is related).

• Mark historical links http://www.vex.net/parnassus/ and http://svn.python.org/view/tracker/importer/ as dead.

[gvanrossum]

I suggest the following replacement for that paragraph in Doc/license.txt, as well as in LICENSE:

In May 2000, Guido and the Python core development team moved to
BeOpen.com to form the BeOpen PythonLabs team. In October of the same
year, the PythonLabs team moved to Digital Creations, which became
Zope Corporation. In 2001, the Python Software Foundation (PSF, see
https://www.python.org/psf/) was formed, a non-profit organization
created specifically to own Python-related Intellectual Property.
Zope Corporation was a sponsoring member of the PSF.

[jimfulton]

+1

[Mariatta]

New changeset 8474d87 by Mariatta in branch 'master':
bpo-25910: Update LICENSE (GH-2873)
8474d87

[Mariatta]

New changeset f6306e7 by Mariatta in branch '3.5':
bpo-25910: Update LICENSE (GH-2873) (GH-2968)
f6306e7

[Mariatta]

New changeset b3c7d37 by Mariatta in branch '2.7':
bpo-25910: Update LICENSE (GH-2873) (GH-2969)
b3c7d37

[Mariatta]

New changeset 330cdac by Mariatta in branch '3.6':
bpo-25910: Update LICENSE (GH-2873) (GH-2967)
330cdac

[larryhastings]

New changeset 14167c9 by Larry Hastings (Mariatta) in branch '3.5':
bpo-25910: Update LICENSE (GH-2873) (GH-2968)
14167c9

[vstinner]

New changeset 1b4587a by Victor Stinner (Sanyam Khurana) in branch 'master':
bpo-25910: Fixes redirection from http to https (bpo-4674)
1b4587a

[vstinner]

New changeset 338cd83 by Victor Stinner (Sanyam Khurana) in branch 'master':
bpo-25910: Link redirections in docs (bpo-1933)
338cd83

[vstinner]

Can we now close this old issue?

[gvanrossum]

Who is Basti5611 (Schmehl Bastian), why do they have permission to change issue titles, and why did they change this issue title?

[CuriousLearner]

Victor, there is just one last thing to do in here.

All the links pointing to Github (that are build automatically) are permanently redirected from https://github.com/python/cpython/tree/master/* to https://github.com/python/cpython/blob/master/*

I will issue a separate PR for it, and then we're good to close this issue.

PS: Guido, I'm not sure about the title change either.

[vstinner]

"I will issue a separate PR for it, and then we're good to close this
issue."

Ok.

[bitdancer]

@guido: in roundup, by default anyone can change the issue title. I imagine he is a new user who just didn't understand that he was doing so. (And indeed, the account was created on 1/19).

[willingc]

A number of PRs have been merged since this issue opened in 2015. After Victor's merge of #46227 in January 2018, this looks ready to close. I'm going to close it.

If there are further links that need fixing as they sometimes fall out of date, please open a new issue with specific links needing updating. Thanks.