Skip to content

Move ref arch troubleshooting docs to feature pages

Justin Farmiloe requested to merge docs-jfarmiloe-ref-arch-ts into master

What does this MR do?

Deduplicates and moves reference architecture troubleshooting docs to be inline with related features as part of Move troubleshooting documentation inline to where the features are epic.

In this case the reference architecture troubleshooting page appears to have been created deliberately as a collection of a subset of troubleshooting items copied from other places. As a result of the requirement to check for and remove duplicated items all of the contents of the page have been removed, and the page has been converted to a temporary redirect to the base GitLab configuration page.

If this MR is merged, another MR should be made to remove the navigation entry for the page from https://gitlab.com/gitlab-org/gitlab-docs/-/blob/main/content/_data/navigation.yaml#L324.

Related issues

Resolves #367264 (closed), #367267 (closed), #367268 (closed), #367269 (closed), #367270 (closed), #367272 (closed), #367273 (closed)

Author's checklist

If you are a GitLab team member and only adding documentation, do not add any of the following labels:

  • ~"frontend"
  • ~"backend"
  • ~"type::bug"
  • ~"database"

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

Reviewer's 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.
    • Ensure a release milestone is set.
    • 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 reviews above. Maintainer's review can occur before or after a technical writer review.
Edited by Justin Farmiloe

Merge request reports