Skip to content

Add rule to avoid HA and scalability references

Craig Norris requested to merge docs-avoid-high-availability into master

What does this MR do?

Per work that has been done with creating reference architecture pages for scaling GitLab to allow for better performance for more users, the terms scalability and high availability (HA) should not be used in the documentation to refer to GitLab. As such, this MR adds specific rules for those terms to the documentation style guide.

Related issues

!30781 (merged)

gitlab-com/Product#1160 (closed)

Author's checklist (required)

When applicable:

Review checklist

All reviewers can help ensure accuracy, clarity, completeness, and adherence to the Documentation Guidelines and Style Guide.

1. Primary Reviewer

  • Review by a code reviewer or other selected colleague to confirm accuracy, clarity, and completeness. This can be skipped for minor fixes without substantive content changes.

2. Technical Writer

  • Optional: Technical writer review. If not requested for this MR, must be scheduled post-merge. To request for this MR, assign the writer listed for the applicable DevOps stage.

3. Maintainer

  1. Review by assigned maintainer, who can always request/require the above reviews. Maintainer's review can occur before or after a technical writer review.
  2. Ensure a release milestone is set.
  3. If there has not been a technical writer review, create an issue for one using the Doc Review template.
Edited by GitLab Release Tools Bot

Merge request reports