bpo-25910: Link redirections in docs by CuriousLearner · Pull Request #1933 · python/cpython

CuriousLearner · 2017-06-03T18:37:38Z

This is a Work in Progress PR to address link fixes in documentation.

I intend to address url redirection issues in this PR.

Please let me know what changes are needed in this. Thanks!

https://bugs.python.org/issue25910

mention-bot · 2017-06-03T18:37:41Z

@CuriousLearner, thanks for your PR! By analyzing the history of the files in this pull request, we identified @birkenfeld, @serhiy-storchaka, @ncoghlan and @tiran to be potential reviewers.

serhiy-storchaka

I have doubts about most of changes. Links shouldn't contain language or version specific parts or expose implementation details of a site if the original link is working.

Replacing "http" with "https" LGTM. Removing "/en/latest/" LGTM.

serhiy-storchaka · 2017-06-03T19:48:14Z

Doc/faq/extending.rst

 <http://cxx.sourceforge.net/>`_ `Boost
-<http://www.boost.org/libs/python/doc/index.html>`_, or `Weave
-<https://scipy.github.io/devdocs/tutorial/weave.html>`_ are also
+<http://www.boost.org/doc/libs/1_64_0/libs/python/doc/html/index.html>`_, or


The redirection is changed regularly after releasing every new version of Boost. This FAQ is not specific to particular Boost version. The general version of the link should be used.

serhiy-storchaka · 2017-06-03T20:01:40Z

Doc/about.rst


 .. _reStructuredText: http://docutils.sourceforge.net/rst.html
-.. _Sphinx: http://sphinx-doc.org/
+.. _Sphinx: http://www.sphinx-doc.org/en/stable/


This replaces language agnostic link with language specific link. If the resource has versions on other languages (or will have in future) and the redirection is based on user's preferences, this replacement is not valid.

www. is optional.

Yeah, indeed you're right about this. I've made the changes

serhiy-storchaka · 2017-06-03T20:06:48Z

Doc/faq/general.rst

 still like to know about all commercial use of Python, of course.

-See `the PSF license page <https://www.python.org/psf/license/>`_ to find further
+See `the PSF license page <https://docs.python.org/3/license.html>`_ to find further


Keep the original link.

serhiy-storchaka · 2017-06-03T20:09:49Z

Doc/faq/gui.rst

 ----

-Python bindings for `the FLTK toolkit <http://www.fltk.org>`_, a simple yet
+Python bindings for `the FLTK toolkit <http://www.fltk.org/index.php>`_, a simple yet


/index.php is an implementation detail. It just means that currently the site is implemented in PHP. After rewiting it on Python that link likely will become not valid.

But that is an issue in that website, not in this docs, isn’t it?
If the goal of the PR is to avoid redirects, and the fltk website currently redirects / to /whatever.implementiation.detail, the change here is correct?

CuriousLearner

Hi @serhiy-storchaka !

I've fixed the issues you mentioned.

CuriousLearner · 2017-06-04T08:26:24Z

Doc/about.rst


 .. _reStructuredText: http://docutils.sourceforge.net/rst.html
-.. _Sphinx: http://sphinx-doc.org/
+.. _Sphinx: http://www.sphinx-doc.org/en/stable/


Yeah, indeed you're right about this. I've made the changes

CuriousLearner · 2017-06-04T08:26:46Z

Doc/faq/extending.rst

 <http://cxx.sourceforge.net/>`_ `Boost
-<http://www.boost.org/libs/python/doc/index.html>`_, or `Weave
-<https://scipy.github.io/devdocs/tutorial/weave.html>`_ are also
+<http://www.boost.org/doc/libs/1_64_0/libs/python/doc/html/index.html>`_, or


serhiy-storchaka · 2017-06-04T11:48:42Z

Please fix all similar issues.

CuriousLearner · 2017-06-04T11:50:13Z

@serhiy-storchaka sure, on it.

CuriousLearner · 2017-06-04T11:52:18Z

@serhiy-storchaka in the linkchecker/output.txt there were many redirection to /latest urls. Should I remove those changes all together? since I've introduced some of them in this PR.

CuriousLearner · 2017-06-04T11:53:41Z

Doc/distributing/index.rst

  other Python users
 * the `Python Packaging Authority
-  <https://www.pypa.io/>`__ are the group of
+  <https://www.pypa.io/en/latest/>`__ are the group of


@serhiy-storchaka like here. should I remove these kind of changes?

Yes, remove.

serhiy-storchaka · 2017-06-04T12:04:43Z

If the web-server returns the HTTP code in the range 3XX except 301 (Moved Permanently) or 308 (Permanent Redirect), we should keep the original link. For www.pypa.io the code 302 (Found) is returned.

I think it is better to remove all additions of /en/latest/ if the stripped links are working.

CuriousLearner · 2017-06-05T10:53:13Z

Hi @serhiy-storchaka!

I've tried to resolve all the issues with redirection of links.

However I've a concern:
- 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/*

Should we fix these in this PR?

serhiy-storchaka · 2017-06-05T14:42:24Z

Should we fix these in this PR?

Not in this PR. If there are reasons for using */blob/* liinks, this should be made in a tool that automatically generates links.

serhiy-storchaka

I have reviewed a half of the PR. Please remove insignificant changes and changes with HTTP code 302. Make similar changes in the other half.

serhiy-storchaka · 2017-06-05T14:47:06Z

Doc/about.rst


 .. _reStructuredText: http://docutils.sourceforge.net/rst.html
-.. _Sphinx: http://sphinx-doc.org/
+.. _Sphinx: http://www.sphinx-doc.org


HTTP/1.1 302 Found

Keep the original link.

serhiy-storchaka · 2017-06-05T14:47:49Z

Doc/distributing/index.rst

  other Python users
 * the `Python Packaging Authority
-  <https://www.pypa.io/>`__ are the group of
+  <https://www.pypa.io/en/latest/>`__ are the group of


Yes, remove.

serhiy-storchaka · 2017-06-05T14:48:24Z

Doc/bugs.rst

 .. seealso::

-   `How to Report Bugs Effectively <http://www.chiark.greenend.org.uk/~sgtatham/bugs.html>`_
+   `How to Report Bugs Effectively <https://www.chiark.greenend.org.uk/~sgtatham/bugs.html>`_


serhiy-storchaka · 2017-06-05T14:48:47Z

Doc/distributing/index.rst


 .. _setuptools: https://setuptools.readthedocs.io/en/latest/
-.. _wheel: https://wheel.readthedocs.org
+.. _wheel: https://wheel.readthedocs.io/


serhiy-storchaka · 2017-06-05T14:49:37Z

Doc/distributing/index.rst

 recommended tools`_.

-.. _currently recommended tools: https://packaging.python.org/en/latest/current/#packaging-tool-recommendations
+.. _currently recommended tools: https://packaging.python.org/current/#packaging-tool-recommendations


Hum, it seems like the URL is now https://packaging.python.org/guides/tool-recommendations/#packaging-tool-recommendations ?

serhiy-storchaka · 2017-06-05T15:08:37Z

Doc/faq/programming.rst

 length, whether variable names are well-formed according to your coding
 standard, whether declared interfaces are fully implemented, and more.
-https://docs.pylint.org/ provides a full list of Pylint's features.
+https://pylint.readthedocs.io/ provides a full list of Pylint's features.


HTTP/1.1 302 FOUND

Keep the original link.

serhiy-storchaka · 2017-06-05T15:09:05Z

Doc/faq/programming.rst

    http://www.py2exe.org/

-Another tool is Anthony Tuininga's `cx_Freeze <http://cx-freeze.sourceforge.net/>`_.
+Another tool is Anthony Tuininga's `cx_Freeze <https://anthony-tuininga.github.io/cx_Freeze/>`_.


serhiy-storchaka · 2017-06-05T15:09:34Z

Doc/faq/windows.rst


-See http://cx-freeze.sourceforge.net/ for a distutils extension that allows you
-to create console and GUI executables from Python code.
+See https://anthony-tuininga.github.io/cx_Freeze/ for a distutils extension


serhiy-storchaka · 2017-06-05T15:10:10Z

Doc/faq/windows.rst

 Simply rename the downloaded file to have the .TGZ extension, and WinZip will be
 able to handle it.  (If your copy of WinZip doesn't, get a newer one from
-https://www.winzip.com.)
+http://www.winzip.com/.)


Insignificant change.

serhiy-storchaka · 2017-06-05T15:10:45Z

Doc/glossary.rst

   BDFL
      Benevolent Dictator For Life, a.k.a. `Guido van Rossum
-      <https://www.python.org/~guido/>`_, Python's creator.
+      <https://gvanrossum.github.io/>`_, Python's creator.


CuriousLearner · 2017-06-05T17:06:35Z

Hi @serhiy-storchaka I've done the changes. Also, for the other half, I've tried to do similar changes. Can you please have a look now?

CuriousLearner · 2017-06-13T10:52:35Z

@serhiy-storchaka Can you please take a look here once?

CuriousLearner · 2017-07-23T13:13:30Z

Hey @serhiy-storchaka ,

Just wanted to ping you to know if it would be possible for you to take a look here once.

Thanks :)

marco-buttu · 2017-07-25T13:42:35Z

@CuriousLearner and @serhiy-storchaka, does this pull request aim to fix only link redirections, as the title says? Because in your first message you wrote: "This is a Work in Progress PR to address link fixes in documentation", and also bpo-25910 is focusing on Fixing links in documentation, so the goal is not clear to me. I am asking because if this PR wants to fix all documentation links, than we have to close #2765 .

vstinner · 2017-12-16T16:01:17Z

Doc/library/ssl.rst

@@ -869,7 +869,7 @@ Constants

   Whether the OpenSSL library has built-in support for *Next Protocol
   Negotiation* as described in the `NPN draft specification


The link label is now outdated.

vstinner · 2017-12-16T16:01:28Z

Doc/library/ssl.rst

   ordered by preference. The selection of a protocol will happen during the
   handshake, and will play out according to the `NPN draft specification
-   <https://tools.ietf.org/html/draft-agl-tls-nextprotoneg>`_. After a
+   <https://en.wikipedia.org/wiki/Application-Layer_Protocol_Negotiation >`_. After a


CuriousLearner · 2017-12-16T16:05:38Z

I've just run make linkcheck again to check more issues like this. I will update the PR once that is done. :)

vstinner · 2017-12-18T09:00:27Z

Doc/whatsnew/2.3.rst


 The idea of generators comes from other programming languages, especially Icon
-(https://www.cs.arizona.edu/icon/), where the idea of generators is central.  In
+(https://www2.cs.arizona.edu/icon/), where the idea of generators is central.  In


Please keep the original link. While it's currently a redirection to https://www2.cs.arizona.edu/icon/ we can still find https://www.cs.arizona.edu/icon/ on the site itself, but also on Wikipedia.

jdufresne · 2018-01-06T15:50:59Z

I found the following *.readthedocs.org links that still exist that should probably be changed to *.readthedocs.io:

./Doc/library/ast.rst:264:    `Green Tree Snakes <https://greentreesnakes.readthedocs.org/>`_, an external documentation resource, has good
./Doc/library/unittest.mock-examples.rst:1254:<https://pyhamcrest.readthedocs.org/>`_ provides similar functionality,
./Doc/whatsnew/2.5.rst:333:   https://pylib.readthedocs.org/

I suggest this based on the fact that:

*.readthedocs.org links redirect to *.readthedocs.io (can save a redirect)
*.readthedocs.io is preferred by Read the docs for cookie security concerns

For additional details, see:

https://blog.readthedocs.com/securing-subdomains/

Starting today, Read the Docs will start hosting projects from subdomains on the domain readthedocs.io, instead of on readthedocs.org. This change addresses some security concerns around site cookies while hosting user generated data on the same domain as our dashboard.

jdufresne · 2018-01-06T18:07:38Z

I also found the following links that should be updated to use https.

./Doc/library/string.rst:666:`flufl.i18n <http://flufli18n.readthedocs.io/en/latest/>`_ package.
./Doc/library/smtpd.rst:18:    The `aiosmtpd <http://aiosmtpd.readthedocs.io/>`_ package is a recommended
./Doc/using/mac.rst:69::program:`Gvim` (http://macvim-dev.github.io/macvim/) and :program:`Aquamacs`

CuriousLearner · 2018-01-07T18:55:03Z

Thanks for your inputs @jdufresne . I've fixed those things in 3cd462

@vstinner I'm not sure about this change:

faq/general.rst:56: [redirected permanently] https://www.python.org/psf/license/ to https://docs.python.org/3/license.html

Apart from that, there are several redirection from https://packaging.python.org/installing/ to https://packaging.python.org/tutorials/installing-packages/ Should they be also fixed?

Note: I've left the redirections for Github links; for which I'll file a separate PR.

vstinner

It's not good yet. But this time, I added "ok" comment on each correct change. So the next review should be quicker for me.

FYI I copied/pasted each time manually to open them in Firefox, it took me "forever" to check all these links...

vstinner · 2018-01-18T21:21:27Z

Doc/distributing/index.rst

 recommended tools`_.

-.. _currently recommended tools: https://packaging.python.org/en/latest/current/#packaging-tool-recommendations
+.. _currently recommended tools: https://packaging.python.org/guides/tool-recommendations/#packaging-tool-recommendations


vstinner · 2018-01-18T21:21:48Z

Doc/distributing/index.rst


 .. _Project structure: \
-   https://packaging.python.org/en/latest/distributing/
+    https://packaging.python.org/tutorials/distributing-packages/


vstinner · 2018-01-18T21:22:02Z

Doc/distributing/index.rst

+    https://packaging.python.org/tutorials/distributing-packages/
 .. _Building and packaging the project: \
-   https://packaging.python.org/en/latest/distributing/#packaging-your-project
+   https://packaging.python.org/tutorials/distributing-packages/#packaging-your-project


vstinner · 2018-01-18T21:23:04Z

Doc/distributing/index.rst

+   https://packaging.python.org/tutorials/distributing-packages/#packaging-your-project
 .. _Uploading the project to the Python Packaging Index: \
-   https://packaging.python.org/en/latest/distributing/#uploading-your-project-to-pypi
+   https://packaging.python.org/tutorials/distributing-packages/#uploading-your-project-to-pypi


vstinner · 2018-01-18T21:23:21Z

Doc/distributing/index.rst


   `Python Packaging User Guide: Binary Extensions
-   <https://packaging.python.org/en/latest/extensions>`__
+   <https://packaging.python.org/guides/packaging-binary-extensions/>`__


vstinner · 2018-01-18T22:00:51Z

Doc/whatsnew/2.5.rst

      PEP written by Aahz; implemented by Thomas Wouters.

-   https://pylib.readthedocs.org/
+   https://pylib.readthedocs.io/


vstinner · 2018-01-18T22:01:12Z

Doc/whatsnew/2.6.rst


 Hosting of the Python bug tracker is kindly provided by
-`Upfront Systems <http://www.upfrontsystems.co.za/>`__
+`Upfront Systems <http://www.upfrontsoftware.co.za>`__


vstinner · 2018-01-18T22:01:56Z

Doc/whatsnew/2.7.rst

  to be allowed; the format of the string is described
  `in the OpenSSL documentation
-  <https://www.openssl.org/docs/apps/ciphers.html#CIPHER-LIST-FORMAT>`__.
+  <https://www.openssl.org/docs/manmaster/man1/ciphers.html#CIPHER-LIST-FORMAT>`__.


vstinner · 2018-01-18T22:02:13Z

Doc/whatsnew/3.2.rst

  argument.  The *ciphers* string lists the allowed encryption algorithms using
  the format described in the `OpenSSL documentation
-  <https://www.openssl.org/docs/apps/ciphers.html#CIPHER-LIST-FORMAT>`__.
+  <https://www.openssl.org/docs/manmaster/man1/ciphers.html#CIPHER-LIST-FORMAT>`__.


vstinner · 2018-01-18T22:02:26Z

Doc/whatsnew/3.6.rst

 a class variable and should not be set on instances of that class.
 (Contributed by Ivan Levkivskyi in `Github #280
-<https://github.com/python/typing/issues/280>`_.)
+<https://github.com/python/typing/pull/280>`_.)


CuriousLearner · 2018-01-19T17:17:23Z

Hey @vstinner

"FYI I copied/pasted each time manually to open them in Firefox, it took me "forever" to check all these links..."

I really appreciate all the efforts you've put in to review this PR. Thank a lot. I've addressed the reviews, and now I think it would take a lot less time to review.

Also, please see this query: #1933 (comment)

vstinner · 2018-01-20T00:23:08Z

@vstinner I'm not sure about this change: faq/general.rst:56: [redirected permanently] https://www.python.org/psf/license/ to https://docs.python.org/3/license.html

In case of doubt, do nothing. I see that you kept https://www.python.org/psf/license/ : good.

The author fixed issues reported by Serhiy

miss-islington · 2018-01-20T00:25:39Z

Thanks @CuriousLearner for the PR, and @vstinner for merging it 🌮🎉.. I'm working now to backport this PR to: 3.6.
🐍🍒⛏🤖

miss-islington · 2018-01-20T00:25:47Z

Sorry, @CuriousLearner and @vstinner, I could not cleanly backport this to 3.6 due to a conflict.
Please backport using cherry_picker on command line.
cherry_picker 338cd83c5dceaed785f5bf613e2122f871908e2a 3.6

vstinner · 2018-01-20T00:26:35Z

I don't think that it's worth it to backport this change to Python 3.6 (I missed the "need 3.6 backport" label when I merged this PR).

vstinner · 2018-01-20T00:34:30Z

I merged your PR @CuriousLearner, thanks.

CuriousLearner · 2018-01-20T16:09:00Z

Thanks a lot @vstinner :)

CuriousLearner added 3 commits June 3, 2017 17:30

bpo-25910: Fixes some redirection links in docs

26485fe

bpo-25910: Fixes more redirection links in docs

e013f38

Minor fixes to links

06fa4f3

the-knights-who-say-ni added the CLA signed label Jun 3, 2017

Mariatta changed the title ~~Fix issue25910: Link redirections in docs~~ bpo-25910: Link redirections in docs Jun 3, 2017

Mariatta added docs Documentation in the Doc dir needs backport to 3.5 labels Jun 3, 2017

serhiy-storchaka previously requested changes Jun 3, 2017

View reviewed changes

bpo-25910: Address review comments

1d99ca4

CuriousLearner commented Jun 4, 2017

View reviewed changes

CuriousLearner added 4 commits June 5, 2017 14:59

bpo-25910: Address review comments

0f96435

bpo-25910: Minor fix to gettext.rst doc

cc1b307

bpo-25910: Minor link fix in installing/index.rst doc

bf9d3f8

bpo-25910: Fixes redirection issues in whatsnew/* doc

92f023f

serhiy-storchaka reviewed Jun 5, 2017

View reviewed changes

bpo-25910: Address review commits for url redirections

32b6617

bpo-25910: Minor fix for building docs succesfully

91060c3

Address review comments

3f6c78a

vstinner reviewed Dec 16, 2017

View reviewed changes

Update link label in ssl.rst docs

3f6344e

vstinner reviewed Dec 18, 2017

View reviewed changes

Address review comments

3cd462f

CuriousLearner added 2 commits January 8, 2018 00:27

Merge branch master; resolve conflicts

a021d33

Fix issues in ssl.rst docs

353d5bc

CuriousLearner force-pushed the fix-issue25910 branch from f3c2605 to 353d5bc Compare January 17, 2018 18:44

vstinner requested changes Jan 18, 2018

View reviewed changes

bpo-25910: Address review comments

ceb3581

vstinner added the skip news label Jan 20, 2018

vstinner approved these changes Jan 20, 2018

View reviewed changes

bedevere-bot added awaiting merge and removed awaiting changes labels Jan 20, 2018

vstinner merged commit 338cd83 into python:master Jan 20, 2018

bedevere-bot removed the awaiting merge label Jan 20, 2018

vstinner removed the needs backport to 3.6 label Jan 20, 2018

serhiy-storchaka removed their assignment Dec 6, 2018

		@@ -869,7 +869,7 @@ Constants

		Whether the OpenSSL library has built-in support for *Next Protocol
		Negotiation* as described in the `NPN draft specification

Uh oh!

Conversation

CuriousLearner commented Jun 3, 2017 • edited by bedevere-bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

mention-bot commented Jun 3, 2017

Uh oh!

serhiy-storchaka left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

CuriousLearner left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

serhiy-storchaka commented Jun 4, 2017

Uh oh!

CuriousLearner commented Jun 4, 2017

Uh oh!

CuriousLearner commented Jun 4, 2017

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

serhiy-storchaka commented Jun 4, 2017

Uh oh!

CuriousLearner commented Jun 5, 2017

Uh oh!

serhiy-storchaka commented Jun 5, 2017

Uh oh!

serhiy-storchaka left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

CuriousLearner commented Jun 5, 2017

Uh oh!

CuriousLearner commented Jun 13, 2017

Uh oh!

CuriousLearner commented Jul 23, 2017

Uh oh!

marco-buttu commented Jul 25, 2017

Uh oh!

CuriousLearner commented Jun 3, 2017 •

edited by bedevere-bot

Loading

jdufresne commented Jan 6, 2018 •

edited

Loading