Skip to content

Fixes many instances of misused terms

Evan Read requested to merge eread/fix-misused-terms into master

What does this MR do?

Fixes man instances of: https://about.gitlab.com/handbook/communication/#top-misused-terms (not all, in order to keep MR small).

These instances were detected by the Vale rule: https://gitlab.com/gitlab-org/gitlab/-/blob/0203f7d447aa450aa6d0698bbac2763b539ff993/doc/.linting/vale/styles/gitlab/Substitutions.yml.

Because this is straight out of the company handbook, I think we should work toward getting all instances fixed, and the rule elevated to error.

The rule seems to detect the same results whether or not we run with --ignore-syntax, so we don't need to do anything special with the existing CI invocation.

CC @gl-docsteam for visibility.

Author's checklist

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.

Merge request reports

Loading