Skip to content

Fix Vale issues for ./administration/geo/replication/configuration.md

What does this MR do?

This MR fixes the Avoid using future tense vale warnings in administration/geo/replication/configuration.md.

Note: it fixes some additional Avoid using future tense warnings, which are not part of the original issue description.

What does this MR not do?

This MR does not fix the gitlab.SentenceLength or the gitlab.CurrentStatus rules.

 28:1    warning     Shorter sentences improve       gitlab.SentenceLength          
                     readability (max 25 words).                                    
 232:1   warning     Shorter sentences improve       gitlab.SentenceLength          
                     readability (max 25 words).                                    
 244:1   warning     Shorter sentences improve       gitlab.SentenceLength          
                     readability (max 25 words).                                    
 264:21  warning     Shorter sentences improve       gitlab.SentenceLength          
                     readability (max 25 words).                                    
 292:1   suggestion  Avoid words like "Currently"    gitlab.CurrentStatus           
                     that promise future changes,                                   
                     because documentation is                                       
                     about the current state of the                                 
                     product.                                                       
 304:74  warning     Shorter sentences improve       gitlab.SentenceLength          
                     readability (max 25 words).                                    
 313:6   suggestion  Consider "because" or "after"   gitlab.SubstitutionSuggestions 
                     instead of "Since".                                            
 313:16  suggestion  Avoid words like "currently"    gitlab.CurrentStatus           
                     that promise future changes,                                   
                     because documentation is                                       
                     about the current state of the                                 
                     product.                                                       
 325:1   warning     Shorter sentences improve       gitlab.SentenceLength          
                     readability (max 25 words).       

Related issues

#328270 (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.

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