for users who view the docs on [`docs.gitlab.com`](https://docs.gitlab.com).
The Technical Writing team manages the [process](https://gitlab.com/gitlab-org/technical-writing/-/blob/master/.gitlab/issue_templates/tw-monthly-tasks.md)
to regularly update the [`redirects.yaml`](https://gitlab.com/gitlab-org/gitlab-docs/-/blob/master/content/_data/redirects.yaml)
file.
To add a redirect:
To add a redirect:
1. In an MR in one of the internal docs projects (`gitlab`, `gitlab-runner`, `omnibus-gitlab`
1. Create a merge request in one of the internal docs projects (`gitlab`,
or `charts`):
`gitlab-runner`, `omnibus-gitlab`, or `charts`), depending on the location of
1. Move or rename the doc, but do not delete the old doc.
the file that's being moved, renamed, or removed.
1. In the old doc, add the redirect code for `/help`. Use the following template exactly,
1. To move or rename the documentation file, create a new file with the new
and only change the links and date. Use relative paths and `.md` for a redirect
name or location, but don't delete the existing documentation file.
to another docs page. Use the full URL to redirect to a different project or site:
1. In the original documentation file, add the redirect code for
`/help`. Use the following template exactly, and change only the links and
date. Use relative paths and `.md` for a redirect to another documentation
page. Use the full URL (with `https://`) to redirect to a different project or
site:
```markdown
```markdown
---
---
...
@@ -195,61 +205,25 @@ To add a redirect:
...
@@ -195,61 +205,25 @@ To add a redirect:
<!-- Before deletion, see: https://docs.gitlab.com/ee/development/documentation/#move-or-rename-a-page -->
<!-- Before deletion, see: https://docs.gitlab.com/ee/development/documentation/#move-or-rename-a-page -->
```
```
Redirect files linking to docs in any of the 4 internal docs projects can be
Redirect files linking to docs in any of the internal documentations projects
removed after 3 months. Redirect files linking to external sites can be removed
are removed after three months. Redirect files linking to external sites are
after 1 year.
removed after one year.
1. If the document being moved has any Disqus comments on it, follow the steps
1. If the documentation page being moved has any Disqus comments, follow the steps
described in [Redirections for pages with Disqus comments](#redirections-for-pages-with-disqus-comments).
described in [Redirections for pages with Disqus comments](#redirections-for-pages-with-disqus-comments).
1. If a documentation page you're removing includes images that aren't used
1. If a documentation page you're removing includes images that aren't used
with any other documentation pages, be sure to use your MR to delete
with any other documentation pages, be sure to use your merge request to delete
those images from the repository.
those images from the repository.
1. Assign the MR to a technical writer for review and merge.
1. Assign the merge request to a technical writer for review and merge.
1. If the redirect is to one of the 4 internal docs projects (not an external URL),
1. Search for links to the original documentation file. You must find and update all
create an MR in [`gitlab-docs`](https://gitlab.com/gitlab-org/gitlab-docs):
links that point to the original documentation file: