Firefox/Input/Standalone Feedback Button: Difference between revisions

From MozillaWiki
< Firefox‎ | Input
Jump to navigation Jump to search
No edit summary
(update status)
 
(19 intermediate revisions by 5 users not shown)
Line 1: Line 1:
{{draft}}
{{FeatureStatus
|Feature name=Provide a standalone feedback button
|Feature stage=Planning
|Feature status note=Patch Incoming
}}
{{FeatureTeam
|Feature product manager=Asa Dotzler
|Feature feature manager=Aakash Desai
|Feature lead engineer=Jono Xia
|Feature qa lead=Vlad Ghetiu (irc: vladg)
}}
{{FeaturePageBody
|Feature open issues and risks=* The code in Test Pilot currently looks at ''every'' loaded URL to see whether or not it's an Input website where data is to be filled in.  This may be a performance issue, so we should test its impact and replace it with something more efficient if needed.
* If the user has manually placed the Feedback button, should that preference override the channel setting?  (I.e. the customization remains even if you switch channels?)
|Feature overview=The Feedback button (which is currently added to the toolbar in the Firefox aurora/beta branches by the bundled Test Pilot add-on) will be moved into Firefox where it becomes part of the default Toolbar Customization panel.


{| class="fullwidth-table"
It will need to be added to the toolbar by default on Nightly, Aurora and Beta builds.  On Release builds it would not be added by default but the user could choose to add it through the Customization panel.
|-
| style="font-weight: bold; background: #DDD;" | Feature
| style="font-weight: bold; background: #DDD;" | Status
| style="font-weight: bold; background: #DDD;" | ETA
| style="font-weight: bold; background: #DDD;" | Owner
|-
<section begin="status" />
| [[Firefox/Input/Standalone Feedback Button|Provide a standalone feedback button ]]
| {{StatusHealthy|status=Scoping}}
| YYYY-MM-DD
| aakashd
<section end="status" />
|-
|}
 
== Summary ==
The Feedback button (which is currently added to the toolbar in the Firefox aurora/beta branches by the bundled Test Pilot add-on) will be moved into Firefox where it becomes part of the default Toolbar Customization panel.
 
It would be added to the toolbar by default on Aurora and Beta builds.  On Release builds it would not be added by default but the user could choose to add it through the Customization panel.


The button holds a drop-down menu containing two items, "Firefox made me happy because..." and "Firefox made me sad because...", both of which go to the Input website and pre-fill some fields.
The button holds a drop-down menu containing two items, "Firefox made me happy because..." and "Firefox made me sad because...", both of which go to the Input website and pre-fill some fields.


== Team ==
<table class="fullwidth-table">
Who's working on this?
<tr>
 
<td style="background-color: #efefef;">Menu Item</td>
* '''Feature Manager''': Aakash Desai
<td style="background-color: #efefef;">URL</td>
* '''Lead Developer''':  Jono Xia
</tr>
* '''QA''':
<tr>
* '''UX''':  
<td>Firefox made me happy because...</td>
* '''Security''':
<td>http://input.mozilla.com/happy</td>
 
</tr>
== Release Requirements ==
<tr>
 
<td>Firefox made me sad because...</td>
'''Instancing the "Feedback" button'''
<td>http://input.mozilla.com/sad</td>
* On Nightly/Aurora/Beta builds, a button which opens a menu consisting of two options (i.e. "Firefox made me happy because..." and "Firefox made me sad because...") should be visible on the right hand side of the navigation toolbar by default.
</tr>
* On Release builds, the button should NOT be visible in the navigation toolbar. But it should be available within the toolbar customization palette to add to the browser UI.
</table>
** If the user is running a "Beta" build, but chooses to remove the Feedback button through customization, it must not reappear on restart.
** Switching channels must be supported -- The Feedback button has to appear when switching to Beta/Aurora and disappear when switching to Release. (Unless the user has manually modified its location, in which case the modification sticks regardless of channel?)


'''Using the menu items'''
'''Ride-Along'''
* When either menu item is selected, the appropriate URLs should load and The Feedback button must show the menu items and these must be tested and verified to work correctly (loading the Input pages and pre-filling them with the desired information).
The URL attached to the "Submit Feedback..." menu item in the Help Menu is [http://mxr.mozilla.org/mozilla-central/source/browser/base/content/utilityOverlay.js#471 hard-coded into the codebase], it'd be good to change it into a pref for testing purposes.
{| class="fullwidth-table"
|-
| style="background-color: #efefef;" | Menu Item
| style="background-color: #efefef;" | URL
|-
| Firefox made me happy because...
| http://input.mozilla.com/happy
|-
| Firefox made me sad because...
| http://input.mozilla.com/sad
|}


'''Externalities'''
'''Externalities'''
Line 61: Line 43:
#* "Firefox made me happy because..."
#* "Firefox made me happy because..."
#* "Firefox made me sad because..."
#* "Firefox made me sad because..."
 
|Feature users and use cases=* Users who wish to keep providing Input about Firefox through the feedback button should be able to do so even on the release channel with no bundled add-ons.
== Next Steps ==
* Separate Feedback button code from Test Pilot add-on and turn it into a patch against mozilla-central (Jono Xia)
 
== Open Issues ==
* The code in Test Pilot currently looks at ''every'' loaded URL to see whether or not it's an Input website where data is to be filled in.  This may be a performance issue, so we should test its impact and replace it with something more efficient if needed.
* Show Feedback button in Nightly channel or not?
* If the user has manually placed the Feedback button, should that preference override the channel setting?  (I.e. the customization remains even if you switch channels?)
 
== Related Bugs & Dependencies ==
* {{bug|649156}} - Add the feedback button to the customize toolbar palette
 
== Designs ==
TODO - Any and all mockups, design specs, tech specs, etc.  Either inline or linked to.
 
== Test Plans ==
TODO - Any and all test plans and strategies.  Either inline or linked to.
 
== Goals/Use Cases ==
* Users who wish to keep providing Input about Firefox through the feedback button should be able to do so even on the release channel with no bundled add-ons.
* The Test Pilot add-on should be independent of the Feedback button implementation (which allows Test Pilot to become a restartless add-on).
* The Test Pilot add-on should be independent of the Feedback button implementation (which allows Test Pilot to become a restartless add-on).
* Input's "/feedback" page should be referred as a pref
|Feature requirements='''Instancing the "Feedback" button'''
# On Nightly/Aurora/Beta builds, a button which opens a menu consisting of two options (i.e. "Firefox made me happy because..." and "Firefox made me sad because...") should be visible on the right hand side of the navigation toolbar by default.
# On Release builds, the button should NOT be visible in the navigation toolbar. But it should be available within the toolbar customization palette to add to the browser UI.
#* If the user is running a "Beta" build, but chooses to remove the Feedback button through customization, it must not reappear on restart.
#* Switching channels must be supported -- The Feedback button has to appear when switching to Beta/Aurora and disappear when switching to Release. (Unless the user has manually modified its location, in which case the modification sticks regardless of channel?)


== Non-Goals ==
'''Using the menu items'''
# Placing the feedback button onto the navigation toolbar by default across all channels/builds.
# When either menu item is selected, the appropriate URLs should load and desired information should be pre-filled onto the page (i.e. URL field will include the URL of the previously loaded tab and user agent will be pre-loaded onto a hidden form field).
|Feature non-goals=# Placing the feedback button onto the navigation toolbar by default across all channels/builds.
# Landing Test Pilot as a patch onto mozilla-central.
# Landing Test Pilot as a patch onto mozilla-central.
|Feature qa review=TODO - Any and all test plans and strategies.  Either inline or linked to.
|Feature implementation notes=* {{bug|649156}} - Add the feedback button to the customize toolbar palette


== Legend (remove if you like) ==
==== Next steps ====
{| class="fullwidth-table"
* Separate Feedback button code from Test Pilot add-on and turn it into a patch against mozilla-central (Jono Xia)
|-
}}
| {{StatusHealthy|status=&nbsp;}}
{{FeatureInfo
| Healthy: feature is progressing as expected.
|Feature priority=P2
|-
|Feature roadmap=User Engagement
| {{StatusBlocked|status=&nbsp;}}
|Feature list=Desktop
| Blocked: feature is currently blocked.
|Feature engineering team=Desktop front-end
|-
}}
| {{StatusAtRisk|status=&nbsp;}}
{{FeatureTeamStatus}}
| At Risk: feature is at risk of missing its targeted release.
|-
| '''ETA'''
| Estimated date for completion of the current feature task. Overall ETA for the feature is the product release date.
|}
 
__NOTOC__
 
Please remove this line and any non-relevant categories below.  Add whatever other categories you feel are appropriate.
 
[[Category:Features]]
[[Category:Firefox]]

Latest revision as of 00:45, 2 September 2012

Please use "Edit with form" above to edit this page.

Status

Provide a standalone feedback button
Stage Planning
Status `
Release target `
Health `
Status note Patch Incoming

{{#set:Feature name=Provide a standalone feedback button

|Feature stage=Planning |Feature status=` |Feature version=` |Feature health=` |Feature status note=Patch Incoming }}

Team

Product manager Asa Dotzler
Directly Responsible Individual Aakash Desai
Lead engineer Jono Xia
Security lead `
Privacy lead `
Localization lead `
Accessibility lead `
QA lead Vlad Ghetiu (irc: vladg)
UX lead `
Product marketing lead `
Operations lead `
Additional members `

{{#set:Feature product manager=Asa Dotzler

|Feature feature manager=Aakash Desai |Feature lead engineer=Jono Xia |Feature security lead=` |Feature privacy lead=` |Feature localization lead=` |Feature accessibility lead=` |Feature qa lead=Vlad Ghetiu (irc: vladg) |Feature ux lead=` |Feature product marketing lead=` |Feature operations lead=` |Feature additional members=` }}

Open issues/risks

  • The code in Test Pilot currently looks at every loaded URL to see whether or not it's an Input website where data is to be filled in. This may be a performance issue, so we should test its impact and replace it with something more efficient if needed.
  • If the user has manually placed the Feedback button, should that preference override the channel setting? (I.e. the customization remains even if you switch channels?)

Stage 1: Definition

1. Feature overview

The Feedback button (which is currently added to the toolbar in the Firefox aurora/beta branches by the bundled Test Pilot add-on) will be moved into Firefox where it becomes part of the default Toolbar Customization panel.

It will need to be added to the toolbar by default on Nightly, Aurora and Beta builds. On Release builds it would not be added by default but the user could choose to add it through the Customization panel.

The button holds a drop-down menu containing two items, "Firefox made me happy because..." and "Firefox made me sad because...", both of which go to the Input website and pre-fill some fields.

Menu Item URL
Firefox made me happy because... http://input.mozilla.com/happy
Firefox made me sad because... http://input.mozilla.com/sad

Ride-Along The URL attached to the "Submit Feedback..." menu item in the Help Menu is hard-coded into the codebase, it'd be good to change it into a pref for testing purposes.

Externalities

  1. The Test Pilot add-on (both the AMO version and the bundled-with-Firefox-betas version) must be modified to work with the new standalone Feedback button. This means the add-on no longer creates the Feedback button; instead it looks at the toolbar to see whether there's a Feedback button there, adding the "All your user studies" and "turn on/off user studies" menu items to the button if present, providing an alternate interface otherwise.
  2. The following strings will need to be localized to something that's not unreasonably long in any language:
    • "Feedback"
    • "Firefox made me happy because..."
    • "Firefox made me sad because..."

2. Users & use cases

  • Users who wish to keep providing Input about Firefox through the feedback button should be able to do so even on the release channel with no bundled add-ons.
  • The Test Pilot add-on should be independent of the Feedback button implementation (which allows Test Pilot to become a restartless add-on).
  • Input's "/feedback" page should be referred as a pref

3. Dependencies

`

4. Requirements

Instancing the "Feedback" button

  1. On Nightly/Aurora/Beta builds, a button which opens a menu consisting of two options (i.e. "Firefox made me happy because..." and "Firefox made me sad because...") should be visible on the right hand side of the navigation toolbar by default.
  2. On Release builds, the button should NOT be visible in the navigation toolbar. But it should be available within the toolbar customization palette to add to the browser UI.
    • If the user is running a "Beta" build, but chooses to remove the Feedback button through customization, it must not reappear on restart.
    • Switching channels must be supported -- The Feedback button has to appear when switching to Beta/Aurora and disappear when switching to Release. (Unless the user has manually modified its location, in which case the modification sticks regardless of channel?)

Using the menu items

  1. When either menu item is selected, the appropriate URLs should load and desired information should be pre-filled onto the page (i.e. URL field will include the URL of the previously loaded tab and user agent will be pre-loaded onto a hidden form field).

Non-goals

  1. Placing the feedback button onto the navigation toolbar by default across all channels/builds.
  2. Landing Test Pilot as a patch onto mozilla-central.

Stage 2: Design

5. Functional specification

`

6. User experience design

`

Stage 3: Planning

7. Implementation plan

`

8. Reviews

Security review

`

Privacy review

`

Localization review

`

Accessibility

`

Quality Assurance review

TODO - Any and all test plans and strategies. Either inline or linked to.

Operations review

`

Stage 4: Development

9. Implementation

  • bug 649156 - Add the feedback button to the customize toolbar palette

Next steps

  • Separate Feedback button code from Test Pilot add-on and turn it into a patch against mozilla-central (Jono Xia)

Stage 5: Release

10. Landing criteria

` {{#set:Feature open issues and risks=* The code in Test Pilot currently looks at every loaded URL to see whether or not it's an Input website where data is to be filled in. This may be a performance issue, so we should test its impact and replace it with something more efficient if needed.

  • If the user has manually placed the Feedback button, should that preference override the channel setting? (I.e. the customization remains even if you switch channels?)

|Feature overview=The Feedback button (which is currently added to the toolbar in the Firefox aurora/beta branches by the bundled Test Pilot add-on) will be moved into Firefox where it becomes part of the default Toolbar Customization panel.

It will need to be added to the toolbar by default on Nightly, Aurora and Beta builds. On Release builds it would not be added by default but the user could choose to add it through the Customization panel.

The button holds a drop-down menu containing two items, "Firefox made me happy because..." and "Firefox made me sad because...", both of which go to the Input website and pre-fill some fields.

Menu Item URL
Firefox made me happy because... http://input.mozilla.com/happy
Firefox made me sad because... http://input.mozilla.com/sad

Ride-Along The URL attached to the "Submit Feedback..." menu item in the Help Menu is hard-coded into the codebase, it'd be good to change it into a pref for testing purposes.

Externalities

  1. The Test Pilot add-on (both the AMO version and the bundled-with-Firefox-betas version) must be modified to work with the new standalone Feedback button. This means the add-on no longer creates the Feedback button; instead it looks at the toolbar to see whether there's a Feedback button there, adding the "All your user studies" and "turn on/off user studies" menu items to the button if present, providing an alternate interface otherwise.
  2. The following strings will need to be localized to something that's not unreasonably long in any language:
    • "Feedback"
    • "Firefox made me happy because..."
    • "Firefox made me sad because..."

|Feature users and use cases=* Users who wish to keep providing Input about Firefox through the feedback button should be able to do so even on the release channel with no bundled add-ons.

  • The Test Pilot add-on should be independent of the Feedback button implementation (which allows Test Pilot to become a restartless add-on).
  • Input's "/feedback" page should be referred as a pref

|Feature dependencies=` |Feature requirements=Instancing the "Feedback" button

  1. On Nightly/Aurora/Beta builds, a button which opens a menu consisting of two options (i.e. "Firefox made me happy because..." and "Firefox made me sad because...") should be visible on the right hand side of the navigation toolbar by default.
  2. On Release builds, the button should NOT be visible in the navigation toolbar. But it should be available within the toolbar customization palette to add to the browser UI.
    • If the user is running a "Beta" build, but chooses to remove the Feedback button through customization, it must not reappear on restart.
    • Switching channels must be supported -- The Feedback button has to appear when switching to Beta/Aurora and disappear when switching to Release. (Unless the user has manually modified its location, in which case the modification sticks regardless of channel?)

Using the menu items

  1. When either menu item is selected, the appropriate URLs should load and desired information should be pre-filled onto the page (i.e. URL field will include the URL of the previously loaded tab and user agent will be pre-loaded onto a hidden form field).

|Feature non-goals=# Placing the feedback button onto the navigation toolbar by default across all channels/builds.

  1. Landing Test Pilot as a patch onto mozilla-central.

|Feature functional spec=` |Feature ux design=` |Feature implementation plan=` |Feature security review=` |Feature privacy review=` |Feature localization review=` |Feature accessibility review=` |Feature qa review=TODO - Any and all test plans and strategies. Either inline or linked to. |Feature operations review=` |Feature implementation notes=* bug 649156 - Add the feedback button to the customize toolbar palette

Next steps

  • Separate Feedback button code from Test Pilot add-on and turn it into a patch against mozilla-central (Jono Xia)

|Feature landing criteria=` }}

Feature details

Priority P2
Rank 999
Theme / Goal `
Roadmap User Engagement
Secondary roadmap `
Feature list Desktop
Project `
Engineering team Desktop front-end

{{#set:Feature priority=P2

|Feature rank=999 |Feature theme=` |Feature roadmap=User Engagement |Feature secondary roadmap=` |Feature list=Desktop |Feature project=` |Feature engineering team=Desktop front-end }}

Team status notes

  status notes
Products ` `
Engineering ` `
Security ` `
Privacy ` `
Localization ` `
Accessibility ` `
Quality assurance ` `
User experience ` `
Product marketing ` `
Operations ` `

{{#set:Feature products status=`

|Feature products notes=` |Feature engineering status=` |Feature engineering notes=` |Feature security status=` |Feature security health=` |Feature security notes=` |Feature privacy status=` |Feature privacy notes=` |Feature localization status=` |Feature localization notes=` |Feature accessibility status=` |Feature accessibility notes=` |Feature qa status=` |Feature qa notes=` |Feature ux status=` |Feature ux notes=` |Feature product marketing status=` |Feature product marketing notes=` |Feature operations status=` |Feature operations notes=` }}


Retrieved from "https://wiki.allizom.org/index.php?title=Firefox/Input/Standalone_Feedback_Button&oldid=466622"