Skip to content

Fix typo on shared-secrets doc and make deprecations explicit

João Alexandre Cunha requested to merge docs-Alexand-master-patch-44707 into master

What does this MR do?

Fixes typos: Those references are not Gitaly ones, but shared-secrets related. This as very likely a copy/paste error.

More so, these shared-secrets.image.* have been deprecated in favor of global.kubectl.image.* since 2019: !864 (diffs).

It's easier to acknowledge their deprecations when learning about them from the docs, than testing the configs, and only learning about the deprecations when the Helm install command complains to you.

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 João Alexandre Cunha

Merge request reports