Skip to content

K8s install page: move troubleshooting info, tackle 2 subheads

Amy Qualls requested to merge docs-aqualls-k8s-structure1 into main

What does this MR do?

As part of technical-writing#1075 (closed) (and a follow-up to !5030 (merged)), let's tackle two discrete parts of docs/install/kubernetes.md:

  • Move troubleshooting subheadings to a separate page, and clean those up.
  • Shift the first couple of subheadings into ordered-list format. (I see a pile of H3s in the next section, Configuring, so I'm stopping here to prevent reviewer pain.)

Related issues

Related to FY25Q3 TW OKR: Refactor high visibility pages f... (technical-writing#1075 - 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 you aren't sure which tech writer to ask, use roulette or ask in the #docs Slack channel.

  • 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 above reviews. Maintainer's review can occur before or after a technical writer review.

Merge request reports

Loading