Skip to content

Fixed Vale future tense errors

Suzanne Selhorn requested to merge docs-selhorn-vale-future-1 into master

What does this MR do?

This docs MR fixes the following future tense issues from the Vale linter:

docs/best_practice/index.md
58:209  error  Avoid using future tense: "will fail". Use present tense instead.  gitlab.FutureTense


docs/configuration/init.md
8:11   error  Avoid using future tense: "will install". Use present tense instead.  gitlab.FutureTense
12:74  error  Avoid using future tense: "will be". Use present tense instead.       gitlab.FutureTense
22:41  error  Avoid using future tense: "you'll want". Use present tense instead.   gitlab.FutureTense
26:56  error  Avoid using future tense: "will kill". Use present tense instead.     gitlab.FutureTense
43:29  error  Avoid using future tense: "will use". Use present tense instead.      gitlab.FutureTense
46:1   error  Avoid using future tense: "will just". Use present tense instead.     gitlab.FutureTense
59:29  error  Avoid using future tense: "will do". Use present tense instead.       gitlab.FutureTense


docs/configuration/proxy.md
32:36   error  Avoid using future tense: "will be". Use present tense instead.    gitlab.FutureTense
33:7    error  Avoid using future tense: "won't.". Use present tense instead.     gitlab.FutureTense
158:59  error  Avoid using future tense: "will be". Use present tense instead.    gitlab.FutureTense
180:71  error  Avoid using future tense: "will have". Use present tense instead.  gitlab.FutureTense
184:48  error  Avoid using future tense: "will be". Use present tense instead.    gitlab.FutureTense
189:1   error  Avoid using future tense: "will look". Use present tense instead.  gitlab.FutureTense
191:54  error  Avoid using future tense: "will have". Use present tense instead.  gitlab.FutureTense


docs/commands/README.md
593:54  error  Avoid using future tense: "will be". Use present tense instead.  gitlab.FutureTense

Related issues

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

  • 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