Skip to content

Create a Vale rule for the word "GitLab's" in docs

Amy Qualls requested to merge 199274-docs-linting-gitlab-name into master

What does this MR do?

Using "GitLab's" as a shortened form of "GitLab is" or "GitLab was" is not acceptable in our style guide, but "GitLab's" as a possessive form is not acceptable. Since no automated test can distinguish between the two usages, this commit creates a test that provides a low-priority result encouraging the user to check the usage.

Related issues

Closes #199274 (closed)

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.
Edited by Amy Qualls

Merge request reports

Loading