Decide which version of Bug Writing Guidelines to use (and if they should say bugs should be in English)

RESOLVED FIXED

Status

()

--
enhancement
RESOLVED FIXED
10 years ago
8 years ago

People

(Reporter: Usul, Assigned: dkl)

Tracking

Details

(Whiteboard: [bmo4.0-resolved], URL)

Attachments

(2 attachments, 1 obsolete attachment)

(Reporter)

Description

10 years ago
Add the fact that the dev  community and QA community work in english and state that bugs should be reported in english at https://bugzilla.mozilla.org/page.cgi?id=bug-writing.html.
Summary: Could we state there that bugs should be written in English → Bug Writing Guidelines should say that bugs should be written in English
(Assignee)

Comment 1

8 years ago
Should we just add this an extra bullet point in the Principles section?

Dave
This page should be removed and replaced with a link to the correct page on MDN.
(Assignee)

Comment 4

8 years ago
We have several differences in the bmo/3.6 code that need to make sure they all point to the right page.

template/en/custom/bug/create/user-message.html.tmpl:<a href="http://www.mozilla.org/quality/bug-writing-guidelines.html">

template/en/custom/pages/etiquette.html.tmpl:  <a href="page.cgi?id=bug-writing.html">The Bug Writing Guidelines</a>.

The etiquette page is referenced from the following:

template/en/custom/account/create.html.tmpl:  <a href="page.cgi?id=etiquette.html" target="_blank">bugzilla guidelines</a>

template/en/custom/index.html.tmpl:                <a href="page.cgi?id=etiquette.html">

So we just need to update the link in the template/en/custom/bug/create/user-message.html.tmpl and template/en/custom/pages/etiquette.html.tmpl templates and should fix it.

Dave
(Assignee)

Comment 5

8 years ago
Created attachment 509593 [details] [diff] [review]
Patch to correct bug writing guidelines links (v1)
Attachment #509593 - Flags: review?(reed)
Comment on attachment 509593 [details] [diff] [review]
Patch to correct bug writing guidelines links (v1)

Go ahead and remove the existing one and add a redirect in .htaccess for it as well.
Attachment #509593 - Flags: review?(reed) → review-
Hang on a sec. Yes, this is all a little bit confused.

https://bugzilla.mozilla.org/page.cgi?id=bug-writing.html ships from upstream. So removing it seems like the wrong thing.

If we want to have the Mozilla copy of the guidelines be more Mozilla-specific, we can patch the upstream ones. Only if we need them to be more easily changeable by anyone than a page.cgi page, do we want to shift it off to MDC.

Both versions seem a bit like a guide to filling in the fields on the Bugzilla Helper ("Fill out the form. Here is some help understanding it:"). Are we expecting everyone reading that document to be using the Helper?

If not, perhaps it needs genericising a bit ("here are some things to include"), both for us and for upstream.

Gerv
 
(dkl: you may already get this, but note that the etiquette page is not the same thing as the bug writing guidelines; they are different documents with different audiences.)

Gerv
(Assignee)

Comment 8

8 years ago
(In reply to comment #7)

> If we want to have the Mozilla copy of the guidelines be more Mozilla-specific,
> we can patch the upstream ones. Only if we need them to be more easily
> changeable by anyone than a page.cgi page, do we want to shift it off to MDC.

That's the question here. I can easily take the content from MDC and mirror into page.cgi?id=bug-writing.html but then as people need to add/edit more of the content, it will require more code pushes instead of simply editing the MDC content (which I assume is a wiki or some other CMS system). Do we foresee a
good deal of changes to need happen in the future? We can just mirror the content and try it for a while and if it becomes too much work for us, then change it to redirect to MDC.

> (dkl: you may already get this, but note that the etiquette page is not the
> same thing as the bug writing guidelines; they are different documents with
> different audiences.)

Got it.
I think we should:

- Override the page in our extension with a stub which meta-redirects to the 
  MDC version (so old URLs work)
- Update the MDC version to say what we want it to say

Using a customized version on b.m.o. is the worst of both worlds - we aren't using what upstream ships, but we haven't got the advantage of easy changeability.

Gerv
Summary: Bug Writing Guidelines should say that bugs should be written in English → Decide which version of Bug Writing Guidelines to use (and if they should say bugs should be in English)
(Assignee)

Comment 10

8 years ago
Created attachment 520780 [details] [diff] [review]
Patch to redirect bug writing guidelines to MDN for 3.6 (v1)

Here is a simple patch that adds custom bug-writing.html.tmpl for 3.6 that redirects to https://developer.mozilla.org/en/Bug_writing_guidelines.

Dave
Assignee: nobody → dkl
Attachment #509593 - Attachment is obsolete: true
Status: NEW → ASSIGNED
Attachment #520780 - Flags: review?(gerv)
(Assignee)

Comment 11

8 years ago
Created attachment 520781 [details] [diff] [review]
Patch to redirect bug writing guidelines to MDN for 4.0 (v1)

Patch to perform the same redirect in extensions/BMO for 4.0.

Dave
Attachment #520781 - Flags: review?(gerv)
Comment on attachment 520780 [details] [diff] [review]
Patch to redirect bug writing guidelines to MDN for 3.6 (v1)

Assuming it works and doesn't require more HTML (<html>, <head> etc.), then r=gerv.

Gerv
Attachment #520780 - Flags: review?(gerv) → review+
Comment on attachment 520781 [details] [diff] [review]
Patch to redirect bug writing guidelines to MDN for 4.0 (v1)

Ditto.

Gerv
Attachment #520781 - Flags: review?(gerv) → review+
(Assignee)

Updated

8 years ago
Whiteboard: [bmo4.0-resolved]
(Assignee)

Comment 14

8 years ago
3.6:
Committing to: bzr+ssh://dlawrence%40mozilla.com@bzr.mozilla.org/bmo/3.6/
added template/en/custom/pages/bug-writing.html.tmpl
Committed revision 7282.                                                                                                                                                               
4.0:
Committing to: bzr+ssh://dlawrence%40mozilla.com@bzr.mozilla.org/bmo/4.0/
added extensions/BMO/template/en/default/pages/bug-writing.html.tmpl
Committed revision 7575.

This will be pushed live soon. Updates are being help off until the FF4 launch is over.
Status: ASSIGNED → RESOLVED
Last Resolved: 8 years ago
Resolution: --- → FIXED
Component: Bugzilla: Other b.m.o Issues → General
Product: mozilla.org → bugzilla.mozilla.org
You need to log in before you can comment on or make changes to this bug.