Implement bug entry template for product Mozilla Developer Network

RESOLVED FIXED

Status

()

bugzilla.mozilla.org
Extensions: Other
RESOLVED FIXED
6 years ago
6 years ago

People

(Reporter: openjck, Assigned: dkl)

Tracking

Production

Details

(Reporter)

Description

6 years ago
I realize this is a big ask. The sooner the better of course, but there is no hard deadline right now.

We are hoping to have a new bug entry template for the "Mozilla Developer Network" product. We put together a complete example of what this template should look like. The example even includes what we want the output to look like -- click "Submit" on the second screen to see this. The template is relatively involved, so please be sure to check all the edge cases.

http://jsfiddle.net/zd3gH/84/embedded/result/

A few other things to mention:

* We do not have a "General" component like the example assumes, but we just opened bug 833958 about that.
* We would like all users to go through this template when submitting a bug. However, it should be possible for some select people (at the moment just me) to opt-out of the template and use the "advanced bug entry form" instead. I thought about opening this up to all Mozilla employees, but if possible I would like even them to be required to go through this form.
* If you can, please pass the completed template by me before it goes live.

Like I said, I realize this is no small task. Thanks for understanding, and please let me know if there is anything I can do to help.
(In reply to John Karahalis [:openjck] from comment #0)
> We are hoping to have a new bug entry template for the "Mozilla Developer
> Network" product. We put together a complete example of what this template
> should look like. The example even includes what we want the output to look
> like -- click "Submit" on the second screen to see this. The template is
> relatively involved, so please be sure to check all the edge cases.

generally it's easier for us if you can document the business logic rather than implementing it and asking us to reverse engineer :)

> * We would like all users to go through this template when submitting a bug.

sorry, it isn't currently possible to force custom bug template usage.
it sounds reasonable, so i'll file a separate bug for this.
Depends on: 834119
(Reporter)

Comment 2

6 years ago
In what format would you like the documentation? The JavaScript that processes the form is already out there (http://jsfiddle.net/zd3gH/84) but I could also write some documented pseudo-code, diagrams, etc. Whatever works.
(In reply to John Karahalis [:openjck] from comment #2)
> In what format would you like the documentation? The JavaScript that
> processes the form is already out there (http://jsfiddle.net/zd3gH/84) but I
> could also write some documented pseudo-code, diagrams, etc. Whatever works.

this form appears to be pretty simple, so the js should be fine.  for future reference, simple documentation with words that lays out the flow would be easier to work off.
(Assignee)

Updated

6 years ago
Assignee: nobody → dkl
Status: NEW → ASSIGNED
(Assignee)

Comment 4

6 years ago
The new form is now available for your review at:

https://bugzilla-stage-tip.mozilla.org/form.mdn

dkl
Flags: needinfo?(jkarahalis)
(Reporter)

Comment 5

6 years ago
Taking a look. Will have some feedback soon.
Flags: needinfo?(jkarahalis)
(Reporter)

Comment 6

6 years ago
Looks really great. Thank you for doing this so quickly.

A few requests:

* Rename the heading "Mozilla Developer Network Request" to "Mozilla Developer
  Network Feedback"
* Remove the question "What do you want to do?"
* Rename "Submit Request" to "Submit"
* Provide a space after each number in the question "What did you do?"
    * That is, "1." => "1. "
* Remove the text "[ All fields required ]"
    * Instead, please put a red asterisk at the end of all required questions
      (everything except for "Is there anything..." and the security checkbox)
* Add a period at the end of "Please provide the URL of the feature if possible"
* Add an <h2> above each form
(Reporter)

Comment 7

6 years ago
Hit "Save Changes" accidentally. Please ignore comment 6.
(Reporter)

Comment 8

6 years ago
Looks really great. Thank you for doing this so quickly. A few requests...

Rename:

* "Mozilla Developer Network Request" => "Mozilla Developer Network Feedback"
* "Submit Request" => "Submit"
* "What... if possible" => "What... if possible." (note the period)

Remove:

* "[ All fields required ]"
* "What do you want to do?"

Add:

* A checkbox at the bottom of each form (see here: http://is.gd/AIIFkN)
    * Form 1: "This report is about problem that is putting users at risk. It
               should be kept hidden from the public until it is resolved."
    * Forms 2 and 3: "This request is about problem that is putting users at
                      risk. It should be kept hidden from the public until it
                      is resolved." (same thing, just "request" instead of "report")
    * Checking this box should make the bug private.
* A different <h2> below the form title for each form. Use this text:
    * Form 1: Bug report
    * Form 2: Feature request
    * Form 3: Change request
* A space after each number in the question "What did you do?".
    * For example, "1." => "1. "
* A red asterisk after required questions (everything except for "Is there
  anything..." and the security checkbox)
* Not a dealbreaker, but it would be nice to be able to move back in history.
  For example, if the user selects "Report a bug", hits "Next" and then goes
  back in history, he should be returned to the first page (the radio boxes)

Realize this is a lot. Thanks again for doing this.
(Reporter)

Comment 9

6 years ago
One other thing to note. I cannot test the output of the form because the "General" component does not exist on bugzilla-stage-tip.
(Assignee)

Comment 10

6 years ago
(In reply to John Karahalis [:openjck] from comment #9)
> One other thing to note. I cannot test the output of the form because the
> "General" component does not exist on bugzilla-stage-tip.

I have pushed the latest changes to https://bugzilla-stage-tip.mozilla.org/form.mdn which should be there soon (it updates every 15mins). 

I also fixed the General component.

dkl
Flags: needinfo?(jkarahalis)
(Reporter)

Comment 11

6 years ago
Looking good. A few more things I noticed.

* When the bug is submitted, please add the same information to the whiteboard that the mockup does, in the same format (see mockup below).
* Please format comment 0 the same way the mockup does. The current format works
  for the most part, but I suspect it would be difficult to read if anyone provides
  any answer longer than one paragraph.
    * Please remove the ":" after each question
    * Please provide a "===" separator equal in length to the question below
      the question.
* Please remove the bug type from the summary (for example "Bug: ..."). We will
  use the status whiteboard for that.
* Please add a period at the end of the question "What feature should be
  changed? Please provide the URL of the feature if possible"
* Is it possible for me to be added to the "Web security" group, so that I
  can see secure bugs by default? If so, I will open a bug for that. If not,
  maybe we could cc: a couple of people by default on those bugs.
* Is it possible to use browser history rather than a "Back" form button?
  If not, I would rather do without the "Back" button.

Mockup: http://jsfiddle.net/zd3gH/84/embedded/result/

Anyway, getting real close. Thanks again for the hard work here.
Flags: needinfo?(jkarahalis)
(Reporter)

Comment 12

6 years ago
One correction. In the whiteboard, please use these values for "type" instead of the ones shown in the mockup.

[type:bug]
[type:change]
[type:feature]
(Assignee)

Comment 13

6 years ago
The new form is now available for your review at:

https://bugzilla-stage-tip.mozilla.org/form.mdn

dkl
Flags: needinfo?(jkarahalis)
(Reporter)

Comment 14

6 years ago
This is absolutely beautiful. Exactly what we were looking for. Thank you, David.

I notice only two problems. Thankfully neither seems that hard to fix.

1. Please add a period at the end of the sentence "Please provide the URL of the feature if possible"

2. The "Back" feature is causing some strange behavior.

STR:

* Load the form
* Choose "Report a bug" and hit "Next"
* Enter some text into the fields
* Navigate backwards in history
* Choose "Request a new feature"

Actual result:

The forms are populated with the text entered in the bug form. More importantly, the fields from /both/ the bug form and the feature form are shown.

Will leave the solution up to you here. If it's easier to just do without the "Back" feature, no problem.
Flags: needinfo?(jkarahalis)
(Assignee)

Comment 15

6 years ago
The new form is now available for your review at:

https://bugzilla-stage-tip.mozilla.org/form.mdn

dkl
Flags: needinfo?(jkarahalis)
(Reporter)

Comment 16

6 years ago
Absolutely beautiful. This is exactly what we were hoping for. Thanks for taking the time to do this, David. I realize it took a lot of work, but it is going to make a huge difference for us on MDN.

http://i.imgur.com/l4Igata.jpg
Flags: needinfo?(jkarahalis)
(Assignee)

Comment 17

6 years ago
Shipped. Will be in the next code push.

Committing to: bzr+ssh://dlawrence%40mozilla.com@bzr.mozilla.org/bmo/4.0             
added extensions/BMO/template/en/default/bug/create/comment-mdn.txt.tmpl
added extensions/BMO/template/en/default/bug/create/create-mdn.html.tmpl                  
added extensions/BMO/web/yui-history-iframe.txt
Committed revision 8473. 

Committing to: bzr+ssh://dlawrence%40mozilla.com@bzr.mozilla.org/bmo/4.2             
added extensions/BMO/web/yui-history-iframe.txt
added extensions/BMO/template/en/default/bug/create/comment-mdn.txt.tmpl                 
added extensions/BMO/template/en/default/bug/create/create-mdn.html.tmpl
Committed revision 8537.

dkl
Status: ASSIGNED → RESOLVED
Last Resolved: 6 years ago
Resolution: --- → FIXED
You need to log in before you can comment on or make changes to this bug.