Skip to content

Remove unclear "Proof of Concept" wording

Manuel Grabowski requested to merge docs-mg-drop-poc-wording-20230727 into master

What does this MR do?

The "proof of concept" wording raised some concerns about Helm deployments themselves being officially supported or not. We use the terms "Beta", "Experimental" and "General Availability" to talk about various levels of official support, so the undefined term here can cause confusion.

Related issues

Slack conversation for context:

Hi team, would we support our customers around features that are in a PoC phase (e.g. GitLab Helm Chart or GitLab Operator)? Could they open a ticket if they face any issues?

Thanks a lot! So if it's not stated as Beta / Experiment in the documentation, it can be considered as GA? E.g. GitLab Operator is " is under active development and is not yet suitable for production use". Would that be considered as GA?

I think the “Proof of Concept” wording for Helm Charts and Operator only applies to the configuration examples we provide, not to “using GitLab with this technology”.

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 Manuel Grabowski

Merge request reports