Clean up out of date or permanently redirected links

[willingc]

After merging #369, we now have Travis report when links become out of date. https://travis-ci.org/python/devguide/jobs/379412265

Several files need some clean up on their links. For those sprinting at PyCon, feel free to choose a file, make updates, and file a PR with the changes. Please leave a message below indicating the file which you are currently working on. Thanks.

Files

• [x] communication.rst
• [x] compiler.rst
• [x] coverity.rst
• [ ] developers.rst
• [ ] docquality.rst
• [x] documenting.rst
• [ ] exploring.rst
• [ ] index.rst
• [ ] motivations.rst
• [ ] setup.rst
• [ ] triaging.rst

[vaibssingh]

@willingc Hi! I would like to work on this. Before I start, just for clarification, for the links that are broken, we have to remove them, the permanent redirects are to be updated and for those links which were 'Found' after redirection are to be left as it is, right? Or they need to be updated with the direct links as well?

[willingc]

Thanks @vaibssingh. Great! Why don't you claim 3 of the files (just leave a message here saying which ones) and let others contribute the rest of the files since this is a good issue for newcomers :smile:

For clarification:

• I would not remove links without pinging me here first since we may wish to find a better source for those.
• For permanent redirects, go ahead and update the link to the new location
• For links that are 'Found' after redirection, I would leave the original links [@encukou provides a good explanation below]

[vaibssingh]

@willingc Gotcha! So I am starting on the top three files (communication.rst, compilation.rst, coverity.rst). Shall send the PR once done.

[vaibssingh]

@willingc So I have made the changes as needed. There are two broken links which need to be replaced. In communication.rst:

• http://news.gmane.org/ (Error: 404 Client Error: Not Found for url: http://news.gmane.org/)

In coverity.rst

• http://scan5.coverity.com:8080/ (Error: 503 Server Error: Service Unavailable for url: http://scan5.coverity.com:8080/)

I will be happy to update these two links as well if you can provide their working alternates to me. Meanwhile I am opening a PR for the rest of the updates.

[vaibssingh]

@willingc Here is the PR #373

[encukou]

@tiran, http://scan5.coverity.com:8080/ still works if you are logged in, right?

[tiran]

@encukou It's https://scan.coverity.com/projects/python nowadays.

[encukou]

I don't think following 302 Found redirects is the way to go – some of these are short URLs, and the target URL looks more like an implementation detail. For example:

• https://youtu.be/-Nk-8fSJM6I → https://www.youtube.com/watch?v=-Nk-8fSJM6I&feature=youtu.be
• https://drive.google.com/open?id=... → https://drive.google.com/file/d/.../view?usp=drive_web

[willingc]

@encukou's suggestion to keep the shorter URL is reasonable as these are producing a make linkcheck warning and not error.

@vaibssingh, would you mind going back and leave the 302 Found warnings with the original URL? Sorry for the confusion.

[willingc]

@vaibssingh For the GMANE link, let's change the sentence to:

Most lists are also mirrored at [GMANE](http://gmane.org) and can be ...

[vaibssingh]

@willingc Have made all the changes as needed. Please review if anything else needs to be done. :grinning:

[vaibssingh]

@willingc One more thing, in coverity.rst, most of the redirections are happening because of previous links being http while the updated links are https. So I haven't reverted that update. Do I need to change them back to http as well because it makes more sense having https links directly?

[serhiy-storchaka]

And please don't make replacements like http://www.sphinx-doc.org/ -> http://www.sphinx-doc.org/en/master/. First, /master/ looks as implementation detail. Second, /en/ may depend on locale settings of the user. Users from other countries or other language preferences can get other suffixes. Even if only English is supported now, other translations can be added in future.

[anubhavsinha98]

Hey @willingc can I take the next three files?

[willingc]

Sure @anubhavsinha98.

[anubhavsinha98]

@willingc

1. In developers.rst the following link is showing error 404 https://github.com/orgs/python/teams/python-core .
2. In documenting.rst the following link is showing page does not exist http://sphinx.pocoo.org/contents.html

What should I do, should I delete these links or update them with new ones?

[anubhavsinha98]

Please review @willingc ?

[Mariatta]

https://github.com/orgs/python/teams/python-core That link is only available for people within Python organization. We can leave it in.

http://sphinx.pocoo.org/contents.html can be replaced with http://www.sphinx-doc.org/.

[anubhavsinha98]

ok @Mariatta thanks!

[anubhavsinha98]

@willingc and @Mariatta PR sent #410 Please check it out !

[farhaanbukhsh]

Hey @willingc I would like to help with this issue, should I pick up 3 files as well?

[SubhrajyotiSen]

I would like to pick up triaging.rst

[ramyaparimi]

Hi, I would like to contribute to this issue. Is this still open? Can I take one of the files? Thanks

[Jarmos-san]

I skimmed through the output from .\make linkcheck & observed these:

• developers.rst has no errors besides a redirect to https://github.com/orgs/python/teams/python-core which I believe can only be accessed by the members.

• docquality.rst has a link to the email - [email protected] which has moved to https://mail.python.org/mailman3/lists/docs.python.org/.

• exploring.rst has two articles - "Python Asynchronous I/O Walkthrough" & "CPython internals: A ten-hour codewalk through the Python interpreter source code", the author of which is the same. Although the former seems to have been removed the latter is still accessible. The second article also has a warning "to not link to it any more as they can be removed any time".

• index.rst has a couple of redirects to new addresses except the "Meta Tracker" under Key Resources is broken. Should I remove it then?

• motivations.rst has a few more redirects to new addresses. The link to the GSoC although returns a 200 status code, the page appears to be outdated & even has a message suggesting the same. The new site seems to have moved over here - https://python-gsoc.org/, should I update it?

• setup.rst needs to be updated addresses for GitHub docs, ccache to https://ccache.dev/ & the homepage for Visual Studio.

• triaging.rst again couple of redirects but the link to "Python organization admin" under Becoming a member of the Python triage team directs to https://devguide.python.org/devcycle/?highlight=organization admin#current-owners which can perhaps be improved to something like - https://devguide.python.org/devcycle/#organization-owner-policy or https://devguide.python.org/devcycle/#current-owners. Or is it better left as it is right now?

These were the files @willingc specifically pointed out for fixing. But since the moment this issue thread was created, a couple of other files contain broken links as well. Do they need to be cleaned too?

I skimmed through briefly & found these documents requiring attention as well:

.github/CODE_OF_CONDUCT.md, buildbots.rst, buildworker.rst, committing.rst, communication.rst, coredev.rst, coverage.rst, devcycle.rst, documenting.rst, gitbootcamp.rst, help.rst, langchanges.rst, pullrequests.rst, runtests.rst, tracker.rst.

I can take a look into these issues over the weekends & replace the older links to the newer redirected ones as per the following suggestions.

Thanks @vaibssingh. Great! Why don't you claim 3 of the files (just leave a message here saying which ones) and let others contribute the rest of the files since this is a good issue for newcomers 😄

For clarification:

• I would not remove links without pinging me here first since we may wish to find a better source for those.
• For permanent redirects, go ahead and update the link to the new location
• For links that are 'Found' after redirection, I would leave the original links [@encukou provides a good explanation below]

[hunzlahmalik]

Working on developers.rst and setup.rst

[hugovk]

Let's close this now, make linkcheck finds no problems.

https://github.com/python/devguide/actions/runs/4150512884/jobs/7180218231#step:6:78

Thanks all for the contributions!