Chore: Vale issue fixes
requested to merge gitlab-community/gitlab:386930-fix-vale-issues-for-administration/packages/container_registry.md into master
What does this MR do and why?
Addresses documentation issues in administration/packages/container_registry.md.
Screenshots or screen recordings
Before correction
vale doc/administration/packages/container_registry.md
doc/administration/packages/container_registry.md
1:1 suggestion The grade level is 8.77. Aim gitlab.ReadingLevel
for 8th grade or lower by
using shorter sentences and
words.
27:16 suggestion If possible, remove the gitlab.OutdatedVersions
reference to 'GitLab 12.'.
99:1 warning Instead of 'There are', try gitlab.UnclearAntecedent
starting this sentence with a
specific subject and verb.
117:1 suggestion Improve readability by using gitlab.SentenceLength
fewer than 25 words in this
sentence.
119:20 suggestion Remove 'respectively' and list gitlab.Wordy
each option instead.
124:1 suggestion Improve readability by using gitlab.SentenceLength
fewer than 25 words in this
sentence.
165:74 warning Instead of 'This is', try gitlab.UnclearAntecedent
starting this sentence with a
specific subject and verb.
264:36 warning Instead of 'This is', try gitlab.UnclearAntecedent
starting this sentence with a
specific subject and verb.
336:1 suggestion Improve readability by using gitlab.SentenceLength
fewer than 25 words in this
sentence.
341:5 suggestion Instead of uppercase for gitlab.Uppercase
'GCS', use lowercase or
backticks (`) if possible.
Otherwise, ask a Technical
Writer to add this word
or acronym to the rule's
exception list.
347:79 suggestion Improve readability by using gitlab.SentenceLength
fewer than 25 words in this
sentence.
361:25 warning Remove 'Simple'. Be precise gitlab.Simplicity
instead of subjective.
365:149 suggestion Improve readability by using gitlab.SentenceLength
fewer than 25 words in this
sentence.
442:23 warning Use 'documentation' instead of gitlab.SubstitutionWarning
'docs' when possible.
478:43 warning Use 'in' instead of 'within' gitlab.SubstitutionWarning
when possible.
560:21 warning Use 'because' or 'after' gitlab.SubstitutionWarning
instead of 'since' when
possible.
593:52 warning Instead of future tense 'will gitlab.FutureTense
be', use present tense.
595:42 warning Instead of future tense 'will gitlab.FutureTense
be', use present tense.
597:166 warning Instead of future tense 'will gitlab.FutureTense
use', use present tense.
600:1 suggestion Improve readability by using gitlab.SentenceLength
fewer than 25 words in this
sentence.
634:305 suggestion Improve readability by using gitlab.SentenceLength
fewer than 25 words in this
sentence.
681:45 suggestion Instead of uppercase for gitlab.Uppercase
'KMS', use lowercase or
backticks (`) if possible.
Otherwise, ask a Technical
Writer to add this word
or acronym to the rule's
exception list.
682:2 suggestion Instead of uppercase for gitlab.Uppercase
'SSE', use lowercase or
backticks (`) if possible.
Otherwise, ask a Technical
Writer to add this word
or acronym to the rule's
exception list.
682:12 suggestion Instead of uppercase for gitlab.Uppercase
'SSE', use lowercase or
backticks (`) if possible.
Otherwise, ask a Technical
Writer to add this word
or acronym to the rule's
exception list.
682:16 suggestion Instead of uppercase for gitlab.Uppercase
'KMS', use lowercase or
backticks (`) if possible.
Otherwise, ask a Technical
Writer to add this word
or acronym to the rule's
exception list.
683:10 warning Use inclusive language. gitlab.InclusionCultural
Consider 'primary, main'
instead of 'master'.
683:33 suggestion Instead of uppercase for gitlab.Uppercase
'SSE', use lowercase or
backticks (`) if possible.
Otherwise, ask a Technical
Writer to add this word
or acronym to the rule's
exception list.
683:67 warning Use 'because' or 'after' gitlab.SubstitutionWarning
instead of 'since' when
possible.
686:5 suggestion Instead of uppercase for gitlab.Uppercase
'SSE', use lowercase or
backticks (`) if possible.
Otherwise, ask a Technical
Writer to add this word
or acronym to the rule's
exception list.
729:1 warning Remove 'Currently'. The gitlab.CurrentStatus
documentation reflects the
current state of the product.
763:1 suggestion Improve readability by using gitlab.SentenceLength
fewer than 25 words in this
sentence.
768:144 warning Instead of future tense 'will gitlab.FutureTense
be', use present tense.
874:30 warning Use 'in' instead of 'within' gitlab.SubstitutionWarning
when possible.
927:22 suggestion Improve readability by using gitlab.SentenceLength
fewer than 25 words in this
sentence.
996:20 warning Use 'in' instead of 'within' gitlab.SubstitutionWarning
when possible.
1003:26 warning Remove 'Currently'. The gitlab.CurrentStatus
documentation reflects the
current state of the product.
1040:63 suggestion Improve readability by using gitlab.SentenceLength
fewer than 25 words in this
sentence.
1078:1 warning Instead of 'This is', try gitlab.UnclearAntecedent
starting this sentence with a
specific subject and verb.
1093:1 warning Use 'because' or 'after' gitlab.SubstitutionWarning
instead of 'Since' when
possible.
1097:42 warning Use a comma before the last gitlab.OxfordComma
'and' or 'or' in a list of
four or more items.
1139:133 warning Instead of future tense 'will gitlab.FutureTense
bring', use present tense.
1174:1 suggestion Improve readability by using gitlab.SentenceLength
fewer than 25 words in this
sentence.
1197:89 suggestion Improve readability by using gitlab.SentenceLength
fewer than 25 words in this
sentence.
1220:193 warning Instead of 'This is', try gitlab.UnclearAntecedent
starting this sentence with a
specific subject and verb.
1222:203 warning Instead of 'This is', try gitlab.UnclearAntecedent
starting this sentence with a
specific subject and verb.
1234:190 warning Instead of 'This is', try gitlab.UnclearAntecedent
starting this sentence with a
specific subject and verb.
1253:84 warning Use 'because' or 'after' gitlab.SubstitutionWarning
instead of 'Since' when
possible.
1306:1 suggestion Improve readability by using gitlab.SentenceLength
fewer than 25 words in this
sentence.
1384:1 suggestion Improve readability by using gitlab.SentenceLength
fewer than 25 words in this
sentence.
1479:1 suggestion Improve readability by using gitlab.SentenceLength
fewer than 25 words in this
sentence.
1480:79 suggestion Improve readability by using gitlab.SentenceLength
fewer than 25 words in this
sentence.
1485:7 warning Remove 'simple'. Be precise gitlab.Simplicity
instead of subjective.
1545:1 suggestion Improve readability by using gitlab.SentenceLength
fewer than 25 words in this
sentence.
1561:51 warning Use 'because' or 'after' gitlab.SubstitutionWarning
instead of 'since' when
possible.
1585:85 warning Use 'in' instead of 'within' gitlab.SubstitutionWarning
when possible.
1612:1 suggestion Improve readability by using gitlab.SentenceLength
fewer than 25 words in this
sentence.
1618:1 suggestion Improve readability by using gitlab.SentenceLength
fewer than 25 words in this
sentence.
1645:1 suggestion Improve readability by using gitlab.SentenceLength
fewer than 25 words in this
sentence.
1705:7 warning Use 'because' or 'after' gitlab.SubstitutionWarning
instead of 'since' when
possible.
1705:26 warning Use 'because' or 'after' gitlab.SubstitutionWarning
instead of 'since' when
possible.
1709:76 warning Use 'usually' or 'typically' gitlab.Normal
instead of 'Normally'.
1711:8 suggestion Improve readability by using gitlab.SentenceLength
fewer than 25 words in this
sentence.
1711:17 warning Use 'because' or 'after' gitlab.SubstitutionWarning
instead of 'since' when
possible.
1717:58 suggestion Improve readability by using gitlab.SentenceLength
fewer than 25 words in this
sentence.
1798:1 warning Use 'after the' instead of gitlab.SubstitutionWarning
'Once the' when possible.
✖ 0 errors, 33 warnings and 32 suggestions in 1 file.
After correction
vale doc/administration/packages/container_registry.md
doc/administration/packages/container_registry.md
1:1 suggestion The grade level is 8.77. Aim gitlab.ReadingLevel
for 8th grade or lower by
using shorter sentences and
words.
27:16 suggestion If possible, remove the gitlab.OutdatedVersions
reference to 'GitLab 12.'.
99:1 warning Instead of 'There are', try gitlab.UnclearAntecedent
starting this sentence with a
specific subject and verb.
117:1 suggestion Improve readability by using gitlab.SentenceLength
fewer than 25 words in this
sentence.
119:20 suggestion Remove 'respectively' and list gitlab.Wordy
each option instead.
124:1 suggestion Improve readability by using gitlab.SentenceLength
fewer than 25 words in this
sentence.
165:74 warning Instead of 'This is', try gitlab.UnclearAntecedent
starting this sentence with a
specific subject and verb.
264:36 warning Instead of 'This is', try gitlab.UnclearAntecedent
starting this sentence with a
specific subject and verb.
336:1 suggestion Improve readability by using gitlab.SentenceLength
fewer than 25 words in this
sentence.
341:5 suggestion Instead of uppercase for gitlab.Uppercase
'GCS', use lowercase or
backticks (`) if possible.
Otherwise, ask a Technical
Writer to add this word
or acronym to the rule's
exception list.
347:79 suggestion Improve readability by using gitlab.SentenceLength
fewer than 25 words in this
sentence.
361:25 warning Remove 'Simple'. Be precise gitlab.Simplicity
instead of subjective.
365:149 suggestion Improve readability by using gitlab.SentenceLength
fewer than 25 words in this
sentence.
442:23 warning Use 'documentation' instead of gitlab.SubstitutionWarning
'docs' when possible.
478:43 warning Use 'in' instead of 'within' gitlab.SubstitutionWarning
when possible.
560:21 warning Use 'because' or 'after' gitlab.SubstitutionWarning
instead of 'since' when
possible.
593:52 warning Instead of future tense 'will gitlab.FutureTense
be', use present tense.
595:42 warning Instead of future tense 'will gitlab.FutureTense
be', use present tense.
597:166 warning Instead of future tense 'will gitlab.FutureTense
use', use present tense.
600:1 suggestion Improve readability by using gitlab.SentenceLength
fewer than 25 words in this
sentence.
634:305 suggestion Improve readability by using gitlab.SentenceLength
fewer than 25 words in this
sentence.
681:45 suggestion Instead of uppercase for gitlab.Uppercase
'KMS', use lowercase or
backticks (`) if possible.
Otherwise, ask a Technical
Writer to add this word
or acronym to the rule's
exception list.
682:2 suggestion Instead of uppercase for gitlab.Uppercase
'SSE', use lowercase or
backticks (`) if possible.
Otherwise, ask a Technical
Writer to add this word
or acronym to the rule's
exception list.
682:12 suggestion Instead of uppercase for gitlab.Uppercase
'SSE', use lowercase or
backticks (`) if possible.
Otherwise, ask a Technical
Writer to add this word
or acronym to the rule's
exception list.
682:16 suggestion Instead of uppercase for gitlab.Uppercase
'KMS', use lowercase or
backticks (`) if possible.
Otherwise, ask a Technical
Writer to add this word
or acronym to the rule's
exception list.
683:10 warning Use inclusive language. gitlab.InclusionCultural
Consider 'primary, main'
instead of 'master'.
683:33 suggestion Instead of uppercase for gitlab.Uppercase
'SSE', use lowercase or
backticks (`) if possible.
Otherwise, ask a Technical
Writer to add this word
or acronym to the rule's
exception list.
683:67 warning Use 'because' or 'after' gitlab.SubstitutionWarning
instead of 'since' when
possible.
686:5 suggestion Instead of uppercase for gitlab.Uppercase
'SSE', use lowercase or
backticks (`) if possible.
Otherwise, ask a Technical
Writer to add this word
or acronym to the rule's
exception list.
729:1 warning Remove 'Currently'. The gitlab.CurrentStatus
documentation reflects the
current state of the product.
763:1 suggestion Improve readability by using gitlab.SentenceLength
fewer than 25 words in this
sentence.
768:144 warning Instead of future tense 'will gitlab.FutureTense
be', use present tense.
874:30 warning Use 'in' instead of 'within' gitlab.SubstitutionWarning
when possible.
927:22 suggestion Improve readability by using gitlab.SentenceLength
fewer than 25 words in this
sentence.
996:20 warning Use 'in' instead of 'within' gitlab.SubstitutionWarning
when possible.
1003:26 warning Remove 'Currently'. The gitlab.CurrentStatus
documentation reflects the
current state of the product.
1040:63 suggestion Improve readability by using gitlab.SentenceLength
fewer than 25 words in this
sentence.
1078:1 warning Instead of 'This is', try gitlab.UnclearAntecedent
starting this sentence with a
specific subject and verb.
1093:1 warning Use 'because' or 'after' gitlab.SubstitutionWarning
instead of 'Since' when
possible.
1097:42 warning Use a comma before the last gitlab.OxfordComma
'and' or 'or' in a list of
four or more items.
1174:1 suggestion Improve readability by using gitlab.SentenceLength
fewer than 25 words in this
sentence.
1197:89 suggestion Improve readability by using gitlab.SentenceLength
fewer than 25 words in this
sentence.
1220:193 warning Instead of 'This is', try gitlab.UnclearAntecedent
starting this sentence with a
specific subject and verb.
1222:203 warning Instead of 'This is', try gitlab.UnclearAntecedent
starting this sentence with a
specific subject and verb.
1234:190 warning Instead of 'This is', try gitlab.UnclearAntecedent
starting this sentence with a
specific subject and verb.
1253:84 warning Use 'because' or 'after' gitlab.SubstitutionWarning
instead of 'Since' when
possible.
1306:1 suggestion Improve readability by using gitlab.SentenceLength
fewer than 25 words in this
sentence.
1384:1 suggestion Improve readability by using gitlab.SentenceLength
fewer than 25 words in this
sentence.
1479:1 suggestion Improve readability by using gitlab.SentenceLength
fewer than 25 words in this
sentence.
1480:79 suggestion Improve readability by using gitlab.SentenceLength
fewer than 25 words in this
sentence.
1485:7 warning Remove 'simple'. Be precise gitlab.Simplicity
instead of subjective.
1545:1 suggestion Improve readability by using gitlab.SentenceLength
fewer than 25 words in this
sentence.
1561:51 warning Use 'because' or 'after' gitlab.SubstitutionWarning
instead of 'since' when
possible.
1585:85 warning Use 'in' instead of 'within' gitlab.SubstitutionWarning
when possible.
1612:1 suggestion Improve readability by using gitlab.SentenceLength
fewer than 25 words in this
sentence.
1618:1 suggestion Improve readability by using gitlab.SentenceLength
fewer than 25 words in this
sentence.
1645:1 suggestion Improve readability by using gitlab.SentenceLength
fewer than 25 words in this
sentence.
1705:7 warning Use 'because' or 'after' gitlab.SubstitutionWarning
instead of 'since' when
possible.
1705:26 warning Use 'because' or 'after' gitlab.SubstitutionWarning
instead of 'since' when
possible.
1711:8 suggestion Improve readability by using gitlab.SentenceLength
fewer than 25 words in this
sentence.
1711:17 warning Use 'because' or 'after' gitlab.SubstitutionWarning
instead of 'since' when
possible.
1717:58 suggestion Improve readability by using gitlab.SentenceLength
fewer than 25 words in this
sentence.
1798:1 warning Use 'after the' instead of gitlab.SubstitutionWarning
'Once the' when possible.
✖ 0 errors, 31 warnings and 32 suggestions in 1 file.How to set up and validate locally
Run vale doc/administration/packages/container_registry.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 @sselhorn
Related to #386930 (closed)
Edited by Ashvith