Skip to content

Docs: Note that chart installations are advanced

Andrew Conrad requested to merge doc-advanced-config into master

What does this MR do?

I have seen in multiple places that customers didn't understand what they were getting into when starting a Helm chart deployment of GitLab. This merge request adds a section to the installation page to note that this is an advanced configuration that requires expertise.

We have a similar warning in each of the cloud native hybrid architecture sections of each reference architecture. For example, the 2k reference architecture, with the following text:

This is an advanced setup. Running services in Kubernetes is well known to be complex. This setup is only recommended if you have strong working knowledge and experience in Kubernetes. The rest of this section assumes this.

We may consider adding more warnings (like in the home page for the helm chart, or the cloud native GitLab page), and/or linking any other warnings to the section this is adding.

Related issues

This was specifically motivated by a particular support ticket (internal).

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 Andrew Conrad

Merge request reports