Skip to content

docs: Move links to child docs; secrets tweak

Ben Prescott_ requested to merge docs/bprescott/20220412-chartsbackups into master

What does this MR do?

The links to backup and restore are at the bottom of the page just above troubleshooting. The majority of traffic to the parent page will need to route to these child documents, and in my opinion they should be easier to find. They shouldn't be below the fold.

I scrolled through this page, couldn't see what I wanted (secrets backups; it's on the child page) and the transition from GCP object storage details to troubleshooting masked the links I needed.

It's also not obvious there are child documents at all if the twisty is not being rendered properly by the customer's browser. Don't know what's going on here, but it took me multiple clicks to get this to expand.

image image image

Related issues

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 Ben Prescott_

Merge request reports