Skip to content

Amend docs redirect guidelines

What does this MR do?

Amend the redirects guidelines so that if the page to be renamed doesn't exist in a stable branch, you may skip the inline redirect and proceed to adding only the Pages redirect.

The redirect guidelines say to not remove the old file that is redirected, and one of the reasons to do that is /help:

Redirect added into the documentation files themselves, for users who view the docs in /help on self-managed instances.

But what happens if I add a page on the 3rd and then rename it before it gets added in the stable branch on the 18th? The old page will never be part of /help. In that case, we can jump straight to the Pages redirect.

Related issues

Discussed in !69250 (comment 667858488).

Author's checklist

If you are only adding documentation, do not add any of the following labels:

  • ~"feature"
  • ~"frontend"
  • ~"backend"
  • ~"bug"
  • ~"database"

These labels cause the MR to be added to code verification QA issues.

Review checklist

Documentation-related MRs should be reviewed by a Technical Writer for a non-blocking review, based on Documentation Guidelines and the Style Guide.

  • If the content requires it, ensure the information is reviewed by a subject matter expert.
  • Technical writer review items:
    • Ensure docs metadata is present and up-to-date.
    • Ensure the appropriate labels are added to this MR.
    • If relevant to this MR, ensure content topic type principles are in use, including:
      • The headings should be something you'd do a Google search for. Instead of Default behavior, say something like Default behavior when you close an issue.
      • The headings (other than the page title) should be active. Instead of Configuring GDK, say something like Configure GDK.
      • Any task steps should be written as a numbered list.
      • If the content still needs to be edited for topic types, you can create a follow-up issue with the docs-technical-debt label.
  • 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.

Merge request reports

Loading