Chore: Fix Vale issues
requested to merge gitlab-community/gitlab:387423-fix-vale-issues-for-raketasks/import.md into master
What does this MR do and why?
Addresses documentation issues in raketasks/import.md.
Screenshots or screen recordings
Before correction
vale doc/raketasks/import.md
doc/raketasks/import.md
1:1 suggestion The grade level is 9.48. Aim gitlab.ReadingLevel
for 8th grade or lower by
using shorter sentences and
words.
11:20 warning Instead of future tense 'will gitlab.FutureTense
be', use present tense.
26:1 suggestion Remove the phrase 'note that'. gitlab.Wordy
109:19 warning Instead of 'This is', try gitlab.UnclearAntecedent
starting this sentence with a
specific subject and verb.
116:5 suggestion If possible, remove the gitlab.OutdatedVersions
reference to 'GitLab 10.'.
120:5 suggestion If possible, remove the gitlab.OutdatedVersions
reference to 'GitLab 10.'.
122:1 suggestion Improve readability by using gitlab.SentenceLength
fewer than 25 words in this
sentence.
122:61 suggestion If possible, remove the gitlab.OutdatedVersions
reference to 'GitLab 10.'.
134:15 suggestion If possible, remove the gitlab.OutdatedVersions
reference to 'GitLab 10.'.
143:45 suggestion If possible, remove the gitlab.OutdatedVersions
reference to 'GitLab 10.'.
143:60 suggestion If possible, remove the gitlab.OutdatedVersions
reference to 'GitLab 11.'.
145:21 suggestion If possible, remove the gitlab.OutdatedVersions
reference to 'GitLab 10.'.
146:133 suggestion If possible, remove the gitlab.OutdatedVersions
reference to 'GitLab 10.'.
146:148 suggestion If possible, remove the gitlab.OutdatedVersions
reference to 'GitLab 11.'.
147:62 suggestion If possible, remove the gitlab.OutdatedVersions
reference to 'GitLab 10.'.
147:77 suggestion If possible, remove the gitlab.OutdatedVersions
reference to 'GitLab 11.'.
149:5 suggestion If possible, remove the gitlab.OutdatedVersions
reference to 'GitLab 11.'.
152:48 suggestion If possible, remove the gitlab.OutdatedVersions
reference to 'GitLab 10.'.
152:63 suggestion If possible, remove the gitlab.OutdatedVersions
reference to 'GitLab 11.'.
161:1 suggestion Improve readability by using gitlab.SentenceLength
fewer than 25 words in this
sentence.
162:46 warning Add a space between the number gitlab.Units
and the unit in '1000s'.
✖ 0 errors, 3 warnings and 18 suggestions in 1 file.
After correction
vale doc/raketasks/import.md
doc/raketasks/import.md
1:1 suggestion The grade level is 9.48. Aim gitlab.ReadingLevel
for 8th grade or lower by
using shorter sentences and
words.
11:20 warning Instead of future tense 'will gitlab.FutureTense
be', use present tense.
109:19 warning Instead of 'This is', try gitlab.UnclearAntecedent
starting this sentence with a
specific subject and verb.
116:5 suggestion If possible, remove the gitlab.OutdatedVersions
reference to 'GitLab 10.'.
120:5 suggestion If possible, remove the gitlab.OutdatedVersions
reference to 'GitLab 10.'.
122:1 suggestion Improve readability by using gitlab.SentenceLength
fewer than 25 words in this
sentence.
122:61 suggestion If possible, remove the gitlab.OutdatedVersions
reference to 'GitLab 10.'.
134:15 suggestion If possible, remove the gitlab.OutdatedVersions
reference to 'GitLab 10.'.
143:45 suggestion If possible, remove the gitlab.OutdatedVersions
reference to 'GitLab 10.'.
143:60 suggestion If possible, remove the gitlab.OutdatedVersions
reference to 'GitLab 11.'.
145:21 suggestion If possible, remove the gitlab.OutdatedVersions
reference to 'GitLab 10.'.
146:133 suggestion If possible, remove the gitlab.OutdatedVersions
reference to 'GitLab 10.'.
146:148 suggestion If possible, remove the gitlab.OutdatedVersions
reference to 'GitLab 11.'.
147:62 suggestion If possible, remove the gitlab.OutdatedVersions
reference to 'GitLab 10.'.
147:77 suggestion If possible, remove the gitlab.OutdatedVersions
reference to 'GitLab 11.'.
149:5 suggestion If possible, remove the gitlab.OutdatedVersions
reference to 'GitLab 11.'.
152:48 suggestion If possible, remove the gitlab.OutdatedVersions
reference to 'GitLab 10.'.
152:63 suggestion If possible, remove the gitlab.OutdatedVersions
reference to 'GitLab 11.'.
161:1 suggestion Improve readability by using gitlab.SentenceLength
fewer than 25 words in this
sentence.
✖ 0 errors, 2 warnings and 17 suggestions in 1 file.How to set up and validate locally
Run vale doc/raketasks/import.md
MR acceptance checklist
This checklist encourages us to confirm any changes have been analyzed to reduce risks in quality, performance, reliability, security, and maintainability.
-
I have evaluated the MR acceptance checklist for this MR.
/cc @kpaizee
Related to #387423 (closed)
Edited by Ashvith