Skip to content

Round 9: fix links (and table) in Charts repo

Amy Qualls requested to merge docs-aqualls-fix-links-round-9 into master

What does this MR do?

Updates the links I can fix in the Charts repo. It also includes a table spacing fix in a separate commit:

  • !3654 (78441eb7) starts the link fixes, as expected
  • !3654 (be03b37f) runs a table formatter over that HUGE table in doc/charts/registry/index.md because it was so over-padded that it was tough to read
  • !3654 (b11e1485) contains the rest of the link fixes I was able to deduce / reconstruct

I was not able to fix everything. I'll create threads for the unfixed links and explain why.

Related issues

Related to Docs project maintenance tasks, March 2024 (gitlab-org/technical-writing#1006)

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.
Edited by Amy Qualls

Merge request reports