Redirects for moved and renamed files
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.
We support the following redirects:
- Individual (user-defined) redirects from
experienceleague.adobe.comtoexperienceleague.adobe.comlink - Wildcard-based redirects for
experienceleague.adobe.comlink - Redirects from
helpx.adobe.comlink - (Legacy) Global (dispatcher) redirects from
docs.adobe.comtoexperienceleague.adobe.com - (Legacy) Redirects from
marketing.adobe.comlink (no longer reliable)
Add EXL redirects (new) add-exl-redirects
Before the AEM EDS replatform, writers added redirects by adding URLs to the redirects.csv file. That old method is no longer supported. Instead, send your redirect requests to Bob Bringhurst.
If you want to add your own redirects, you need access to the redirects repo here: https://github.com/Adobe-Enterprise-Docs/redirects.
-
Make sure that you sign in using the new Enterprise Github. See Sign in to Enterprise github for details.
-
Clone the
redirectsrepo. -
Create a branch.
-
For individual redirects, open the
redirects-prod.csvin the redirects folder. -
In the CSV file, add the old and new URLs to the bottom of the file using the same format as the other redirects.
-
Save the file and submit a pull request. Add Bob Bringhurst as a reviewer.
Once you get the hang of adding redirects, work with Bob to get Write access so that you can merge your own pull requests.
Regex (wildcard) redirects
You can also use regex syntax to create wildcard redirects. This is especially useful when you move a section of content from one repo to another or when you rename section anchors in the TOC that change multiple URLs in the same way.
Contact Bob about adding regex redirects.
Add redirects within experienceleague.adobe.com redirects-individual
Obtain a list of URLs for your repo
In some instances, you need to make many changes to your TOC structure, resulting in a number of files that need to be redirected. To make the redirect process easier, a Jenkins job generates a list of all EXL URLs once a day.
-
Go to the Repo URL Resource, select the date of the build, and download global_mapping.md file.
The global_mapping.md file includes a list of links to all published files in all repos. The global_mapping.csv files includes three columns of information: Date, Source file (git) URL, and EXL URL.
-
Open the file in Visual Studio Code or a spreadsheet app.
-
Extract the links you want to use for redirects.
For example, suppose you overhauled the TOC from May 15-19. You could click the build for May 14 to get the ‘Source’ URLs that have changed. Then you could click a build after May 19 for the new ‘Destination’ URLs. Use find/change to strip out everything but the required URL, and copy the source URLs in the first column of the CSV (using a spreadsheet app) and the destination URLs in the second column that match up with the source files.
Bob: Create video
Redirects for previous domains
You can add redirects to a previous location: helpx.adobe.com or marketing.adobe.com (no longer reliable) 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:
Request 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.
Add redirects for marketing.adobe.com redirects-marketing
Add redirects for helpx.adobe.com redirects-helpx
Redirects from helpx to EXL usually take about two weeks to go through.
-
Create a JIRA ticket (project = UGP) requesting helpx redirects. Assign to Bob.
-
Work with the Bob to generate a list of redirects in a CSV file (maximum of 100 redirects per file). Use absolute links from
helpx.adobe.comin column A to absolute links toexperienceleague.adobe.comin column B. No header row is necessary.To generate a list of URLs for your repo, you can use the Mapping CSV log file in your most recent successful Jenkins job. Contact Bob for details.
-
Ask Bob to submit the redirect CSV file(s).
(SSE Team only) Add redirects for helpx.adobe.com sse-helpx-redirects
-
In menu, Redirects > New Request.
-
Test. Contact Sunil Banothu to publish live or log ticket. Example: