summaryrefslogtreecommitdiff
path: root/doc/development/documentation/redirects.md
diff options
context:
space:
mode:
authorGitLab Bot <gitlab-bot@gitlab.com>2021-09-23 22:34:10 +0000
committerGitLab Bot <gitlab-bot@gitlab.com>2021-09-23 22:34:10 +0000
commit96855c4214715fe718c02a308ddd0e4a3265b5d1 (patch)
tree1dd318ede0a420effd7d0eb41a980c4adc24fae5 /doc/development/documentation/redirects.md
parent5248069bd6ee923a76047fa74dee46155c40fa2b (diff)
downloadgitlab-ce-96855c4214715fe718c02a308ddd0e4a3265b5d1.tar.gz
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc/development/documentation/redirects.md')
-rw-r--r--doc/development/documentation/redirects.md25
1 files changed, 19 insertions, 6 deletions
diff --git a/doc/development/documentation/redirects.md b/doc/development/documentation/redirects.md
index eb6878f5870..ef94c33a276 100644
--- a/doc/development/documentation/redirects.md
+++ b/doc/development/documentation/redirects.md
@@ -15,13 +15,26 @@ description: Learn how to contribute to GitLab Documentation.
# Redirects in GitLab documentation
-Moving or renaming a document is the same as changing its location. Be sure
-to assign a technical writer to any merge request that renames or moves a page.
-Technical Writers can help with any questions and can review your change.
+When you move, rename, or delete a page, you must add a redirect. Redirects reduce
+how often users get 404s when visiting the documentation site from out-of-date links, like:
+
+- Bookmarks
+- Links from external sites
+- Links from old blog posts
+- Links in the documentation site global navigation
+
+Add a redirect to ensure:
-When moving or renaming a page, you must redirect browsers to the new page.
-This ensures users find the new page, and have the opportunity to update their
-bookmarks.
+- Users see the new page and can update or delete their bookmark.
+- External sites can update their links, especially sites that have automation that
+ check for redirecting 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-docs` project.
+ If the redirect is missing, the `gitlab-docs` project's `main` branch 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.
There are two types of redirects: