Commit 6366725f authored by Craig Norris's avatar Craig Norris

Merge branch 'docs-deletions-styleguide' into 'master'

Make clear that doc deletions need redirects

See merge request gitlab-org/gitlab!70885
parents e1a69eac 0726e2dc
...@@ -142,7 +142,7 @@ Nanoc layout), which is displayed at the top of the page if defined. ...@@ -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 The `type` metadata parameter is deprecated but still exists in documentation
pages. You can safely remove the `type` metadata parameter and its values. pages. You can safely remove the `type` metadata parameter and its values.
## Move or rename a page ## Move, rename, or delete a page
See [redirects](redirects.md). See [redirects](redirects.md).
......
...@@ -15,13 +15,26 @@ description: Learn how to contribute to GitLab Documentation. ...@@ -15,13 +15,26 @@ description: Learn how to contribute to GitLab Documentation.
# Redirects in GitLab documentation # Redirects in GitLab documentation
Moving or renaming a document is the same as changing its location. Be sure When you move, rename, or delete a page, you must add a redirect. Redirects reduce
to assign a technical writer to any merge request that renames or moves a page. how often users get 404s when visiting the documentation site from out-of-date links, like:
Technical Writers can help with any questions and can review your change.
- 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. - Users see the new page and can update or delete their bookmark.
This ensures users find the new page, and have the opportunity to update their - External sites can update their links, especially sites that have automation that
bookmarks. 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: There are two types of redirects:
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment