Skip to content

Linter changes to future tense use and abbreviations

Anna-Lester requested to merge Anna-Lester/gitlab:patch-251 into master

What does this MR do?

Makes changes to documentation as suggested by Linter; future tense and suggested abbreviations for a more informal tone.

41:86 "it's" instead of "it is"
41:115 'no' instead of "will never be"
47:84 breaks instead if "will break"
59:82 "it's" instead of "it is"
63:64 'you may need' instead of "you'll need"
82:143 "can't" instead of"cannot"
84:16 'are not' instead of "will not"
84:82 'checks' instead of "will check"
84:143 'only prompts' instead of "will only prompt"
89:52 "can't" instead of "cannot"
197:51 need instead of "will need"
208:69 "you're" instead of "you are".
211:8 'are then' instead of "will be"
213:197 'are then' instead of "will be"
219:8 'are then' instead of "will be"
243:81 'is' instead of "will be"
255:71 'are' instead of "will be"

Related: #240991 (closed)

Author's checklist (required)

Do not add the feature, frontend, backend, ~"bug", or database labels if you are only updating documentation. These labels will cause the MR to be added to code verification QA issues.

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

  • 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.

For more information about labels, see Technical Writing workflows - Labels.

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 Marcin Sedlak-Jakubowski

Merge request reports