Docs: Add missing redirects to /workflow and /articles docs
What does this MR do?
Many docs are moved, and the old location has a simple This document was moved...
line and the redirect_to
frontmatter to automatically push the users to the right page (saving a click). Unfortunately, not all docs have the automatic redirect, forcing users to drop into a holding page, then click through.
This MR adds the redirect_to
frontmatter to all moved docs in /workflow and /articles that are missing it.
Related issues
https://gitlab.com/gitlab-com/gitlab-docs/issues/349
Author's checklist
-
Follow the Documentation Guidelines and Style Guide. -
Link docs to and from the higher-level index page, plus other related docs where helpful. -
Apply the ~Documentation label.
Review checklist
All reviewers can help ensure accuracy, clarity, completeness, and adherence to the Documentation Guidelines and Style Guide.
1. Primary Reviewer
-
Review by a code reviewer or other selected colleague to confirm accuracy, clarity, and completeness. This can be skipped for minor fixes without substantive content changes.
2. Technical Writer
-
Optional: Technical writer review. If not requested for this MR, must be scheduled post-merge. To request for this MR, assign the writer listed for the applicable DevOps stage.
3. Maintainer
-
Review by assigned maintainer, who can always request/require the above reviews. Maintainer's review can occur before or after a technical writer review. -
Ensure a release milestone is set and that you merge the equivalent EE MR before the CE MR if both exist. -
If there has not been a technical writer review, create an issue for one using the Doc Review template.
Merge request reports
Activity
/cc @marcia FYI, it looks like a lot to review, but you just need to double check that the URL matches in both links in each doc, so it should only take a few minutes to scan through the diff view.
Edited by Marcel Amiraultadded Community contribution label
assigned to @marcia
added documentation + 1 deleted label
1 --- 2 redirect_to: '../../administration/auth/how_to_configure_ldap_gitlab_ce/index.md' 3 --- 4 1 5 This document was moved to [another location](../../administration/auth/how_to_configure_ldap_gitlab_ce/index.md). @Ravlen just quick observation here. When the terminology is exactly as in this sentence:
This document was moved to [another location](path/to/file.md).
we should leave it as-is. It serves for/help
. https://docs.gitlab.com/ce/development/documentation/#changing-document-location@marcia OK, I understand the other discussion below (to change the text to
another location
), but in this case here, are you saying it is wrong to add the redirect? The docs say:Note: This redirection method will not provide a redirect fallback on GitLab /help. When using it, make sure to add a link to the new page on the doc, otherwise it’s a dead end for users that land on the doc via /help
So I took this to mean that putting a redirect AND a link for /help would work, meaning the automatic redirect and the
another location
link can work together?But by leaving both we're triggering two 302 redirects, which should be avoided, right?
Edited by Marcia Ramos
- Resolved by Marcel Amirault
assigned to @Ravlen
Thanks @Ravlen
I wanted to tackle this for sooo long :)changed milestone to %11.10
assigned to @axil
marked the checklist item Optional: Technical writer review. If not requested for this MR, must be scheduled post-merge. To request for this MR, assign the writer listed for the applicable DevOps stage. as completed
mentioned in commit c476f72d
mentioned in issue gitlab-org/release/tasks#731 (closed)