725546 - Use SUMO's support topic redirects

Status: RESOLVED WORKSFORME

(Firefox for Android Graveyard :: General, defect, P4)

Description

[James Socol [:jsocol, :james]]

(Spawned from bug 714123.)

SUMO has the ability to redirect "in product" help buttons to the currently correct article without changing code in the client. We do this for Firefox on the desktop, but not for Firefox on mobile.

Help should buttons in the UI link to these targets, rather than directly, so the support team can update the URL of the correct documentation, when the content or site organization changes.

For example, on desktop, the default value of app.support.baseURL is

http://support.mozilla.org/1/firefox/%VERSION%/%OS%/%LOCALE%/

On mobile, it is 'http://support.mozilla.org/mobile'.

The baseURL may be appended with an optional topic. Every "help" button in the desktop Firefox options panel has a specific topic.

The baseURL on mobile should be:

http://support.mozilla.org/1/mobile/%VERSION%/%OS%/%LOCALE%/

Any generic "help" links shouldn't append anything to the baseURL. Other places where the UI links to a specific article on SUMO should get a topic to append. Once we have those we can create links on SUMO.

Comment 1

[Mark Finkle (:mfinkle) (use needinfo?)]

I am having trouble seeing this work. I am using a page from bug 702319 comment 18 :

https://support.mozilla.org/kb/how-can-i-help-submitting-mobile-performance-data

Changing this to any of these does not work (404):
http://support.mozilla.org/1/mobile/11/android/en-US/how-can-i-help-submitting-mobile-performance-data

http://support.mozilla.org/1/mobile/11.0/android/en-US/how-can-i-help-submitting-mobile-performance-data

http://support.mozilla.org/1/mobile/11/Linux/en-US/how-can-i-help-submitting-mobile-performance-data

http://support.mozilla.org/1/mobile/11.0/Linux/en-US/how-can-i-help-submitting-mobile-performance-data

Any ideas?

Comment 2

[Reuben Morais [:reuben]]

(In reply to Mark Finkle (:mfinkle) from comment #1)
> I am having trouble seeing this work. I am using a page from bug 702319
> comment 18 :
> 
> https://support.mozilla.org/kb/how-can-i-help-submitting-mobile-performance-
> data
> 

(In reply to James Socol [:jsocol, :james] from comment #0)
> Other places where the UI links to a specific article on SUMO should get a topic
> to append. Once we have those we can create links on SUMO.

I don't think every article gets a topic automatically. If you want to link to that specific article, you have to request the links to be created, as noted in comment 0.
Notice that the base URL alone works as expected:
http://support.mozilla.org/1/mobile/11/android/en-US/

Comment 3

[James Socol [:jsocol, :james]]

(In reply to Reuben Morais [:reuben] from comment #2)
> I don't think every article gets a topic automatically. If you want to link
> to that specific article, you have to request the links to be created, as
> noted in comment 0.
> Notice that the base URL alone works as expected:
> http://support.mozilla.org/1/mobile/11/android/en-US/

This is exactly correct. Rather than using the slug of the current target article, we should come up with a short "topic" string for each existing link to SUMO, and can, with the SUMO and SUMODev teams, make sure those baseURL + topic links go to the currently correct places.

Comment 4

[Aaron Train [:aaronmt]]

Still a problem?

Comment 5

[Reuben Morais [:reuben]]

Nope, fixed by https://hg.mozilla.org/mozilla-central/rev/29be02f524cf (bug 702319), not sure what the proper status for this bug is, marking as WORKSFORME…

Comment 6

[Reuben Morais [:reuben]]

Though note that that bug was only about the telemetry help page, so some of these users might be linking to 404s now:

https://mxr.mozilla.org/mozilla-central/search?find=%2Fmobile%2Fandroid%2F&string=support.baseURL