Skip to content
Snippets Groups Projects

Docs: Add missing redirects to /workflow and /articles docs

Merged Marcel Amirault requested to merge (removed):docs-redirects1 into master
1 unresolved thread

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

  1. Review by assigned maintainer, who can always request/require the above reviews. Maintainer's review can occur before or after a technical writer review.
  2. Ensure a release milestone is set and that you merge the equivalent EE MR before the CE MR if both exist.
  3. If there has not been a technical writer review, create an issue for one using the Doc Review template.
Edited by Achilleas Pipinellis

Merge request reports

Loading
Loading

Activity

Filter activity
  • Approvals
  • Assignees & reviewers
  • Comments (from bots)
  • Comments (from users)
  • Commits & branches
  • Edits
  • Labels
  • Lock status
  • Mentions
  • Merge request status
  • Tracking
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

  • Author Contributor

    @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?

  • Yes, having both is fine :)

    Two-fold purpose:

    1. Nanoc first check for the frontmatter link.
    2. The moved to another location text serves for /help and when browsing the repo.
  • But by leaving both we're triggering two 302 redirects, which should be avoided, right? :thinking:

    Edited by Marcia Ramos
  • Please register or sign in to reply
  • assigned to @Ravlen

  • added 1 commit

    • 401b8d25 - Update link text in redirect

    Compare with previous version

  • Achilleas Pipinellis resolved all discussions

    resolved all discussions

  • Thanks @Ravlen :rocket: I wanted to tackle this for sooo long :)

  • Achilleas Pipinellis marked the checklist item Apply the ~Documentation label. as completed

    marked the checklist item Apply the ~Documentation label. as completed

  • changed milestone to %11.10

  • assigned to @axil

  • Achilleas Pipinellis marked the checklist item 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. as completed

    marked the checklist item 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. as completed

  • Achilleas Pipinellis 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

    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

  • Achilleas Pipinellis marked the checklist item Review by assigned maintainer, who can always request/require the above reviews. Maintainer's review can occur before or after a technical writer review. as completed

    marked the checklist item Review by assigned maintainer, who can always request/require the above reviews. Maintainer's review can occur before or after a technical writer review. as completed

  • Achilleas Pipinellis marked the checklist item Ensure a release milestone is set and that you merge the equivalent EE MR before the CE MR if both exist. as completed

    marked the checklist item Ensure a release milestone is set and that you merge the equivalent EE MR before the CE MR if both exist. as completed

  • Achilleas Pipinellis approved this merge request

    approved this merge request

  • mentioned in commit c476f72d

  • Please register or sign in to reply
    Loading