Skip to content

Draft: Warn users to use reference architectures

Christiaan Conover requested to merge doc-helm-ref-architectures into master

What does this MR do?

Our reference architectures for cloud native deployment recommend against deploying all GitLab components with Kubernetes, but the Helm chart documentation does not make any such assertion nor link to the reference architectures for guidance. This is causing confusion for customers, and a sub-optimal experience for production deployments.

This merge request adds clarity in the Helm chart documentation that reference architectures should be consulted for production instances, and that customers should follow that guidance over the technical capabilities listed in the Helm chart documentation.

Related issues

Closes gitlab-org/gitlab#351145 (moved)

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 Christiaan Conover

Merge request reports