This issue tracker has been migrated to GitHub, and is currently read-only.
For more information, see the GitHub FAQs in the Python's Developer Guide.

classification
Title: Broken Mozilla devguide link in "Dealing with Bugs" doc section
Type: behavior Stage: resolved
Components: Documentation Versions: Python 3.11, Python 3.10, Python 3.9
process
Status: closed Resolution: fixed
Dependencies: Superseder:
Assigned To: docs@python Nosy List: docs@python, graingert, jack__d, lukasz.langa, mark.dickinson, miss-islington, orsenthil, terry.reedy
Priority: normal Keywords: patch

Created on 2021-08-04 16:59 by mark.dickinson, last changed 2022-04-11 14:59 by admin. This issue is now closed.

Pull Requests
URL Status Linked Edit
PR 27664 merged orsenthil, 2021-08-08 00:30
PR 27665 merged miss-islington, 2021-08-08 03:18
PR 27666 merged orsenthil, 2021-08-08 03:23
PR 27818 merged jack__d, 2021-08-19 00:09
PR 27820 merged miss-islington, 2021-08-19 08:11
PR 27821 merged miss-islington, 2021-08-19 08:11
Messages (26)
msg398913 - (view) Author: Mark Dickinson (mark.dickinson) * (Python committer) Date: 2021-08-04 16:59
The "Bug Report Writing Guidelines" link in the "Dealing with Bugs" doc section (https://docs.python.org/3/bugs.html) looks broken.

The linked URL is https://developer.mozilla.org/en-US/docs/Mozilla/QA/Bug_writing_guidelines, but that gives me a "Page not found" error. I tried to find equivalent content elsewhere on developer.mozilla.org, but either it's not there or my search-fu is failing me.
msg398914 - (view) Author: Mark Dickinson (mark.dickinson) * (Python committer) Date: 2021-08-04 17:00
A bit more Googling found this:

https://support.mozilla.org/en-US/kb/contributors-guide-writing-good-bug
msg399033 - (view) Author: Jack DeVries (jack__d) * Date: 2021-08-05 19:48
For reference, it looks like Wayback Machine has a snapshot of the old article for reference: https://web.archive.org/web/20210613191914/https://developer.mozilla.org/en-US/docs/Mozilla/QA/Bug_writing_guidelines

@mark.dickinson, do you feel like that new article is a good drop-in replacement for the old one? It is a bit different. I can open up a PR if so!
msg399062 - (view) Author: Mark Dickinson (mark.dickinson) * (Python committer) Date: 2021-08-06 08:12
> do you feel like that new article is a good drop-in replacement for the old one?

No really, no. :-(  I also now see that the new article has a (broken) link to the old article, which makes me think that maybe the removal of the old article was unintentional. We should probably find a way to report this upstream.

I think I'd go for dropping the existing broken Mozilla URL and then possibly looking for other good sources. Perhaps solicit suggestions on discuss.python.org?
msg399206 - (view) Author: Jack DeVries (jack__d) * Date: 2021-08-08 02:11
I created a discourse thread for people to propose alternatives::

https://discuss.python.org/t/alternate-article-for-how-to-wite-good-bug-report/10040

It's be a good idea to merge @orsenthil's PR which just removes the broken link right away. Then, we can keep this bpo open until we have consensus on an alternative.
msg399207 - (view) Author: Senthil Kumaran (orsenthil) * (Python committer) Date: 2021-08-08 03:18
New changeset ebecffdb6d5fffa4249f9a813f1fc1915926feb5 by Senthil Kumaran in branch 'main':
bpo-44830 - Remove the broken Broken Mozilla devguide link. (GH-27664)
https://github.com/python/cpython/commit/ebecffdb6d5fffa4249f9a813f1fc1915926feb5
msg399208 - (view) Author: Senthil Kumaran (orsenthil) * (Python committer) Date: 2021-08-08 03:44
New changeset 6a6bcf16370beff2e0d1a034661654d5c335b5ee by Miss Islington (bot) in branch '3.9':
bpo-44830 - Remove the broken Broken Mozilla devguide link. (GH-27664) (GH-27665)
https://github.com/python/cpython/commit/6a6bcf16370beff2e0d1a034661654d5c335b5ee
msg399215 - (view) Author: Jack DeVries (jack__d) * Date: 2021-08-08 13:35
@mark.dickinson, Steven D'Aprano suggested just linking to the wayback machine on discuss.python.org. What do you think of that?

https://discuss.python.org/t/alternate-article-for-how-to-wite-good-bug-report/10040/2?u=jdevries3133
msg399217 - (view) Author: Senthil Kumaran (orsenthil) * (Python committer) Date: 2021-08-08 15:54
@Jack, if you review this backport - https://github.com/python/cpython/pull/27666 , I can merge this PR.
msg399222 - (view) Author: Jack DeVries (jack__d) * Date: 2021-08-08 17:23
I'm pretty much a novice, Senthil, so I don't know how much a review from me is worth but removing the broken link seems best!
msg399637 - (view) Author: Łukasz Langa (lukasz.langa) * (Python committer) Date: 2021-08-16 08:47
I merged the 3.10 backport but leaving the bug open since only removing the 404 link isn't really fixing the problem.

Linking to the Wayback Machine feels off to me. I would rather support making a similar document in our own docs, using the removed document as inspiration. If Jack wants to pick this up, I'd merge it.
msg399638 - (view) Author: Łukasz Langa (lukasz.langa) * (Python committer) Date: 2021-08-16 08:48
New changeset b6a6d99a0ba3796a9d7d4fe8612b640f90e6d7f9 by Senthil Kumaran in branch '3.10':
[3.10] bpo-44830 - Remove the broken Broken Mozilla devguide link. (GH-27664) (GH-27666)
https://github.com/python/cpython/commit/b6a6d99a0ba3796a9d7d4fe8612b640f90e6d7f9
msg399656 - (view) Author: Jack DeVries (jack__d) * Date: 2021-08-16 14:38
I agree that linking to the wayback machine is clunky. I just sent a
message out to the python-ideas mailing list to solicit more
suggestions. The discourse thread didn't get much response.

I guess that at some point, if there is no consensus, it wouldn't be a
bad idea to ask the python-dev mailing list. I would think that core
devs would be the most opinionated when it comes to how people should
write bug reports! I don't want to ping that mailing list
unnecessarily, though.
msg399661 - (view) Author: Jack DeVries (jack__d) * Date: 2021-08-16 17:28
> If Jack wants to pick this up, I'd merge it.

I might be interested but I'm not sure if I will have the time. I'm not "calling dibs" if anyone else wants to go ahead with this solution.
msg399668 - (view) Author: Terry J. Reedy (terry.reedy) * (Python committer) Date: 2021-08-16 18:44
Problems with linking to archive.org Wayback machine.
1. They have limited bandwidth. 
2. Production linking, as opposed to research like Jack did to find the 'missing' page, stretches the meaning of 'fair use'.

Potential problems with external docs.
1. Don't directly fit our needs.
2. Cannot be edited by us.
3. Can disappear.

The Mozilla doc is obviously framed in terms of problems with Firefox, which is quite a different beast from Python.  In my opinion, it is too long, somehow seems repetitious, and is a bit hard to read.  I find it hard to imagine that many Python beginners will read the whole thing.

Some of the advice, such as "Version: select the earliest Version with what the problem can be reproduced:" is wrong for our workflow.

I would like our doc to recommend that real beginners, with less than a couple of months of experience, and anyone else with doubts, post first on python-list, asking "Is this a bug, and if not, please explain.

Version: select the earliest Version with what the problem can be reproduced:

A doc that we might link to, perhaps as a supplement to anything we write, is https://stackoverflow.com/help/minimal-reproducible-example.
msg399695 - (view) Author: Thomas Grainger (graingert) * Date: 2021-08-16 22:32
It looks like it got archived here https://github.com/mdn/archived-content/blob/main/files/en-us/mozilla/qa/bug_writing_guidelines/index.html
msg399698 - (view) Author: Terry J. Reedy (terry.reedy) * (Python committer) Date: 2021-08-16 22:43
https://support.mozilla.org/en-US/kb/contributors-guide-writing-good-bug
still has a link to
https://developer.mozilla.org/en-US/docs/Mozilla/QA/Bug_writing_guidelines
but the fact that they moved the latter to
 https://github.com/mdn/archived-content/blob/main/files/en-us/mozilla/qa/bug_writing_guidelines/index.html
does not think highly of it now.  The github archived document says last modified in 2013.  The Wayback copy has an additional box saying last modified a year ago by 'MDM contributors'.  I don't know what that means, even after clicking the link.
msg399705 - (view) Author: Jack DeVries (jack__d) * Date: 2021-08-17 01:16
I am pretty sure that Mozilla moved to a new content management system
and they've been refreshing a lot of content on their site. I would
assume that any lingering presence of this article is just growing pains
and it'll all be removed in due time.

I might be wrong, though. I suppose we could submit a bug report to
Mozilla to find out.... if we can ever figure out how to write a bug
report again, that is!

On Mon, Aug 16, 2021 at 10:43:16PM +0000, Terry J. Reedy wrote:
> 
> Terry J. Reedy <tjreedy@udel.edu> added the comment:
> 
> https://support.mozilla.org/en-US/kb/contributors-guide-writing-good-bug
> still has a link to
> https://developer.mozilla.org/en-US/docs/Mozilla/QA/Bug_writing_guidelines
> but the fact that they moved the latter to
>  https://github.com/mdn/archived-content/blob/main/files/en-us/mozilla/qa/bug_writing_guidelines/index.html
> does not think highly of it now.  The github archived document says last modified in 2013.  The Wayback copy has an additional box saying last modified a year ago by 'MDM contributors'.  I don't know what that means, even after clicking the link.
> 
> ----------
> 
> _______________________________________
> Python tracker <report@bugs.python.org>
> <https://bugs.python.org/issue44830>
> _______________________________________
msg399869 - (view) Author: Jack DeVries (jack__d) * Date: 2021-08-18 20:39
All right, consider the needle in the haystack officially found. This page has the same content as the missing page:

https://bugzilla.mozilla.org/page.cgi?id=bug-writing.html

Thank you @buhtz for opening an issue with Mozilla; they are eventually going to deploy a redirect to the link above from the old link:
https://github.com/mdn/content/issues/8036

So, we could go ahead and insert the link above which contains the same content as before. Or, we can keep the call open for a new document. What does everyone think?
msg399870 - (view) Author: Thomas Grainger (graingert) * Date: 2021-08-18 20:42
Depends on the redirect type they create. If it's temporary we should keep
the same URL, if it's permanent or otherwise has bookmark updating
semantics we should update the URL to follow the redirect

On Wed, 18 Aug 2021, 21:40 Jack DeVries, <report@bugs.python.org> wrote:

>
> Jack DeVries <jdevries3133@gmail.com> added the comment:
>
> All right, consider the needle in the haystack officially found. This page
> has the same content as the missing page:
>
> https://bugzilla.mozilla.org/page.cgi?id=bug-writing.html
>
> Thank you @buhtz for opening an issue with Mozilla; they are eventually
> going to deploy a redirect to the link above from the old link:
> https://github.com/mdn/content/issues/8036
>
> So, we could go ahead and insert the link above which contains the same
> content as before. Or, we can keep the call open for a new document. What
> does everyone think?
>
> ----------
>
> _______________________________________
> Python tracker <report@bugs.python.org>
> <https://bugs.python.org/issue44830>
> _______________________________________
>
msg399872 - (view) Author: Terry J. Reedy (terry.reedy) * (Python committer) Date: 2021-08-18 21:22
Fixing the link now, given that it is possible, and someone someday writing a new doc to replace it are different issues.  This issue is about the link.
msg399878 - (view) Author: Jack DeVries (jack__d) * Date: 2021-08-19 00:10
@terry.reedy ok, a PR to restore the docs with the new link is open.
msg399889 - (view) Author: Łukasz Langa (lukasz.langa) * (Python committer) Date: 2021-08-19 08:11
New changeset 942d1a4284e9341df47c48d7c63e921136dc9719 by Jack DeVries in branch 'main':
bpo-44830: [doc] Restore missing Mozilla devguide link (GH-27818)
https://github.com/python/cpython/commit/942d1a4284e9341df47c48d7c63e921136dc9719
msg399890 - (view) Author: miss-islington (miss-islington) Date: 2021-08-19 08:33
New changeset ad16f93942a398ca1ec9bba54bb9c53a4e121e75 by Miss Islington (bot) in branch '3.10':
bpo-44830: [doc] Restore missing Mozilla devguide link (GH-27818)
https://github.com/python/cpython/commit/ad16f93942a398ca1ec9bba54bb9c53a4e121e75
msg399891 - (view) Author: Łukasz Langa (lukasz.langa) * (Python committer) Date: 2021-08-19 08:36
New changeset fb6074f5d71a6f9802bad97a129378c9556ed8d3 by Miss Islington (bot) in branch '3.9':
bpo-44830: [doc] Restore missing Mozilla devguide link (GH-27818) (GH-27821)
https://github.com/python/cpython/commit/fb6074f5d71a6f9802bad97a129378c9556ed8d3
msg399892 - (view) Author: Łukasz Langa (lukasz.langa) * (Python committer) Date: 2021-08-19 08:43
Thanks, everyone! ✨ 🍰 ✨
History
Date User Action Args
2022-04-11 14:59:48adminsetgithub: 88993
2021-08-19 08:43:10lukasz.langasetstatus: open -> closed
resolution: fixed
messages: + msg399892

stage: patch review -> resolved
2021-08-19 08:36:59lukasz.langasetmessages: + msg399891
2021-08-19 08:33:46miss-islingtonsetmessages: + msg399890
2021-08-19 08:11:21miss-islingtonsetpull_requests: + pull_request26286
2021-08-19 08:11:17miss-islingtonsetpull_requests: + pull_request26285
2021-08-19 08:11:15lukasz.langasetmessages: + msg399889
2021-08-19 00:10:12jack__dsetmessages: + msg399878
2021-08-19 00:09:26jack__dsetpull_requests: + pull_request26283
2021-08-18 21:22:16terry.reedysetmessages: + msg399872
2021-08-18 20:42:18graingertsetmessages: + msg399870
2021-08-18 20:39:47jack__dsetmessages: + msg399869
2021-08-17 01:16:08jack__dsetmessages: + msg399705
2021-08-16 22:43:16terry.reedysetmessages: + msg399698
2021-08-16 22:32:31graingertsetnosy: + graingert
messages: + msg399695
2021-08-16 18:44:02terry.reedysetnosy: + terry.reedy
messages: + msg399668
2021-08-16 17:28:42jack__dsetmessages: + msg399661
2021-08-16 14:38:06jack__dsetmessages: + msg399656
2021-08-16 08:48:18lukasz.langasetmessages: + msg399638
2021-08-16 08:47:10lukasz.langasetnosy: + lukasz.langa
messages: + msg399637
2021-08-08 17:23:53jack__dsetmessages: + msg399222
2021-08-08 15:54:51orsenthilsetmessages: + msg399217
2021-08-08 13:35:18jack__dsetmessages: + msg399215
2021-08-08 03:44:15orsenthilsetmessages: + msg399208
2021-08-08 03:23:42orsenthilsetpull_requests: + pull_request26155
2021-08-08 03:18:20miss-islingtonsetnosy: + miss-islington
pull_requests: + pull_request26154
2021-08-08 03:18:13orsenthilsetmessages: + msg399207
2021-08-08 02:11:25jack__dsetmessages: + msg399206
2021-08-08 00:30:07orsenthilsetkeywords: + patch
nosy: + orsenthil

pull_requests: + pull_request26153
stage: patch review
2021-08-06 08:12:45mark.dickinsonsetmessages: + msg399062
2021-08-05 19:48:34jack__dsetnosy: + jack__d
messages: + msg399033
2021-08-04 17:00:53mark.dickinsonsetmessages: + msg398914
2021-08-04 16:59:27mark.dickinsoncreate