A guide to linking to support articles

Revision Information
  • Revision id: 215270
  • Created:
  • Creator: adhistac
  • Comment: Improved the readability
  • Reviewed: No
  • Ready for localization: No
Revision Source
Revision Content

There are two ways to link to Mozilla Support articles. The method you use depends on where you are linking from. If it is from chrome of Firefox or Firefox for Android, you will want to use the in-product method. If you are linking from a web property, then the URL minus the locale string is the way to go. Here is how they work.

Create in-product links to SUMO

Targets for buttons or links within the browser chrome should follow this pattern:

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

Examples:

  • https://support.mozilla.org/1/firefox/13.0a2/Darwin/en-US/prefs-privacy
  • https://support.mozilla.org/1/firefox/13.0a2/Darwin/en-US/36eol

The last part of the URL, the topic, can be any string.

Firefox for the Android links should use /1/mobile to distinguish the product.

The tuple (product, version, os, locale, topic) determines where the user actually goes. This allows the SUMO team to change the target of the Help button without breaking links or buttons in Firefox. We have specific targets for all the topic values, and sometimes we can split apart users from OS X or Windows to the most relevant articles, or those with old/specific versions of Firefox, and so on.

Link to SUMO from a web property

If this content is being served via the web and is not shipped with the browser, you do not need to (and should not) use the in-product links.

Rather use the URL without the locale string. SUMO will automatically send the user to the version of the article in their language.

For example, in order to link to the Update Firefox to the latest release article:

Use:

  • https://support.mozilla.org/kb/update-firefox-latest-release

Do not use:

  • https://support.mozilla.org/en-US/kb/update-firefox-latest-release

Linking from somewhere else

If you are not linking from Firefox or a website (an application, product, email, and so on), use the URL (without the locale string) and identify the source.

Example:

  • https://support.mozilla.org/kb/update-firefox-latest-release?utm_source=nameofsource
  1. Go to https://bit.ly.
  2. Paste the link you want to shorten in the Shorten your link field.
  3. Click Shorten.

Bitly will recognize that the destination belongs to Mozilla and provide you with an mzl.la shortened link.

Questions?

If you have questions or need to set up the final target of the in-product link, contact Joni Savage - jsavage at mozilla.com or @jsavage:mozilla.org on Matrix.