the "?" button under about:preferences#search points to the "General" tab support article

RESOLVED FIXED in Firefox 36

Status

()

RESOLVED FIXED
4 years ago
4 years ago

People

(Reporter: kjozwiak, Assigned: msaad, Mentored)

Tracking

({user-doc-needed})

Trunk
Firefox 37
x86
Mac OS X
user-doc-needed
Points:
2
Bug Flags:
firefox-backlog +
qe-verify -

Firefox Tracking Flags

(firefox34- wontfix, firefox35 wontfix, firefox36 fixed, firefox37 verified)

Details

Attachments

(1 attachment)

(Reporter)

Description

4 years ago
Pressing the "?" button under about:preferences#search takes the user to the following webpage: (opens information for the "General" tab)

https://support.mozilla.org/en-US/kb/startup-home-page-download-settings?redirectlocale=en-US&as=u&redirectslug=Options+window+-+General+panel&utm_source=inproduct

I know that there's most likely no support article(s) about the new search UI, but we could point the "?" button to this for now, gives the user a general idea of what the search toolbar is about rather than pointing the button to information relating to the General tab.

https://support.mozilla.org/en-US/kb/search-bar-add-change-manage-search-engines-firefox
Hi Joni,

We're releasing the new search UI from bug 1088660 in Firefox 34, the week of Dec 1st. This is an incredibly tight timeline, and will likely surprise a lot of users. Eventually we would like to have a page on SUMO to link to here covering this new UI specifically (as described in comment 0).

We won't block on getting these documents set up, but whenever we can get something here we can add the relevant link in-product.
Keywords: user-doc-needed
status-firefox34: --- → wontfix
tracking-firefox34: --- → -
Hi Gavin,

We're going to update this article with the new UI: https://support.mozilla.org/kb/search-bar-add-change-manage-search-engines-firefox. It will have updated screenshots and instructions for how to use and manage the new search UI.

Will that cover it, or do we still need a new article?
Flags: needinfo?(gavin.sharp)
In general, that sounds great.

Will the revised article there also cover the preferences pane specifically (i.e. this page: https://cloudup.com/cvYCpuQNseX)? If so, then that will be sufficient for this bug. If not, then we will likely want a separate article for preferences specifically.
Flags: needinfo?(gavin.sharp)
Yes, it will cover the preferences pane for version 34 and up.
I've updated the article with the new search UI (only for fx34 and above): https://support.mozilla.org/kb/search-bar-add-change-manage-search-engines-firefox#firefox:mac:fx34

Please let me know if you have any feedback.
Just wanted to add that "?" on Mac respectively "Help" on Linux are also present in Options/Search tab while on separate window. They now redirects to https://support.mozilla.org/1/firefox/34.0/Darwin/en-US/prefs-search - a 404 page.

Updated

4 years ago
Flags: firefox-backlog+
Component: Search → Preferences
Can you give this a points value please Felipe?
Assignee: nobody → felipc
Flags: qe-verify?
(Assignee)

Comment 8

4 years ago
So I've been taking a look at this bug and I found out that:

This function is called when the button is clicked, and passes 'prefs-main' as the helpTopic.

function helpButtonCommand() {
   let pane = history.state;
   let categories = document.getElementById("categories");
   let helpTopic = categories.querySelector(".category[value=" + pane + "]")
                             .getAttribute("helpTopic");
   openHelpLink(helpTopic);
 }

http://mxr.mozilla.org/mozilla-central/source/browser/components/preferences/in-content/preferences.js#111

After that, openHelpLink is called and produces the URL by doing:

function openHelpLink(aHelpTopic, aCalledFromModal, aWhere) {
   var url = Components.classes["@mozilla.org/toolkit/URLFormatterService;1"]
                      .getService(Components.interfaces.nsIURLFormatter)
                      .formatURLPref("app.support.baseURL");

If only I could figure out how to write https://support.mozilla.org/kb/search-bar-add-change-manage-search-engines-firefox#firefox:mac:fx34 following the generated format : https://support.mozilla.org/1/firefox/<version>/<platform>/<lang>/helpTopic
So to fix this bug we need to change the helpTopic of this pref pane, which currently says "prefs-main" but it should be "prefs-search".

And we shouldn't need to modify the openHelpLink code that generates the link; instead, we need to contact the SUMO folks to add a redirect from https://support.mozilla.org/1/firefox/<version>/<platform>/<lang>/prefs-search to the KB url: https://support.mozilla.org/kb/search-bar-add-change-manage-search-engines-firefox
Assignee: felipc → mv.nsaad
Mentor: felipc
Points: --- → 2
Flags: qe-verify? → qe-verify-
(Assignee)

Comment 10

4 years ago
Created attachment 8537428 [details] [diff] [review]
v1.patch

This patches replaces the helpTopic string of the search entry in about:preferences.

I'll get in contact with sumo folks to add the redirect and will come with a feedback soon.
Attachment #8537428 - Flags: review?(felipc)
(Assignee)

Comment 11

4 years ago
Thanks to r1cky on #sumodev for creating the redirect. We are good to go.
Comment on attachment 8537428 [details] [diff] [review]
v1.patch

Review of attachment 8537428 [details] [diff] [review]:
-----------------------------------------------------------------

Thanks Marcus for the patch and for pinging the right people to get the redirect created. Great work!
Attachment #8537428 - Flags: review?(felipc) → review+
(Assignee)

Comment 13

4 years ago
Thanks Felipe for pushing it.

https://hg.mozilla.org/integration/fx-team/rev/838b8424fcb4
https://hg.mozilla.org/mozilla-central/rev/838b8424fcb4
Status: NEW → RESOLVED
Last Resolved: 4 years ago
Resolution: --- → FIXED
Target Milestone: --- → Firefox 37

Updated

4 years ago
Iteration: --- → 37.2
Comment on attachment 8537428 [details] [diff] [review]
v1.patch

Approval Request Comment
[Feature/regressing bug #]: New search UI
[User impact if declined]: Help button from the Search tab in the in-content prefs will point to wrong SUMO link
[Describe test coverage new/current, TBPL]: - 
[Risks and why]: none
[String/UUID change made/needed]: none
Attachment #8537428 - Flags: approval-mozilla-aurora?
(Reporter)

Comment 16

4 years ago
Used the following build for verification:
- http://ftp.mozilla.org/pub/mozilla.org/firefox/nightly/2014-12-18-03-02-02-mozilla-central/

OS's Used:

- Win 8.1 x64 - PASSED
- OSX 10.10.1 x64 - PASSED
- Ubuntu 14.04.1 x64 - PASSED
 
Went through the following Test Cases with the above OS's:

- ensured that pressing "?" under "General" opened "Startup, home page and download settings"
- ensured that pressing "?" under "Search" opened "Search bar - add, change and manage search engines on Firefox"
- ensured that pressing "?" under "Content" opened "Settings for fonts, languages, and pop-ups"
- ensured that pressing "?" under "Applications" opened "Set how Firefox handles different types of files"
- ensured that pressing "?" under "Privacy" opened "Settings for privacy, browsing history and do-not-track"
- ensured that pressing "?" under "Security" opened "Security and passwords settings"
- ensured that pressing "?" under "Sync" opened "How do I set up Firefox Sync?"
- ensured that pressing "?" under "Advanced" opened "Advanced settings for accessibility, browsing, system defaults, network, updates, and encryption"
- ensured that the web pages are opened in a new tab
status-firefox37: --- → verified
status-firefox35: --- → wontfix
status-firefox36: --- → affected
Attachment #8537428 - Flags: approval-mozilla-aurora? → approval-mozilla-aurora+
You need to log in before you can comment on or make changes to this bug.