Redirects in GitLab documentation
When you move, rename, or delete a page, you must add a redirect. Redirects reduce how often users get 404s when they visit the documentation site from out-of-date links.
Add a redirect to ensure:
Users see the new page and can update or delete their bookmark.
External sites can update their links, especially sites that have automation that checks for redirected links.
The documentation site global navigation does not link to a missing page.
The links in the global navigation are already tested in the
gitlab-docsproject. If the redirect is missing, the
mainbranch might break.
Be sure to assign a technical writer to any merge request that moves, renames, or deletes a page. Technical Writers can help with any questions and can review your change.
Types of redirects
There are two types of redirects:
Redirects added into the documentation files themselves, for users who
view the docs in
/helpon self-managed instances. For example,
/helpon GitLab.com. These must be added in the same MR that renames or moves a doc. Redirects to internal pages expire after three months and redirects to external pages (starting with
https:) expire after a year.
- GitLab Pages redirects, which are added automatically after redirect files expire. They must not be manually added by contributors and expire after nine months. Redirects pointing to external sites are not added to the GitLab Pages redirects.
Expired redirect files are removed from the documentation projects by the
clean_redirects Rake task,
as part of the Technical Writing team's monthly tasks.
Redirect to a page that already exists
To redirect a page to another page in the same repository:
In the Markdown file that you want to direct to a new location:
Delete all of the content.
Add this content:
--- redirect_to: '../newpath/to/file/index.md' remove_date: 'YYYY-MM-DD' --- This document was moved to [another location](../path/to/file/index.md). <!-- This redirect file can be deleted after <YYYY-MM-DD>. --> <!-- Redirects that point to other docs in the same project expire in three months. --> <!-- Redirects that point to docs in a different project or site (for example, link is not relative and starts with `https:`) expire in one year. --> <!-- Before deletion, see: https://docs.gitlab.com/ee/development/documentation/redirects.html -->
Replace both instances of
../newpath/to/file/index.mdwith the new file path.
Replace both instances of
YYYY-MM-DDwith the expiration date, as explained in the template.
If the page has Disqus comments, follow the steps for pages with Disqus comments.
If the page had images that aren't used on any other pages, delete them.
After your changes are committed, search for and update all links that point to the old file:
In https://gitlab.com/gitlab-com/www-gitlab-com, search for full URLs:
grep -r "docs.gitlab.com/ee/path/to/file.html" .
In https://gitlab.com/gitlab-org/gitlab-docs/-/tree/master/content/_data, search the navigation bar configuration files for the path with
grep -r "path/to/file.html" .
In any of the four internal projects, search for links in the docs and codebase. Search for all variations, including full URL and just the path. For example, go to the root directory of the
gitlabproject and run:
grep -r "docs.gitlab.com/ee/path/to/file.html" . grep -r "path/to/file.html" . grep -r "path/to/file.md" . grep -r "path/to/file" .
You might need to try variations of relative links, such as
../fileto find every case.
Move a file's location
If you want to move a file from one location to another, you do not move it. Instead, you duplicate the file, and add the redirect code to the old file.
- Create the new file.
- Copy the contents of the old file to the new one.
- In the old file, delete all the content.
- In the old file, add the redirect code and follow the rest of the steps in the Redirect to a page that already exists topic.
Use code to add a redirect
If you prefer to use a script to create the redirect:
Add the redirect code to the old documentation file by running the following Rake task. The first argument is the path of the old file, and the second argument is the path of the new file:
To redirect to a page in the same project, use relative paths and the
.mdextension. Both old and new paths start from the same location. In the following example, both paths are relative to
bundle exec rake "gitlab:docs:redirect[doc/user/search/old_file.md, doc/api/new_file.md]"
To redirect to a page in a different project or site, use the full URL (with
bundle exec rake "gitlab:docs:redirect[doc/user/search/old_file.md, https://example.com]"
Alternatively, you can omit the arguments and be prompted to enter the values:
bundle exec rake gitlab:docs:redirect
Redirecting a page created before the release
If you create a new page and then rename it before it's added to a release on the 18th:
Instead of following that procedure, ask a Technical Writer to manually add the redirect
Redirections for pages with Disqus comments
If the documentation page being relocated already has Disqus comments, we need to preserve the Disqus thread.
Disqus uses an identifier per page, and for https://docs.gitlab.com, the page identifier is configured to be the page URL. Therefore, when we change the document location, we need to preserve the old URL as the same Disqus identifier.
To do that, add to the front matter the variable
using the old URL as value. For example, let's say we moved the document
https://docs.gitlab.com/my-old-location/README.html to a new location,
Into the new document front matter, we add the following information. You must
include the filename in the
disqus_identifier URL, even if it's
--- disqus_identifier: 'https://docs.gitlab.com/my-old-location/README.html' ---