Skip to content

Docs: Fix Vale issues for multiple_servers.md

What does this MR do?

Fixes Vale issues for multiple_servers.md.

Before:

 20:1    warning     Shorter sentences improve       gitlab.SentenceLength
                     readability (max 25 words).
 22:77   suggestion  Consider "in" instead of        gitlab.SubstitutionSuggestions
                     "within".
 47:1    warning     Shorter sentences improve       gitlab.SentenceLength
                     readability (max 25 words).
 63:1    warning     Shorter sentences improve       gitlab.SentenceLength
                     readability (max 25 words).
 93:1    warning     Shorter sentences improve       gitlab.SentenceLength
                     readability (max 25 words).
 124:35  warning     Shorter sentences improve       gitlab.SentenceLength
                     readability (max 25 words).
 148:6   suggestion  Avoid words like "currently"    gitlab.CurrentStatus
                     that promise future changes,
                     because documentation is
                     about the current state of the
                     product.
 368:1   warning     Shorter sentences improve       gitlab.SentenceLength
                     readability (max 25 words).

✖ 0 errors, 6 warnings and 2 suggestions

After:

 149:6  suggestion  Avoid words like "currently"    gitlab.CurrentStatus
                    that promise future changes,
                    because documentation is
                    about the current state of the
                    product.

✔ 0 errors, 0 warnings and 1 suggestion

Related issues

Closes #329046 (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.

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.

For suggestions that you are confident don't need to be reviewed, change them locally and push a commit directly to save others from unneeded reviews. For example:

  • Clear typos, like this is a typpo.
  • Minor issues, like single quotes instead of double quotes, Oxford commas, and periods.

For more information, see our documentation on Merging a merge request.

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