Skip to content

Remove mentions of performance problems

Luke Duncalfe requested to merge ld-alpha-docs-performance-issues into master

What does this MR do?

This MR changes the copy of our alpha and beta feature support doc to simply warn that alpha and beta features may be unstable, rather than may have performance problems which should still convey the original intention.

Text like "can cause performance and stability issues" are intended as warnings for customers rather than permitting us to release alpha or beta features that are un-performant.

However, my concern is that this could easily be misinterpreted by others internally and lead to us referencing this as policy so we merge an alpha or beta feature even if a reviewer has identified performance issues to be addressed.

Our development guidelines are clear that we cannot merge features that might harm performance, so we want to be clear here also that alpha or beta features should not harm performance. If an alpha or beta feature is in production and is harming performance, we are likely to want to act on it still.

Author's checklist

If you are a GitLab team member and only adding documentation, do not add any of the following labels:

  • ~"frontend"
  • ~"backend"
  • ~"type::bug"
  • ~"database"

These labels cause the MR to be added to code verification QA issues.

Reviewer's 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 you aren't sure which tech writer to ask, use roulette or ask in the #docs Slack channel.

  • 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.
    • Ensure a release milestone is set.
    • 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 reviews above. Maintainer's review can occur before or after a technical writer review.
Edited by Luke Duncalfe

Merge request reports

Loading