Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Support
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
G
gitlab-ce
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Issues
0
Issues
0
List
Boards
Labels
Milestones
Merge Requests
1
Merge Requests
1
Analytics
Analytics
Repository
Value Stream
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Commits
Issue Boards
Open sidebar
nexedi
gitlab-ce
Commits
0726e2dc
Commit
0726e2dc
authored
Sep 23, 2021
by
Marcel Amirault
Committed by
Craig Norris
Sep 23, 2021
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Make clear that doc deletions need redirects
parent
182ea073
Changes
2
Hide whitespace changes
Inline
Side-by-side
Showing
2 changed files
with
20 additions
and
7 deletions
+20
-7
doc/development/documentation/index.md
doc/development/documentation/index.md
+1
-1
doc/development/documentation/redirects.md
doc/development/documentation/redirects.md
+19
-6
No files found.
doc/development/documentation/index.md
View file @
0726e2dc
...
...
@@ -142,7 +142,7 @@ Nanoc layout), which is displayed at the top of the page if defined.
The `type` metadata parameter is deprecated but still exists in documentation
pages. You can safely remove the `type` metadata parameter and its values.
## Move
or renam
e a page
## Move
, rename, or delet
e a page
See [redirects](redirects.md).
...
...
doc/development/documentation/redirects.md
View file @
0726e2dc
...
...
@@ -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:
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment