New 'How to Write a Good Bug Report' Article for Docs
Hi All! We are trying to replace a link in the official docs which is now broken, but used to link to this article: https://web.archive.org/web/20210613191914/https://developer.mozilla.org/en-... Can you offer a suggestion for a replacement? The bad link has already been removed. Also see the bpo: https://bugs.python.org/issue44830 Also see the rather stale discourse post to the same effect as this email (asking for replacement article ideas): https://discuss.python.org/t/alternate-article-for-how-to-wite-good-bug-repo... Thanks! Jack
Jonathan Goble wrote:
Is there a reason why we can't just link to the Wayback Machine copy like you did here?
I agree with that as immediate first aid. It seems that wikipedia practice now is to link to both the original article and to a copy on the wayback machine. I've found some perhaps useful pages by searching for "Bug report writing guidelines" (with quotes). http://www.jieranqiche.com/developer/docs/mozilla/qa/bug_writing_guidelines/ https://github-wiki-see.page/m/deegree/deegree3/wiki/Bug-Report-writing-Guid... https://github.com/deegree/deegree3/wiki/Bug-Report-writing-Guidelines It might be helpful to provide links to some well-written bug reports, and perhaps some that could do better. with best regards Jonathan
Is there a reason why we can't just link to the Wayback Machine copy like you did here?
That has been discussed on the bpo thread, we felt that is a clunky solution. Another proposed solution on the bpo is for someone to write a new document about making good bug reports, pertinent to the cpython project. On Mon, Aug 16, 2021 at 10:53:59AM -0400, Jonathan Goble wrote:
It looks like it was removed unintentionally because the Mozilla support pages still reference it https://support.mozilla.org/en-US/kb/contributors-guide-writing-good-bug#w_e... On Mon, 16 Aug 2021, 18:30 Jack DeVries, <jdevries3133@gmail.com> wrote:
It looks like the source moved here https://github.com/mdn/archived-content/blob/main/files/en-us/mozilla/qa/bug...
Jonathan Goble wrote:
Is there a reason why we can't just link to the Wayback Machine copy like you did here?
I agree with that as immediate first aid. It seems that wikipedia practice now is to link to both the original article and to a copy on the wayback machine. I've found some perhaps useful pages by searching for "Bug report writing guidelines" (with quotes). http://www.jieranqiche.com/developer/docs/mozilla/qa/bug_writing_guidelines/ https://github-wiki-see.page/m/deegree/deegree3/wiki/Bug-Report-writing-Guid... https://github.com/deegree/deegree3/wiki/Bug-Report-writing-Guidelines It might be helpful to provide links to some well-written bug reports, and perhaps some that could do better. with best regards Jonathan
Is there a reason why we can't just link to the Wayback Machine copy like you did here?
That has been discussed on the bpo thread, we felt that is a clunky solution. Another proposed solution on the bpo is for someone to write a new document about making good bug reports, pertinent to the cpython project. On Mon, Aug 16, 2021 at 10:53:59AM -0400, Jonathan Goble wrote:
It looks like it was removed unintentionally because the Mozilla support pages still reference it https://support.mozilla.org/en-US/kb/contributors-guide-writing-good-bug#w_e... On Mon, 16 Aug 2021, 18:30 Jack DeVries, <jdevries3133@gmail.com> wrote:
It looks like the source moved here https://github.com/mdn/archived-content/blob/main/files/en-us/mozilla/qa/bug...
participants (5)
-
Jack DeVries -
Jonathan Fine -
Jonathan Goble -
Rob Cliffe -
Thomas Grainger