Redirects

When you rename a file or move a link to a file to a different section of the TOC, you change the URL. If you do not add a redirect, anyone who clicks the previous URL will get a 404 redirect.

You can also add redirects for previous domains (helpx.adobe.com or marketing.adobe.com or docs.adobe.com).

We support the following redirects:

  • Individual (user-defined) redirects from experienceleague.adobe.com to experienceleague.adobe.com link
  • Wildcard-based redirects for experienceleague.adobe.com link
  • Redirects from helpx.adobe.com link
  • (Legacy) Global (dispatcher) redirects from docs.adobe.com to experienceleague.adobe.com
  • (Legacy) Redirects from marketing.adobe.com link (no longer reliable)

Adding redirects within experienceleague.adobe.com

When you change a URL by renaming the file or moving a file to a different location in the TOC, you can use the redirects.csv file in your repo to specify the old URL and the new URL.

  1. If you don’t already have a redirects.csv file, copy a redirects.csv into the root level of your repo.

    The template.en repo includes a blank redirects.csv file.

  2. Open the redirects.csv file in an editor such as Microsoft Excel or Visual Studio Code.

  3. On each line, add the old URL in column A and the new URL in column B.

    user redirects file

    NOTE

    Deep links in redirects are not supported at this time.

  4. Save the file.

After you commit these changes to master, if validation passes, the redirects get picked up to go live every two hours (at the top of every even hour, Pacific Time).

  • These redirects work only for experienceleague.adobe.com URLs. Redirects from other domains such as helpx.adobe.com or docs.adobe.com will be invalid. (See the note below for adding docs.adobe.com redirects.)

  • The redirects can include the full URL or start with /docs/<path>.

  • Blank lines and comment lines (lines that start with #) are ignored.

  • Best practice is to add redirects to repo in which they occur for troubleshooting purposes, but redirects are not associated with a particular repo.

  • Used only to redirect individual pages, not a whole guide with wildcards. See the next section about global redirects for wildcards.

  • The redirects.csv is tested for validation:

    • The destination URL must be live.
    • No duplicate source URLs: A to B, A to C
    • No chains: A to B, B to C, C to D (change to A to D, B to D, C to D)
    • No loops: A to B, B to A
NOTE

If you need to redirect an article from docs.adobe.com, edit the URL to its EXL equivalent, and use that URL as the source. This redirects the global redirect. For example, https://docs.adobe.com/content/help/en/audience-manager.html becomes https://experienceleague.adobe.com/docs/audience-manager.html.

Adding global redirects for experienceleague.adobe.com

Global redirects are useful if you change the repo name or anchor URL of an entire guide, or you change the URLs of a large section of a guide. We can add wildcard syntax to the dispatcher file to redirect files from the old location to the new location.

If you want to create a global or bulk set of redirects, file a UGP JIRA ticket, and assign it to Bob Bringhurst.

Once implemented, these redirects go live every two hours, at the top of every even hour, Pacific Time.

Redirects for previous domains

You can add redirects to a previous location: helpx.adobe.com or marketing.adobe.com or docs.adobe.com.

When providing redirects, make sure that you provide those redirects in the correct format. The marketing.adobe.com (.txt), helpx.adobe.com (.xls), and docs.adobe.com (.txt) redirects require different formats. Please create separate files and tickets for different redirect targets. See the following sections below for details:

Requesting redirects for previous domains

When requesting redirects, please open a jira issue in the project SSECD with the Component called Redirects.These jira issues are automatically assigned to an SSE team member.

Adding redirects for marketing.adobe.com

NOTE

Creating redirects for marketing.adobe.com links is no longer reliable. See the comment in the source file for legacy information.

Adding redirects for helpx.adobe.com

  1. Work with the SSE team (usually Alva) to generate a list of redirects in an xls file. Use absolute links from helpx to absolute links to docs.adobe.com.
  2. Submit an xls file that includes the old URL and the new URL. In the header of the xls file please add SourceURL and DestinationURL to the top header.

(SSE Team only) Adding redirects for helpx.adobe.com

We work with helpx’s webops team. To submit your redirects, go to https://ccp.corp.adobe.com/redirects.php and add the redirects - either an xls file formatted with SourceURL and DestinationURL in the header; or you can submit individual URLs (good for smaller jobs).

Some items you can determine in the request form are the date (Releases are always on Thursdays). If you need a date outside of their release schedule, make sure to request it. You can also indicate that something is an urgent request. Generally, the team asks for 2 weeks for redirects.

After the redirect request is submitted, the system generates a jira issue that can be followed (in the WPS project for example https://jira.corp.adobe.com/browse/WPS-7571).

On this page