Linking to Mozilla Support articles is crucial for providing our users with direct access to the help they need. There are two primary ways to establish these links, and the method you choose depends on where you are linking from. This guide will walk you through both methods to ensure you can link effectively, helping users find the appropriate support content seamlessly.
Table of Contents
In-product links to SUMO
For links placed within the browser interface of Firefox or Firefox for Android, you must use a specific URL structure. This structure enables the CX Content Team to adjust the link destination without disrupting functionality within Firefox. We've established specific targets for various topics, allowing us to direct users to the most relevant articles based on factors like their operating system or Firefox version. This flexibility means that updates or changes can be made directly in Kitsune, without the need for any modifications to Firefox's code.
Here's the format for creating in-product links to SUMO articles:
https://support.mozilla.org/1/firefox/%VERSION%/%OS%/%LOCALE%/TOPIC
%VERSION%/%OS%/%LOCALE%/
sections are placeholders. Engineers are responsible for dynamically populating them in the source code.Example:
https://support.mozilla.org/1/firefox/13.0a2/Darwin/en-US/prefs-privacy
In this structure:
%VERSION%
Refers to the Firefox version.%OS%
Represents the operating system of the user.%LOCALE%
Specifies the language and region settings of the user.TOPIC
Denotes the subject of the support article, and it can be any text string.
For links specific to Firefox for Android, the URL should include /1/mobile
in the URL to distinguish it from links intended for the desktop version.
Avoid redirects to anchors
Redirects to specific anchors within articles are fragile and can break easily if the page structure changes. To prevent broken links, always link to the main article page instead. This ensures your links remain valid and users can access the necessary information regardless of updates to the article’s internal sections.
Web property links to SUMO
When creating links from web properties external to Firefox, omit the locale part of the URL. This practice allows the SUMO system to automatically detect and direct the user to the appropriate language version of the article based on their browser settings.
So, 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
- Don't use
https://support.mozilla.org/en-US/kb/update-firefox-latest-release
Linking from somewhere else
If you're not linking from Firefox or a website (maybe an app, product, email, etc.), you probably want to use the URL (without the locale string) and identify the source.
Example:
https://support.mozilla.org/kb/update-firefox-latest-release?utm_source=nameofsource
Create an mzl.la shortened link
Please, refer to How to obtain a shortened mzl.la link to see how you can create an mzl.la shortened link.
Questions?
If you need to set up an in-product link, please fill a Content Request Bugzilla ticket. For any inquiries, drop a line in this support thread.