Run Vale and edit documentation pages for grammar, language, and style
vale doc/
[4mdoc/advanced/external-db/index.md[0m 1:1 [34msuggestion[0m The grade level - 7.90 - gitlab.ReadingLevel refers to how hard the content is to understand. Aim for 8th grade or lower by using shorter sentences and words. 44:34 [34msuggestion[0m Consider "in" instead of gitlab.SubstitutionSuggestions "Within".[4mdoc/advanced/external-db/external-omnibus-psql.md[0m 1:1 [34msuggestion[0m The grade level - 7.56 - gitlab.ReadingLevel
refers to how hard the content
is to understand. Aim for
8th grade or lower by using
shorter sentences and words.
9:1 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"We'll make". Use present
tense instead.
13:53 [33mwarning[0m 'This was' is not precise. gitlab.UnclearAntecedent
Try rewriting with a specific
subject and verb.
13:86 [33mwarning[0m 'KVM' is uppercase. Use gitlab.Uppercase
lowercase orbackticks
if
possible. Otherwise add this
word to the rule's exception
list.
20:245 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"we'll provide". Use present
tense instead.
65:29 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"we'll reconfigure". Use
present tense instead.
65:90 [34msuggestion[0m Consider "after the" instead gitlab.SubstitutionSuggestions of "Once the".[4mdoc/advanced/custom-images/index.md[0m 1:1 [34msuggestion[0m The grade level - 10.34 - gitlab.ReadingLevel refers to how hard the content
is to understand. Aim for
8th grade or lower by using
shorter sentences and words.
9:23 [33mwarning[0m Use "that is" instead of gitlab.LatinTerms
"i.e.", but consider rewriting
the sentence.
21:16 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will be". Use present tense
instead.[4mdoc/advanced/external-gitaly/external-omnibus-gitaly.md[0m 1:1 [34msuggestion[0m The grade level - 7.58 - gitlab.ReadingLevel
refers to how hard the content
is to understand. Aim for
8th grade or lower by using
shorter sentences and words.
14:53 [33mwarning[0m 'This was' is not precise. gitlab.UnclearAntecedent
Try rewriting with a specific
subject and verb.
14:86 [33mwarning[0m 'KVM' is uppercase. Use gitlab.Uppercase
lowercase orbackticks
if
possible. Otherwise add this
word to the rule's exception
list.
21:245 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"we'll provide". Use present
tense instead.
102:1 [34msuggestion[0m Consider "after the" instead gitlab.SubstitutionSuggestions of "Once the".[4mdoc/advanced/external-gitaly/index.md[0m 1:1 [34msuggestion[0m The grade level - 9.69 - gitlab.ReadingLevel
refers to how hard the content
is to understand. Aim for
8th grade or lower by using
shorter sentences and words.
25:29 [33mwarning[0m 'This is' is not precise. gitlab.UnclearAntecedent
Try rewriting with a specific
subject and verb.
25:66 [33mwarning[0m Rewrite "service(s)" to be gitlab.BadPlurals
plural, without parentheses.
27:42 [34msuggestion[0m Consider "in" instead of gitlab.SubstitutionSuggestions "within".
29:30 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will make". Use present tense
instead.
30:1 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
37:41 [34msuggestion[0m Consider "in" instead of gitlab.SubstitutionSuggestions "within".
130:1 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
133:11 [34msuggestion[0m Consider "because" or "after" gitlab.SubstitutionSuggestions instead of "since".
133:26 [34msuggestion[0m Consider "in" instead of gitlab.SubstitutionSuggestions "within".
133:45 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will be". Use present tense
instead.[4mdoc/advanced/external-gitlab-pages/index.md[0m 1:1 [34msuggestion[0m The grade level - 9.46 - gitlab.ReadingLevel
refers to how hard the content
is to understand. Aim for
8th grade or lower by using
shorter sentences and words.
9:1 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength readability (max 25 words).[4mdoc/advanced/external-nginx/index.md[0m 1:1 [34msuggestion[0m The grade level - 10.11 - gitlab.ReadingLevel
refers to how hard the content
is to understand. Aim for
8th grade or lower by using
shorter sentences and words.
13:12 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will help". Use present tense
instead.
18:282 [33mwarning[0m Use "that is" instead of gitlab.LatinTerms
"i.e.", but consider rewriting
the sentence.
18:441 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will differ". Use present
tense instead.
23:18 [34msuggestion[0m Consider "documentation" gitlab.SubstitutionSuggestions instead of "docs".
23:24 [33mwarning[0m Improve SEO and accessibility gitlab.MeaningfulLinkWords
by rewriting "here" in the
link text.
37:21 [34msuggestion[0m Consider "documentation" gitlab.SubstitutionSuggestions instead of "docs".
51:1 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
51:26 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will install". Use present
tense instead.
51:145 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will need". Use present tense
instead.
69:1 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will service". Use present
tense instead.
69:43 [34msuggestion[0m Consider "documentation" gitlab.SubstitutionSuggestions instead of "docs".
77:1 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
77:85 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will likely". Use present
tense instead.
88:1 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
89:60 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
89:111 [33mwarning[0m Improve SEO and accessibility gitlab.MeaningfulLinkWords
by rewriting "here" in the
link text.
91:32 [33mwarning[0m 'NOT' is uppercase. Use gitlab.Uppercase
lowercase orbackticks
if
possible. Otherwise add this
word to the rule's exception
list.[4mdoc/advanced/external-object-storage/azure-minio-gateway.md[0m 1:1 [34msuggestion[0m The grade level - 7.98 - gitlab.ReadingLevel
refers to how hard the content
is to understand. Aim for
8th grade or lower by using
shorter sentences and words.
9:193 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will make". Use present tense
instead.
60:131 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will be". Use present tense
instead.
72:1 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength readability (max 25 words).
72:85 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will store". Use present
tense instead.
89:99 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will be". Use present tense
instead.
89:147 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will be". Use present tense
instead.
89:197 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will be". Use present tense
instead.[4mdoc/advanced/external-mattermost/index.md[0m 1:1 [34msuggestion[0m The grade level - 9.91 - gitlab.ReadingLevel
refers to how hard the content
is to understand. Aim for
8th grade or lower by using
shorter sentences and words.
11:1 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
11:68 [34msuggestion[0m Consider "you should" instead gitlab.SubstitutionSuggestions of "it is recommended".
25:1 [34msuggestion[0m Consider "after you" instead gitlab.SubstitutionSuggestions of "Once you".
36:38 [34msuggestion[0m Remove this word from the gitlab.Wordy
sentence: "please".
41:69 [33mwarning[0m Improve SEO and accessibility gitlab.MeaningfulLinkWords
by rewriting "here" in the
link text.
59:1 [34msuggestion[0m Consider "after you" instead gitlab.SubstitutionSuggestions of "Once you".
67:25 [33mwarning[0m 'SSO' is uppercase. Use gitlab.Uppercase
lowercase orbackticks
if
possible. Otherwise add this
word to the rule's exception
list.
67:54 [33mwarning[0m Use standard single quotes or gitlab.NonStandardQuotes
double quotes only. Do not use
left or right quotes.
67:62 [33mwarning[0m 'SSO' is uppercase. Use gitlab.Uppercase
lowercase orbackticks
if
possible. Otherwise add this
word to the rule's exception
list.
67:65 [33mwarning[0m Use standard single quotes or gitlab.NonStandardQuotes
double quotes only. Do not use
left or right quotes.
67:81 [33mwarning[0m 'SSO' is uppercase. Use gitlab.Uppercase
lowercase orbackticks
if
possible. Otherwise add this
word to the rule's exception
list.
67:105 [33mwarning[0m 'SSO' is uppercase. Use gitlab.Uppercase
lowercase orbackticks
if
possible. Otherwise add this
word to the rule's exception
list.
67:138 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
68:21 [33mwarning[0m 'LDAP' is uppercase. Use gitlab.Uppercase
lowercase orbackticks
if
possible. Otherwise add this
word to the rule's exception
list.
68:27 [33mwarning[0m 'SAML' is uppercase. Use gitlab.Uppercase
lowercase orbackticks
if
possible. Otherwise add this
word to the rule's exception
list.
68:36 [33mwarning[0m 'MFA' is uppercase. Use gitlab.Uppercase
lowercase orbackticks
if
possible. Otherwise add this
word to the rule's exception
list.
68:109 [33mwarning[0m Use standard single quotes or gitlab.NonStandardQuotes
double quotes only. Do not use
left or right quotes.
73:1 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).[4mdoc/advanced/external-object-storage/minio.md[0m 1:1 [34msuggestion[0m The grade level - 10.21 - gitlab.ReadingLevel
refers to how hard the content
is to understand. Aim for
8th grade or lower by using
shorter sentences and words.
30:1 [34msuggestion[0m Consider "after the" instead gitlab.SubstitutionSuggestions of "Once the".[4mdoc/advanced/external-redis/external-omnibus-redis.md[0m 1:1 [34msuggestion[0m The grade level - 7.76 - gitlab.ReadingLevel
refers to how hard the content
is to understand. Aim for
8th grade or lower by using
shorter sentences and words.
13:53 [33mwarning[0m 'This was' is not precise. gitlab.UnclearAntecedent Try rewriting with a specific
subject and verb.
13:86 [33mwarning[0m 'KVM' is uppercase. Use gitlab.Uppercase
lowercase orbackticks
if
possible. Otherwise add this
word to the rule's exception
list.
20:245 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"we'll provide". Use present
tense instead.[4mdoc/advanced/fips/index.md[0m 1:1 [34msuggestion[0m The grade level - 10.84 - gitlab.ReadingLevel refers to how hard the content
is to understand. Aim for
8th grade or lower by using
shorter sentences and words.[4mdoc/advanced/external-redis/index.md[0m 1:1 [34msuggestion[0m The grade level - 9.10 - gitlab.ReadingLevel
refers to how hard the content
is to understand. Aim for
8th grade or lower by using
shorter sentences and words.
40:1 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength readability (max 25 words).[4mdoc/advanced/external-object-storage/aws-iam-roles.md[0m 1:1 [34msuggestion[0m The grade level - 9.51 - gitlab.ReadingLevel
refers to how hard the content
is to understand. Aim for
8th grade or lower by using
shorter sentences and words.
11:48 [33mwarning[0m 'IRSA' is uppercase. Use gitlab.Uppercase
lowercase orbackticks
if
possible. Otherwise add this
word to the rule's exception
list.
15:14 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will need". Use present tense
instead.
38:47 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will be". Use present tense
instead.
61:4 [33mwarning[0m 'NOT' is uppercase. Use gitlab.Uppercase
lowercase orbackticks
if
possible. Otherwise add this
word to the rule's exception
list.
62:1 [33mwarning[0m 'IRSA' is uppercase. Use gitlab.Uppercase
lowercase orbackticks
if
possible. Otherwise add this
word to the rule's exception
list.
62:20 [33mwarning[0m 'STS' is uppercase. Use gitlab.Uppercase
lowercase orbackticks
if
possible. Otherwise add this
word to the rule's exception
list.
63:45 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will attempt". Use present
tense instead.
64:70 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will fail". Use present tense
instead.
83:1 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength readability (max 25 words).
85:41 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength readability (max 25 words).
90:13 [33mwarning[0m 'IRSA' is uppercase. Use gitlab.Uppercase
lowercase orbackticks
if
possible. Otherwise add this
word to the rule's exception
list.
94:77 [33mwarning[0m 'OIDC' is uppercase. Use gitlab.Uppercase
lowercase orbackticks
if
possible. Otherwise add this
word to the rule's exception
list.
107:26 [33mwarning[0m 'OIDC' is uppercase. Use gitlab.Uppercase
lowercase orbackticks
if
possible. Otherwise add this
word to the rule's exception
list.
113:97 [33mwarning[0m Spelling check: "sideload"? gitlab.Spelling
123:4 [34msuggestion[0m Be concise: rewrite the gitlab.Wordy
sentence to not use "note
that".
192:1 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength readability (max 25 words).
208:1 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength readability (max 25 words).
209:11 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will not". Use present tense
instead.
209:67 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will be". Use present tense
instead.
211:12 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will require". Use present
tense instead.
214:1 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength readability (max 25 words).
215:1 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will assume". Use present
tense instead.
215:61 [33mwarning[0m 'STS' is uppercase. Use gitlab.Uppercase
lowercase orbackticks
if
possible. Otherwise add this
word to the rule's exception
list.
216:32 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength readability (max 25 words).
225:11 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will be". Use present tense
instead.
231:16 [33mwarning[0m 'STS' is uppercase. Use gitlab.Uppercase
lowercase orbackticks
if
possible. Otherwise add this
word to the rule's exception
list.
231:57 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will be". Use present tense
instead.[4mdoc/advanced/index.md[0m 1:1 [34msuggestion[0m The grade level - 11.05 - gitlab.ReadingLevel refers to how hard the content
is to understand. Aim for
8th grade or lower by using
shorter sentences and words.[4mdoc/advanced/external-object-storage/index.md[0m 1:1 [34msuggestion[0m The grade level - 7.75 - gitlab.ReadingLevel
refers to how hard the content
is to understand. Aim for
8th grade or lower by using
shorter sentences and words.
11:44 [34msuggestion[0m Consider "you should" instead gitlab.SubstitutionSuggestions of "we recommend".
29:25 [33mwarning[0m 'KMS' is uppercase. Use gitlab.Uppercase
lowercase orbackticks
if
possible. Otherwise add this
word to the rule's exception
list.
54:1 [34msuggestion[0m Remove this word from the gitlab.Wordy
sentence: "Please".
103:254 [33mwarning[0m 'GCS' is uppercase. Use gitlab.Uppercase
lowercase orbackticks
if
possible. Otherwise add this
word to the rule's exception
list.
175:12 [33mwarning[0m Rewrite "secret(s)" to be gitlab.BadPlurals
plural, without parentheses.
230:1 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
307:8 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will need". Use present tense
instead.[4mdoc/advanced/ubi/index.md[0m 1:1 [34msuggestion[0m The grade level - 8.77 - gitlab.ReadingLevel
refers to how hard the content
is to understand. Aim for
8th grade or lower by using
shorter sentences and words.
36:10 [33mwarning[0m Rename the subheading gitlab.HeadingContent
"Limitations", or re-purpose
the content elsewhere.
38:3 [34msuggestion[0m Avoid words like "Currently" gitlab.CurrentStatus
when you write about future
features. Our documentation is
about the current state of the
product.
42:80 [34msuggestion[0m Consider "because" or "after" gitlab.SubstitutionSuggestions instead of "Since".[4mdoc/architecture/architecture.md[0m 1:1 [34msuggestion[0m The grade level - 8.83 - gitlab.ReadingLevel
refers to how hard the content
is to understand. Aim for
8th grade or lower by using
shorter sentences and words.
21:21 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will be". Use present tense
instead.
22:6 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will allow". Use present
tense instead.
31:6 [33mwarning[0m 'CNG' is uppercase. Use gitlab.Uppercase
lowercase orbackticks
if
possible. Otherwise add this
word to the rule's exception
list.
33:52 [33mwarning[0m 'CNG' is uppercase. Use gitlab.Uppercase
lowercase orbackticks
if
possible. Otherwise add this
word to the rule's exception
list.
67:1 [33mwarning[0m 'This is' is not precise. gitlab.UnclearAntecedent Try rewriting with a specific
subject and verb.
78:53 [34msuggestion[0m Avoid words like "easily" that gitlab.Simplicity
imply ease of use, because
the user may find this action
hard.[4mdoc/advanced/internal-tls/index.md[0m 1:1 [34msuggestion[0m The grade level - 9.62 - gitlab.ReadingLevel
refers to how hard the content
is to understand. Aim for
8th grade or lower by using
shorter sentences and words.
10:13 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
22:47 [33mwarning[0m 'PKI' is uppercase. Use gitlab.Uppercase
lowercase orbackticks
if
possible. Otherwise add this
word to the rule's exception
list.
25:1 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
26:41 [33mwarning[0m 'CFSSL' is uppercase. Use gitlab.Uppercase
lowercase orbackticks
if
possible. Otherwise add this
word to the rule's exception
list.
30:13 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will:". Use present tense
instead.
42:43 [34msuggestion[0m Consider "in" instead of gitlab.SubstitutionSuggestions "within".
44:16 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will later". Use present
tense instead.
54:1 [33mwarning[0m The subheading "############# gitlab.HeadingDepth
## make and change into a
working directory" is nested
too deeply. Headings deeper
than H5 suggest the section or
page should be refactored.
58:1 [33mwarning[0m The subheading "############# gitlab.HeadingDepth
## setup environment" is
nested too deeply. Headings
deeper than H5 suggest the
section or page should be
refactored.
67:1 [33mwarning[0m The subheading "############# gitlab.HeadingDepth
## generate default CA config"
is nested too deeply. Headings
deeper than H5 suggest the
section or page should be
refactored.
79:1 [33mwarning[0m The subheading "############# gitlab.HeadingDepth
## load certificates into K8s"
is nested too deeply. Headings
deeper than H5 suggest the
section or page should be
refactored.
94:46 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will later". Use present
tense instead.
96:41 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will later". Use present
tense instead.
109:31 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will find". Use present tense
instead.
132:65 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
140:1 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
140:30 [34msuggestion[0m Consider "in" instead of gitlab.SubstitutionSuggestions "within".
141:47 [33mwarning[0m Spelling check: "refering"? gitlab.Spelling
154:1 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
191:1 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
192:56 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will traverse". Use present
tense instead.
196:1 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
196:15 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will terminate". Use present
tense instead.
198:57 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will also". Use present tense
instead.
202:9 [33mwarning[0m Spelling check: "compontent"? gitlab.Spelling
246:1 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
253:55 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will evidence". Use present
tense instead.
254:51 [33mwarning[0m Rewrite "certificate(s)" to be gitlab.BadPlurals
plural, without parentheses.
266:49 [34msuggestion[0m Consider "in" instead of gitlab.SubstitutionSuggestions "within".
267:58 [34msuggestion[0m Consider "in" instead of gitlab.SubstitutionSuggestions "within".[4mdoc/advanced/persistent-volumes/index.md[0m 1:1 [34msuggestion[0m The grade level - 8.74 - gitlab.ReadingLevel
refers to how hard the content
is to understand. Aim for
8th grade or lower by using
shorter sentences and words.
31:70 [33mwarning[0m 'PVC' is uppercase. Use gitlab.Uppercase
lowercase orbackticks
if
possible. Otherwise add this
word to the rule's exception
list.
34:12 [34msuggestion[0m Be concise: use 'to' rather gitlab.Wordy
than "in order to".
40:1 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
40:4 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will continue". Use present
tense instead.
71:41 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will first". Use present
tense instead.
138:1 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
143:10 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
144:129 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will only". Use present tense
instead.
145:24 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
149:1 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
222:1 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
277:1 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
281:1 [34msuggestion[0m Be concise: use 'to' rather gitlab.Wordy
than "In order to".
281:145 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will need". Use present tense
instead.
285:1 [33mwarning[0m 'There are' is not precise. gitlab.UnclearAntecedent
Try rewriting with a specific
subject and verb.
288:166 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will be". Use present tense
instead.
349:13 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will print". Use present
tense instead.
352:135 [33mwarning[0m If possible, use "file system" gitlab.SubstitutionWarning instead of "filesystem".
393:34 [33mwarning[0m 'PVC' is uppercase. Use gitlab.Uppercase
lowercase orbackticks
if
possible. Otherwise add this
word to the rule's exception
list.
429:1 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
436:1 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
437:5 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will also". Use present tense
instead.
443:155 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will need". Use present tense
instead.
444:107 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will be". Use present tense
instead.
444:144 [33mwarning[0m 'This is' is not precise. gitlab.UnclearAntecedent
Try rewriting with a specific
subject and verb.
447:3 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
449:27 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will recreate". Use present
tense instead.
449:64 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will adopt". Use present
tense instead.[4mdoc/architecture/goals.md[0m 1:1 [34msuggestion[0m The grade level - 8.97 - gitlab.ReadingLevel
refers to how hard the content
is to understand. Aim for
8th grade or lower by using
shorter sentences and words.
11:4 [34msuggestion[0m Avoid words like "Easy" that gitlab.Simplicity
imply ease of use, because
the user may find this action
hard.
12:4 [34msuggestion[0m Avoid words like "Easy" that gitlab.Simplicity
imply ease of use, because
the user may find this action
hard.
19:4 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will launch". Use present
tense instead.
20:56 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will try". Use present tense
instead.
21:7 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will preclude". Use present
tense instead.
21:54 [33mwarning[0m 'This is' is not precise. gitlab.UnclearAntecedent
Try rewriting with a specific
subject and verb.
31:4 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will try". Use present tense
instead.
33:48 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will then". Use present tense
instead.
37:1 [34msuggestion[0m Consider "because" or "after" gitlab.SubstitutionSuggestions instead of "Since".
41:14 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will be". Use present tense
instead.
41:101 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will then". Use present tense
instead.
41:178 [33mwarning[0m 'This is' is not precise. gitlab.UnclearAntecedent
Try rewriting with a specific
subject and verb.
41:178 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
42:37 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will be". Use present tense
instead.
44:57 [34msuggestion[0m Avoid words like "easy" that gitlab.Simplicity
imply ease of use, because
the user may find this action
hard.[4mdoc/architecture/backup-restore.md[0m 1:1 [34msuggestion[0m The grade level - 8.80 - gitlab.ReadingLevel
refers to how hard the content
is to understand. Aim for
8th grade or lower by using
shorter sentences and words.
9:89 [33mwarning[0m 'CNG' is uppercase. Use gitlab.Uppercase
lowercase orbackticks
if
possible. Otherwise add this
word to the rule's exception
list.
13:148 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will act". Use present tense
instead.
23:2 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
52:109 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will be". Use present tense
instead.
60:195 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will use". Use present tense
instead.
67:37 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will be". Use present tense
instead.
67:88 [33mwarning[0m 'This is' is not precise. gitlab.UnclearAntecedent Try rewriting with a specific
subject and verb.
73:117 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
79:124 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
80:50 [33mwarning[0m 'CNG' is uppercase. Use gitlab.Uppercase
lowercase orbackticks
if
possible. Otherwise add this
word to the rule's exception
list.
96:32 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will need". Use present tense
instead.
96:123 [33mwarning[0m 'This is' is not precise. gitlab.UnclearAntecedent Try rewriting with a specific
subject and verb.
96:131 [34msuggestion[0m Avoid words like "currently" gitlab.CurrentStatus
when you write about future
features. Our documentation is
about the current state of the
product.[4mdoc/architecture/index.md[0m 1:1 [34msuggestion[0m The grade level - 20.43 - gitlab.ReadingLevel refers to how hard the content
is to understand. Aim for
8th grade or lower by using
shorter sentences and words.[4mdoc/architecture/decisions.md[0m 1:1 [34msuggestion[0m The grade level - 10.22 - gitlab.ReadingLevel
refers to how hard the content
is to understand. Aim for
8th grade or lower by using
shorter sentences and words.
14:1 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
16:55 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
18:63 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will not". Use present tense
instead.
27:56 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
31:1 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
33:116 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
33:116 [33mwarning[0m 'These are' is not precise. gitlab.UnclearAntecedent
Try rewriting with a specific
subject and verb.
37:1 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will cause". Use present
tense instead.
37:180 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will not". Use present tense
instead.
49:74 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
54:37 [34msuggestion[0m Avoid words like "simple" that gitlab.Simplicity
imply ease of use, because
the user may find this action
hard.
57:34 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
59:53 [34msuggestion[0m Consider "in" instead of gitlab.SubstitutionSuggestions "within".
61:35 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will be". Use present tense
instead.
88:33 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will remain". Use present
tense instead.
93:13 [33mwarning[0m 'DRY' is uppercase. Use gitlab.Uppercase
lowercase orbackticks
if
possible. Otherwise add this
word to the rule's exception
list.
95:9 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will suffice". Use present
tense instead.
161:32 [33mwarning[0m 'CNG' is uppercase. Use gitlab.Uppercase
lowercase orbackticks
if
possible. Otherwise add this
word to the rule's exception
list.
165:6 [33mwarning[0m 'CNG' is uppercase. Use gitlab.Uppercase
lowercase orbackticks
if
possible. Otherwise add this
word to the rule's exception
list.[4mdoc/advanced/geo/index.md[0m 1:1 [34msuggestion[0m The grade level - 8.42 - gitlab.ReadingLevel
refers to how hard the content
is to understand. Aim for
8th grade or lower by using
shorter sentences and words.
12:1 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
28:8 [33mwarning[0m 'WAL' is uppercase. Use gitlab.Uppercase
lowercase orbackticks
if
possible. Otherwise add this
word to the rule's exception
list.
38:4 [33mwarning[0m Rename the subheading gitlab.HeadingContent
"Overview", or re-purpose the
content elsewhere.
76:57 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"we'll provide". Use present
tense instead.
80:38 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will be". Use present tense
instead.
138:55 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
287:30 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will do". Use present tense
instead.
343:153 [33mwarning[0m 'This is' is not precise. gitlab.UnclearAntecedent Try rewriting with a specific
subject and verb.
433:40 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
456:15 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will now". Use present tense
instead.
671:70 [33mwarning[0m 'This is' is not precise. gitlab.UnclearAntecedent Try rewriting with a specific
subject and verb.[4mdoc/backup-restore/backup.md[0m 1:1 [34msuggestion[0m The grade level - 7.79 - gitlab.ReadingLevel
refers to how hard the content
is to understand. Aim for
8th grade or lower by using
shorter sentences and words.
31:108 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will be". Use present tense
instead.
41:58 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will not". Use present tense
instead.
49:78 [34msuggestion[0m Consider "documentation" gitlab.SubstitutionSuggestions instead of "docs".
62:117 [34msuggestion[0m Consider "you should" instead gitlab.SubstitutionSuggestions of "We recommend".[4mdoc/architecture/resource-usage.md[0m 1:1 [34msuggestion[0m The grade level - 6.91 - gitlab.ReadingLevel
refers to how hard the content
is to understand. Aim for
8th grade or lower by using
shorter sentences and words.
14:23 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength readability (max 25 words).
15:153 [33mwarning[0m Spelling check: "Kube"? gitlab.Spelling
17:1 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength readability (max 25 words).
17:1 [34msuggestion[0m Be concise: use 'to' rather gitlab.Wordy
than "In order to".
21:4 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will measure". Use present
tense instead.
24:9 [34msuggestion[0m Avoid words like "useful" that gitlab.Simplicity
imply ease of use, because
the user may find this action
hard.
24:33 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will not". Use present tense
instead.
26:63 [34msuggestion[0m Avoid words like "useful" that gitlab.Simplicity
imply ease of use, because
the user may find this action
hard.
27:28 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will be". Use present tense
instead.
28:51 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will avoid". Use present
tense instead.
31:23 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will attempt". Use present
tense instead.
32:34 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will list". Use present tense
instead.
33:18 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will typically". Use present
tense instead.
41:44 [34msuggestion[0m Avoid words like "currently" gitlab.CurrentStatus
when you write about future
features. Our documentation is
about the current state of the
product.
42:23 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will likely". Use present
tense instead.
47:91 [34msuggestion[0m Be concise: use 'to' rather gitlab.Wordy
than "in order to".
48:20 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will try". Use present tense
instead.
70:7 [33mwarning[0m Spelling check: "cpu"? gitlab.Spelling
73:7 [33mwarning[0m Spelling check: "cpu"? gitlab.Spelling
83:5 [33mwarning[0m Spelling check: "cpu"? gitlab.Spelling
88:5 [33mwarning[0m Spelling check: "cpu"? gitlab.Spelling
106:5 [33mwarning[0m 'KAS' is uppercase. Use gitlab.Uppercase
lowercase orbackticks
if
possible. Otherwise add this
word to the rule's exception
list.
108:68 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will be". Use present tense
instead.
108:82 [33mwarning[0m 'KAS' is uppercase. Use gitlab.Uppercase
lowercase orbackticks
if
possible. Otherwise add this
word to the rule's exception
list.
135:5 [33mwarning[0m 'KAS' is uppercase. Use gitlab.Uppercase
lowercase orbackticks
if
possible. Otherwise add this
word to the rule's exception
list.[4mdoc/charts/certmanager-issuer/index.md[0m 1:1 [34msuggestion[0m The grade level - 10.68 - gitlab.ReadingLevel refers to how hard the content
is to understand. Aim for
8th grade or lower by using
shorter sentences and words.
44:104 [33mwarning[0m 'ACME' is uppercase. Use gitlab.Uppercase
lowercase orbackticks
if
possible. Otherwise add this
word to the rule's exception
list.[4mdoc/backup-restore/index.md[0m 1:1 [34msuggestion[0m The grade level - 8.53 - gitlab.ReadingLevel
refers to how hard the content
is to understand. Aim for
8th grade or lower by using
shorter sentences and words.
9:1 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
14:165 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will be". Use present tense
instead.
18:152 [34msuggestion[0m Avoid words like "currently" gitlab.CurrentStatus
when you write about future
features. Our documentation is
about the current state of the
product.
31:56 [34msuggestion[0m Be concise: use 'to' rather gitlab.Wordy
than "In order to".
41:49 [33mwarning[0m Improve SEO and accessibility gitlab.MeaningfulLinkWords by rewriting "here" in the
link text.
55:1 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
56:5 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will use". Use present tense
instead.
89:27 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will use". Use present tense
instead.
96:1 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
96:81 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will want". Use present tense
instead.
130:1 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).[4mdoc/backup-restore/restore.md[0m 1:1 [34msuggestion[0m The grade level - 7.99 - gitlab.ReadingLevel
refers to how hard the content
is to understand. Aim for
8th grade or lower by using
shorter sentences and words.
9:1 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
16:1 [34msuggestion[0m Consider "you should" instead gitlab.SubstitutionSuggestions of "It is recommended".
25:90 [33mwarning[0m 'This is' is not precise. gitlab.UnclearAntecedent
Try rewriting with a specific
subject and verb.
37:17 [33mwarning[0m Spelling check: "yq"? gitlab.Spelling
78:1 [33mwarning[0m Use a comma before the last gitlab.OxfordComma
"and" or "or" in a list of
four or more items.
78:1 [34msuggestion[0m Be concise: use 'to' rather gitlab.Wordy
than "In order to".
112:17 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will take". Use present tense
instead.
113:28 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will erase". Use present
tense instead.
113:178 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will be". Use present tense
instead.
113:287 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will be". Use present tense
instead.
118:36 [34msuggestion[0m Remove this word from the gitlab.Wordy
sentence: "please".
122:38 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will not". Use present tense
instead.
127:1 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
127:80 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will also". Use present tense
instead.
144:1 [34msuggestion[0m Be concise: use 'to' rather gitlab.Wordy
than "In order to".[4mdoc/charts/gitlab/gitlab-grafana/index.md[0m 1:1 [34msuggestion[0m The grade level - 11.09 - gitlab.ReadingLevel
refers to how hard the content
is to understand. Aim for
8th grade or lower by using
shorter sentences and words.
33:66 [33mwarning[0m Spelling check: "Configmap"? gitlab.Spelling
36:60 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will generally". Use present
tense instead.
42:1 [33mwarning[0m 'There are' is not precise. gitlab.UnclearAntecedent Try rewriting with a specific
subject and verb.
65:28 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will be". Use present tense
instead.
66:67 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will not". Use present tense
instead.
69:1 [33mwarning[0m 'There are' is not precise. gitlab.UnclearAntecedent Try rewriting with a specific
subject and verb.
69:11 [34msuggestion[0m Avoid words like "currently" gitlab.CurrentStatus
when you write about future
features. Our documentation is
about the current state of the
product.
76:51 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will add". Use present tense
instead.[4mdoc/charts/gitlab/gitlab-exporter/index.md[0m 1:1 [34msuggestion[0m The grade level - 10.16 - gitlab.ReadingLevel
refers to how hard the content
is to understand. Aim for
8th grade or lower by using
shorter sentences and words.
11:60 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength readability (max 25 words).
13:49 [33mwarning[0m Use "for example" instead of gitlab.LatinTerms
"e.g.", but consider rewriting
the sentence.
17:1 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength readability (max 25 words).
35:133 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"Will not". Use present tense
instead.
54:208 [34msuggestion[0m Be concise: rewrite the gitlab.Wordy
sentence to not use "note
that".[4mdoc/charts/gitlab/index.md[0m 1:1 [34msuggestion[0m The grade level - 9.03 - gitlab.ReadingLevel refers to how hard the content
is to understand. Aim for
8th grade or lower by using
shorter sentences and words.
18:25 [33mwarning[0m 'KAS' is uppercase. Use gitlab.Uppercase
lowercase orbackticks
if
possible. Otherwise add this
word to the rule's exception
list.
49:93 [33mwarning[0m Spelling check: "Jetstack"? gitlab.Spelling[4mdoc/charts/gitlab/gitlab-runner/index.md[0m 1:1 [34msuggestion[0m The grade level - 9.93 - gitlab.ReadingLevel
refers to how hard the content
is to understand. Aim for
8th grade or lower by using
shorter sentences and words.
13:110 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
13:207 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will need". Use present tense
instead.
17:1 [33mwarning[0m 'There are' is not precise. gitlab.UnclearAntecedent Try rewriting with a specific
subject and verb.
21:144 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will not". Use present tense
instead.
23:18 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will need". Use present tense
instead.
23:103 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will also". Use present tense
instead.
27:1 [34msuggestion[0m Be concise: use 'to' rather gitlab.Wordy
than "In order to".
60:177 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will need". Use present tense
instead.[4mdoc/charts/gitlab/gitaly/index.md[0m 1:1 [34msuggestion[0m The grade level - 9.60 - gitlab.ReadingLevel
refers to how hard the content
is to understand. Aim for
8th grade or lower by using
shorter sentences and words.
13:1 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
19:1 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
20:68 [34msuggestion[0m Avoid words like "yet" gitlab.CurrentStatus
when you write about future
features. Our documentation is
about the current state of the
product.
21:1 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
21:68 [34msuggestion[0m Consider "in" instead of gitlab.SubstitutionSuggestions "within".
22:52 [34msuggestion[0m Consider "in" instead of gitlab.SubstitutionSuggestions "within".
31:48 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will need". Use present tense
instead.
43:131 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"Will not". Use present tense
instead.
57:54 [33mwarning[0m Use "default branch" ormain
gitlab.DefaultBranch
instead ofmaster
, when
possible.
81:113 [33mwarning[0m 'DSN' is uppercase. Use gitlab.Uppercase
lowercase orbackticks
if
possible. Otherwise add this
word to the rule's exception
list.
82:113 [33mwarning[0m 'DSN' is uppercase. Use gitlab.Uppercase
lowercase orbackticks
if
possible. Otherwise add this
word to the rule's exception
list.
94:154 [33mwarning[0m 'GRPC' is uppercase. Use gitlab.Uppercase
lowercase orbackticks
if
possible. Otherwise add this
word to the rule's exception
list.
109:206 [34msuggestion[0m Be concise: rewrite the gitlab.Wordy
sentence to not use "note
that".
286:160 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will template". Use present
tense instead.
286:262 [33mwarning[0m 'This is' is not precise. gitlab.UnclearAntecedent
Try rewriting with a specific
subject and verb.
302:37 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"You'll need". Use present
tense instead.
313:45 [34msuggestion[0m Consider "after you" instead gitlab.SubstitutionSuggestions of "once you".
332:145 [33mwarning[0m 'This is' is not precise. gitlab.UnclearAntecedent
Try rewriting with a specific
subject and verb.
333:147 [33mwarning[0m 'This is' is not precise. gitlab.UnclearAntecedent
Try rewriting with a specific
subject and verb.
335:168 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will be". Use present tense
instead.
336:66 [34msuggestion[0m Consider "in" instead of gitlab.SubstitutionSuggestions "within".
346:63 [33mwarning[0m 'This is' is not precise. gitlab.UnclearAntecedent
Try rewriting with a specific
subject and verb.
357:72 [34msuggestion[0m Consider "in" instead of gitlab.SubstitutionSuggestions "within".[4mdoc/charts/gitlab/mailroom/index.md[0m 1:1 [34msuggestion[0m The grade level - 8.58 - gitlab.ReadingLevel
refers to how hard the content
is to understand. Aim for
8th grade or lower by using
shorter sentences and words.
81:93 [33mwarning[0m Spelling check: "downscaling"? gitlab.Spelling
95:241 [33mwarning[0m Use "default branch" ormain
gitlab.DefaultBranch
instead ofmaster
, when
possible.
118:41 [33mwarning[0m 'There are' is not precise. gitlab.UnclearAntecedent
Try rewriting with a specific
subject and verb.
135:20 [34msuggestion[0m Consider "email" instead of gitlab.SubstitutionSuggestions "e-mail".
139:1 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
144:19 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will still". Use present
tense instead.
157:1 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
165:18 [34msuggestion[0m Consider "email" instead of gitlab.SubstitutionSuggestions "e-mail".
192:5 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will also". Use present tense
instead.[4mdoc/charts/gitlab/gitlab-pages/index.md[0m 1:1 [34msuggestion[0m The grade level - 8.23 - gitlab.ReadingLevel
refers to how hard the content
is to understand. Aim for
8th grade or lower by using
shorter sentences and words.
14:1 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
43:157 [33mwarning[0m Spelling check: "downscaling"? gitlab.Spelling
63:208 [34msuggestion[0m Be concise: rewrite the gitlab.Wordy
sentence to not use "note
that".
69:133 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"Will not". Use present tense
instead.
82:226 [34msuggestion[0m Consider "in" instead of gitlab.SubstitutionSuggestions "within".
83:125 [33mwarning[0m If possible, use gitlab.SubstitutionWarning
"configuration" instead of
"config".
83:125 [33mwarning[0m Spelling check: "config"? gitlab.Spelling
121:67 [33mwarning[0m If possible, use "use" instead gitlab.SubstitutionWarning
of "utilize".
150:109 [33mwarning[0m 'This is' is not precise. gitlab.UnclearAntecedent
Try rewriting with a specific
subject and verb.
150:124 [34msuggestion[0m Avoid words like "useful" that gitlab.Simplicity
imply ease of use, because
the user may find this action
hard.
190:92 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will be". Use present tense
instead.
190:116 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will block". Use present
tense instead.
192:91 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will be". Use present tense
instead.
192:115 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will block". Use present
tense instead.[4mdoc/charts/gitlab/kas/index.md[0m 1:1 [34msuggestion[0m The grade level - 8.12 - gitlab.ReadingLevel
refers to how hard the content
is to understand. Aim for
8th grade or lower by using
shorter sentences and words.
10:23 [33mwarning[0m 'KAS' is uppercase. Use gitlab.Uppercase
lowercase orbackticks
if
possible. Otherwise add this
word to the rule's exception
list.
17:58 [33mwarning[0m Spelling check: "distroless"? gitlab.Spelling
47:6 [33mwarning[0m 'KAS' is uppercase. Use gitlab.Uppercase
lowercase orbackticks
if
possible. Otherwise add this
word to the rule's exception
list.
56:65 [33mwarning[0m 'KAS' is uppercase. Use gitlab.Uppercase
lowercase orbackticks
if
possible. Otherwise add this
word to the rule's exception
list.
71:153 [33mwarning[0m Spelling check: "downscaling"? gitlab.Spelling
92:104 [33mwarning[0m 'HPA' is uppercase. Use gitlab.Uppercase
lowercase orbackticks
if
possible. Otherwise add this
word to the rule's exception
list.
93:104 [33mwarning[0m 'HPA' is uppercase. Use gitlab.Uppercase
lowercase orbackticks
if
possible. Otherwise add this
word to the rule's exception
list.
94:104 [33mwarning[0m 'HPA' is uppercase. Use gitlab.Uppercase
lowercase orbackticks
if
possible. Otherwise add this
word to the rule's exception
list.
100:141 [33mwarning[0m 'KAS' is uppercase. Use gitlab.Uppercase
lowercase orbackticks
if
possible. Otherwise add this
word to the rule's exception
list.
100:171 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will become". Use present
tense instead.
131:75 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will trust". Use present
tense instead.
166:135 [33mwarning[0m Lines should not end with gitlab.EOLWhitespace whitespace characters.[4mdoc/charts/gitlab/gitlab-shell/index.md[0m 1:1 [34msuggestion[0m The grade level - 9.87 - gitlab.ReadingLevel
refers to how hard the content
is to understand. Aim for
8th grade or lower by using
shorter sentences and words.
13:1 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
19:1 [34msuggestion[0m Be concise: use 'to' rather gitlab.Wordy
than "In order to".
19:1 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
19:13 [34msuggestion[0m Avoid words like "easily" that gitlab.Simplicity
imply ease of use, because
the user may find this action
hard.
22:35 [34msuggestion[0m Consider "in" instead of gitlab.SubstitutionSuggestions "within".
36:252 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"Will not". Use present tense
instead.
38:244 [33mwarning[0m Spelling check: "keepalive"? gitlab.Spelling
39:268 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will disconnect". Use present
tense instead.
40:251 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will increase". Use present
tense instead.
40:375 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will reach". Use present
tense instead.
41:232 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will refuse". Use present
tense instead.
42:232 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will refuse". Use present
tense instead.
42:299 [34msuggestion[0m Avoid words like "currently" gitlab.CurrentStatus
when you write about future
features. Our documentation is
about the current state of the
product.
45:262 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will wait". Use present tense
instead.
47:251 [33mwarning[0m 'KEX' is uppercase. Use gitlab.Uppercase
lowercase orbackticks
if
possible. Otherwise add this
word to the rule's exception
list.
48:251 [33mwarning[0m 'MAC' is uppercase. Use gitlab.Uppercase
lowercase orbackticks
if
possible. Otherwise add this
word to the rule's exception
list.
60:251 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will wait". Use present tense
instead.
68:276 [33mwarning[0m Spelling check: "downscaling"? gitlab.Spelling
80:53 [33mwarning[0m Use "default branch" ormain
gitlab.DefaultBranch
instead ofmaster
, when
possible.
98:290 [33mwarning[0m Spelling check: "webservice"? gitlab.Spelling
102:327 [34msuggestion[0m Be concise: rewrite the gitlab.Wordy
sentence to not use "note
that".
255:150 [33mwarning[0m Spelling check: "webservice"? gitlab.Spelling
255:226 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will template". Use present
tense instead.
255:328 [33mwarning[0m 'This is' is not precise. gitlab.UnclearAntecedent
Try rewriting with a specific
subject and verb.
264:50 [34msuggestion[0m Be concise: use 'to' rather gitlab.Wordy
than "in order to".
312:92 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will be". Use present tense
instead.
312:116 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will block". Use present
tense instead.
314:91 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will be". Use present tense
instead.
314:115 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will block". Use present
tense instead.[4mdoc/charts/gitlab/migrations/index.md[0m 1:1 [34msuggestion[0m The grade level - 7.45 - gitlab.ReadingLevel
refers to how hard the content
is to understand. Aim for
8th grade or lower by using
shorter sentences and words.
11:244 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
15:1 [33mwarning[0m Use a comma before the last gitlab.OxfordComma
"and" or "or" in a list of
four or more items.
15:1 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
19:146 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
19:146 [34msuggestion[0m Be concise: use 'to' rather gitlab.Wordy
than "In order to".
21:85 [33mwarning[0m 'This is' is not precise. gitlab.UnclearAntecedent Try rewriting with a specific
subject and verb.
21:131 [34msuggestion[0m Avoid words like "Currently" gitlab.CurrentStatus
when you write about future
features. Our documentation is
about the current state of the
product.
21:202 [33mwarning[0m 'This is' is not precise. gitlab.UnclearAntecedent Try rewriting with a specific
subject and verb.
21:202 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
23:84 [34msuggestion[0m Avoid words like "currently" gitlab.CurrentStatus
when you write about future
features. Our documentation is
about the current state of the
product.
23:394 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will introduce". Use present
tense instead.
45:53 [33mwarning[0m Spelling check: "pob"? gitlab.Spelling
46:58 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"Will not". Use present tense
instead.
49:33 [33mwarning[0m Spelling check: "psql"? gitlab.Spelling
50:40 [33mwarning[0m Spelling check: "psql"? gitlab.Spelling
50:57 [33mwarning[0m Spelling check: "psql"? gitlab.Spelling
135:1 [34msuggestion[0m Be concise: use 'to' rather gitlab.Wordy
than "In order to".
160:115 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will template". Use present
tense instead.
160:217 [33mwarning[0m 'This is' is not precise. gitlab.UnclearAntecedent Try rewriting with a specific
subject and verb.
160:297 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will default". Use present
tense instead.
184:42 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will need". Use present tense
instead.
208:118 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will template". Use present
tense instead.[4mdoc/charts/gitlab/spamcheck/index.md[0m 1:1 [34msuggestion[0m The grade level - 7.70 - gitlab.ReadingLevel
refers to how hard the content
is to understand. Aim for
8th grade or lower by using
shorter sentences and words.
9:1 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength readability (max 25 words).
59:205 [33mwarning[0m Spelling check: "downscaling"? gitlab.Spelling
74:156 [33mwarning[0m 'HPA' is uppercase. Use gitlab.Uppercase
lowercase orbackticks
if
possible. Otherwise add this
word to the rule's exception
list.
75:156 [33mwarning[0m 'HPA' is uppercase. Use gitlab.Uppercase
lowercase orbackticks
if
possible. Otherwise add this
word to the rule's exception
list.
76:156 [33mwarning[0m 'HPA' is uppercase. Use gitlab.Uppercase
lowercase orbackticks
if
possible. Otherwise add this
word to the rule's exception
list.[4mdoc/charts/gitlab/toolbox/index.md[0m 1:1 [34msuggestion[0m The grade level - 11.16 - gitlab.ReadingLevel
refers to how hard the content
is to understand. Aim for
8th grade or lower by using
shorter sentences and words.
9:64 [34msuggestion[0m Consider "in" instead of gitlab.SubstitutionSuggestions "within".
64:64 [33mwarning[0m Spelling check: "backoff"? gitlab.Spelling
95:92 [33mwarning[0m Use "default branch" ormain
gitlab.DefaultBranch
instead ofmaster
, when
possible.
131:1 [34msuggestion[0m Remove this word from the gitlab.Wordy
sentence: "Please".
135:37 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
136:38 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will use". Use present tense
instead.
137:2 [33mwarning[0m Use "for example" instead of gitlab.LatinTerms
"e.g.", but consider rewriting
the sentence.
137:57 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will need". Use present tense
instead.
144:67 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will be". Use present tense
instead.
152:50 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will provide". Use present
tense instead.
153:60 [34msuggestion[0m Remove this word from the gitlab.Wordy
sentence: "Please".
154:27 [33mwarning[0m 'CSI' is uppercase. Use gitlab.Uppercase
lowercase orbackticks
if
possible. Otherwise add this
word to the rule's exception
list.
159:1 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
167:1 [34msuggestion[0m Consider "after the" instead gitlab.SubstitutionSuggestions of "Once the".
182:32 [34msuggestion[0m Avoid words like "useful" that gitlab.Simplicity
imply ease of use, because
the user may find this action
hard.[4mdoc/charts/gitlab/praefect/index.md[0m 1:1 [34msuggestion[0m The grade level - 10.47 - gitlab.ReadingLevel
refers to how hard the content
is to understand. Aim for
8th grade or lower by using
shorter sentences and words.
10:73 [34msuggestion[0m Avoid words like "yet" gitlab.CurrentStatus
when you write about future
features. Our documentation is
about the current state of the
product.
18:56 [34msuggestion[0m Avoid words like "currently" gitlab.CurrentStatus
when you write about future
features. Our documentation is
about the current state of the
product.
20:56 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will encounter". Use present
tense instead.
28:24 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will create". Use present
tense instead.
65:6 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will create". Use present
tense instead.
117:1 [33mwarning[0m 'This is' is not precise. gitlab.UnclearAntecedent
Try rewriting with a specific
subject and verb.
153:7 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will be". Use present tense
instead.
173:41 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will generate". Use present
tense instead.
195:72 [33mwarning[0m 'This is' is not precise. gitlab.UnclearAntecedent
Try rewriting with a specific
subject and verb.
206:38 [34msuggestion[0m Consider "in" instead of gitlab.SubstitutionSuggestions "within".
261:124 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"Will not". Use present tense
instead.
262:169 [33mwarning[0m Lines should not end with gitlab.EOLWhitespace
whitespace characters.
264:3 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
266:146 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will be". Use present tense
instead.
273:106 [33mwarning[0m 'DSN' is uppercase. Use gitlab.Uppercase
lowercase orbackticks
if
possible. Otherwise add this
word to the rule's exception
list.
274:106 [33mwarning[0m 'DSN' is uppercase. Use gitlab.Uppercase
lowercase orbackticks
if
possible. Otherwise add this
word to the rule's exception
list.
278:128 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will not". Use present tense
instead.
280:199 [34msuggestion[0m Be concise: rewrite the gitlab.Wordy
sentence to not use "note
that".
286:3 [33mwarning[0m Spelling check: "statefulset"? gitlab.Spelling
286:159 [33mwarning[0m Spelling check: "statefulset"? gitlab.Spelling[4mdoc/charts/index.md[0m 1:1 [34msuggestion[0m The grade level - 6.21 - gitlab.ReadingLevel refers to how hard the content
is to understand. Aim for
8th grade or lower by using
shorter sentences and words.[4mdoc/charts/nginx/fork.md[0m 1:1 [34msuggestion[0m The grade level - 7.96 - gitlab.ReadingLevel
refers to how hard the content
is to understand. Aim for
8th grade or lower by using
shorter sentences and words.
28:21 [33mwarning[0m 'PDB' is uppercase. Use gitlab.Uppercase
lowercase orbackticks
if
possible. Otherwise add this
word to the rule's exception
list.
30:36 [34msuggestion[0m Consider "because" or "after" gitlab.SubstitutionSuggestions instead of "since".
31:115 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will contain". Use present
tense instead.
34:12 [33mwarning[0m 'HPA' is uppercase. Use gitlab.Uppercase
lowercase orbackticks
if
possible. Otherwise add this
word to the rule's exception
list.[4mdoc/charts/nginx/index.md[0m 1:1 [34msuggestion[0m The grade level - 9.47 - gitlab.ReadingLevel
refers to how hard the content
is to understand. Aim for
8th grade or lower by using
shorter sentences and words.
17:1 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength readability (max 25 words).[4mdoc/charts/minio/index.md[0m 1:1 [34msuggestion[0m The grade level - 9.08 - gitlab.ReadingLevel
refers to how hard the content
is to understand. Aim for
8th grade or lower by using
shorter sentences and words.
18:34 [34msuggestion[0m Be concise: use 'to' rather gitlab.Wordy
than "in order to".
25:27 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will be". Use present tense
instead.
25:66 [33mwarning[0m Rewrite "bucket(s)" to be gitlab.BadPlurals
plural, without parentheses.
29:4 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will describe". Use present
tense instead.
30:37 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will be". Use present tense
instead.
73:74 [33mwarning[0m Spelling check: "mc"? gitlab.Spelling
74:74 [33mwarning[0m Spelling check: "mc"? gitlab.Spelling
135:1 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
159:66 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will be". Use present tense
instead.
171:42 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will be". Use present tense
instead.
175:35 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will be". Use present tense
instead.
188:90 [33mwarning[0m 'This is' is not precise. gitlab.UnclearAntecedent Try rewriting with a specific
subject and verb.
188:105 [34msuggestion[0m Avoid words like "useful" that gitlab.Simplicity
imply ease of use, because
the user may find this action
hard.
199:39 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"You'll need". Use present
tense instead.
217:103 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will use". Use present tense
instead.
218:139 [33mwarning[0m 'This is' is not precise. gitlab.UnclearAntecedent Try rewriting with a specific
subject and verb.
219:137 [33mwarning[0m 'This is' is not precise. gitlab.UnclearAntecedent Try rewriting with a specific
subject and verb.
241:352 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will have". Use present tense
instead.
241:432 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will be". Use present tense
instead.
241:585 [34msuggestion[0m Be concise: use 'to' rather gitlab.Wordy
than "in order to".
247:50 [34msuggestion[0m Remove this word from the gitlab.Wordy
sentence: "please".
252:1 [33mwarning[0m 'These are' is not precise. gitlab.UnclearAntecedent Try rewriting with a specific
subject and verb.[4mdoc/charts/shared-secrets.md[0m 1:1 [34msuggestion[0m The grade level - 9.17 - gitlab.ReadingLevel refers to how hard the content
is to understand. Aim for
8th grade or lower by using
shorter sentences and words.
29:79 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"Will not". Use present tense
instead.
39:54 [33mwarning[0m Spelling check: "selfsign"? gitlab.Spelling
40:94 [33mwarning[0m Spelling check: "selfsign"? gitlab.Spelling
42:54 [33mwarning[0m Spelling check: "selfsign"? gitlab.Spelling
43:54 [33mwarning[0m Spelling check: "selfsign"? gitlab.Spelling
44:54 [33mwarning[0m Spelling check: "selfsign"? gitlab.Spelling
45:83 [33mwarning[0m Rewrite "job(s)" to be plural, gitlab.BadPlurals
without parentheses.
47:99 [33mwarning[0m Rewrite "job(s)" to be plural, gitlab.BadPlurals
without parentheses.[4mdoc/development/changelog.md[0m 1:1 [34msuggestion[0m The grade level - 7.63 - gitlab.ReadingLevel
refers to how hard the content
is to understand. Aim for
8th grade or lower by using
shorter sentences and words.
12:4 [33mwarning[0m Rename the subheading gitlab.HeadingContent
"Overview", or re-purpose the
content elsewhere.
14:6 [33mwarning[0m If possible, use "list item" gitlab.SubstitutionWarning instead of "bullet".
65:73 [33mwarning[0m Use "that is" instead of gitlab.LatinTerms
"i.e.", but consider rewriting
the sentence.
68:32 [33mwarning[0m Use "for example" instead of gitlab.LatinTerms
"e.g.", but consider rewriting
the sentence.
83:3 [34msuggestion[0m Use "dropdown list". gitlab.Dropdown
95:10 [34msuggestion[0m Use "dropdown list". gitlab.Dropdown
97:3 [34msuggestion[0m Use "dropdown list". gitlab.Dropdown[4mdoc/charts/gitlab/sidekiq/index.md[0m 1:1 [34msuggestion[0m The grade level - 9.27 - gitlab.ReadingLevel
refers to how hard the content
is to understand. Aim for
8th grade or lower by using
shorter sentences and words.
14:5 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will have". Use present tense
instead.
18:1 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
24:72 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
26:73 [34msuggestion[0m Be concise: use 'to' rather gitlab.Wordy
than "in order to".
43:136 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"Will not". Use present tense
instead.
57:160 [33mwarning[0m Spelling check: "downscaling"? gitlab.Spelling
84:139 [33mwarning[0m Spelling check: "sidekiq"? gitlab.Spelling
85:134 [33mwarning[0m Spelling check: "sidekiq"? gitlab.Spelling
86:118 [33mwarning[0m Spelling check: "psql"? gitlab.Spelling
86:135 [33mwarning[0m Spelling check: "psql"? gitlab.Spelling
87:111 [33mwarning[0m Spelling check: "psql"? gitlab.Spelling
172:6 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will set". Use present tense
instead.
280:1 [34msuggestion[0m Be concise: use 'to' rather gitlab.Wordy
than "In order to".
286:58 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will be". Use present tense
instead.
309:159 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will template". Use present
tense instead.
309:261 [33mwarning[0m 'This is' is not precise. gitlab.UnclearAntecedent Try rewriting with a specific
subject and verb.
338:179 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will template". Use present
tense instead.
366:158 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will template". Use present
tense instead.
366:260 [33mwarning[0m 'This is' is not precise. gitlab.UnclearAntecedent Try rewriting with a specific
subject and verb.
375:20 [34msuggestion[0m Verify this use of the gitlab.Admin
word "admin". Can it be
updated to "administration",
"administrator", "administer",
or "Admin Area"?
381:22 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will be". Use present tense
instead.
387:131 [33mwarning[0m 'TERM' is uppercase. Use gitlab.Uppercase
lowercase orbackticks
if
possible. Otherwise add this
word to the rule's exception
list.
403:12 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will be". Use present tense
instead.
409:35 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will not". Use present tense
instead.
413:190 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will be". Use present tense
instead.
418:198 [33mwarning[0m 'TERM' is uppercase. Use gitlab.Uppercase
lowercase orbackticks
if
possible. Otherwise add this
word to the rule's exception
list.
418:277 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will be". Use present tense
instead.
419:185 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will be". Use present tense
instead.
420:189 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will be". Use present tense
instead.
428:148 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"Will not". Use present tense
instead.
448:63 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will be". Use present tense
instead.
450:75 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will work". Use present tense
instead.
451:49 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will not". Use present tense
instead.
454:15 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will not". Use present tense
instead.
465:75 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will work". Use present tense
instead.
466:49 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will not". Use present tense
instead.
468:1 [33mwarning[0m 'This is' is not precise. gitlab.UnclearAntecedent Try rewriting with a specific
subject and verb.
468:1 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
468:9 [34msuggestion[0m Avoid words like "useful" that gitlab.Simplicity
imply ease of use, because
the user may find this action
hard.
473:67 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will have". Use present tense
instead.
512:92 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will be". Use present tense
instead.
512:116 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will block". Use present
tense instead.
514:91 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will be". Use present tense
instead.
514:115 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will block". Use present
tense instead.
532:2 [34msuggestion[0m Be concise: rewrite the gitlab.Wordy
sentence to not use "Note
that".[4mdoc/development/chaoskube/index.md[0m 1:1 [34msuggestion[0m The grade level - 8.89 - gitlab.ReadingLevel
refers to how hard the content
is to understand. Aim for
8th grade or lower by using
shorter sentences and words.
11:51 [34msuggestion[0m Be concise: use 'to' rather gitlab.Wordy
than "in order to".
45:16 [33mwarning[0m If possible, use "information" gitlab.SubstitutionWarning
instead of "info".
45:50 [34msuggestion[0m Consider "documentation" gitlab.SubstitutionSuggestions instead of "docs".[4mdoc/development/checkconfig.md[0m 1:1 [34msuggestion[0m The grade level - 8.96 - gitlab.ReadingLevel
refers to how hard the content
is to understand. Aim for
8th grade or lower by using
shorter sentences and words.
9:1 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
11:106 [33mwarning[0m 'This is' is not precise. gitlab.UnclearAntecedent
Try rewriting with a specific
subject and verb.
23:19 [34msuggestion[0m Consider "in" instead of gitlab.SubstitutionSuggestions "within".
27:1 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will complain". Use present
tense instead.
27:73 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will exist". Use present
tense instead.
27:163 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
27:377 [34msuggestion[0m Consider "in" instead of gitlab.SubstitutionSuggestions "within".
41:156 [33mwarning[0m Rewrite "chart(s)" to be gitlab.BadPlurals
plural, without parentheses.
42:73 [33mwarning[0m 'This is' is not precise. gitlab.UnclearAntecedent
Try rewriting with a specific
subject and verb.
42:149 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will break". Use present
tense instead.
54:52 [34msuggestion[0m Consider "in" instead of gitlab.SubstitutionSuggestions "within".
54:136 [34msuggestion[0m Avoid words like "simple" that gitlab.Simplicity
imply ease of use, because
the user may find this action
hard.
54:144 [34msuggestion[0m Avoid words like "Simply" that gitlab.Simplicity
imply ease of use, because
the user may find this action
hard.[4mdoc/development/deploy.md[0m 1:1 [34msuggestion[0m The grade level - 10.22 - gitlab.ReadingLevel
refers to how hard the content
is to understand. Aim for
8th grade or lower by using
shorter sentences and words.
19:1 [34msuggestion[0m Be concise: rewrite the gitlab.Wordy
sentence to not use "Note
that".
26:9 [34msuggestion[0m Avoid words like "easy" that gitlab.Simplicity
imply ease of use, because
the user may find this action
hard.
28:90 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
32:6 [34msuggestion[0m Consider "in" instead of gitlab.SubstitutionSuggestions "within".[4mdoc/development/environment_setup.md[0m 1:1 [34msuggestion[0m The grade level - 10.07 - gitlab.ReadingLevel
refers to how hard the content
is to understand. Aim for
8th grade or lower by using
shorter sentences and words.
16:1 [34msuggestion[0m Consider "you should" instead gitlab.SubstitutionSuggestions of "We recommend".
17:19 [34msuggestion[0m Avoid words like "easily" that gitlab.Simplicity
imply ease of use, because
the user may find this action
hard.
23:43 [33mwarning[0m Rewrite "Link(s)" to be gitlab.BadPlurals
plural, without parentheses.
25:10 [34msuggestion[0m Avoid words like "Easily" that gitlab.Simplicity
imply ease of use, because
the user may find this action
hard.
28:57 [34msuggestion[0m Consider go instead of gitlab.SubstitutionSuggestions "Navigate".
29:65 [34msuggestion[0m Consider go instead of gitlab.SubstitutionSuggestions "Navigate".
30:11 [34msuggestion[0m Avoid words like "Easily" that gitlab.Simplicity
imply ease of use, because
the user may find this action
hard.
31:149 [33mwarning[0m 'OCI' is uppercase. Use gitlab.Uppercase
lowercase orbackticks
if
possible. Otherwise add this
word to the rule's exception
list.
36:5 [34msuggestion[0m Avoid words like "simple" that gitlab.Simplicity
imply ease of use, because
the user may find this action
hard.[4mdoc/development/deprecations.md[0m 1:1 [34msuggestion[0m The grade level - 9.29 - gitlab.ReadingLevel
refers to how hard the content
is to understand. Aim for
8th grade or lower by using
shorter sentences and words.
9:1 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
11:112 [33mwarning[0m 'This is' is not precise. gitlab.UnclearAntecedent
Try rewriting with a specific
subject and verb.
23:19 [34msuggestion[0m Consider "in" instead of gitlab.SubstitutionSuggestions "within".
27:1 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will complain". Use present
tense instead.
27:73 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will exist". Use present
tense instead.
27:163 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
27:377 [34msuggestion[0m Consider "in" instead of gitlab.SubstitutionSuggestions "within".
53:52 [34msuggestion[0m Consider "in" instead of gitlab.SubstitutionSuggestions "within".
53:136 [34msuggestion[0m Avoid words like "simple" that gitlab.Simplicity
imply ease of use, because
the user may find this action
hard.
53:144 [34msuggestion[0m Avoid words like "Simple" that gitlab.Simplicity
imply ease of use, because
the user may find this action
hard.[4mdoc/development/gitlab-qa/index.md[0m 1:1 [34msuggestion[0m The grade level - 7.24 - gitlab.ReadingLevel
refers to how hard the content
is to understand. Aim for
8th grade or lower by using
shorter sentences and words.
23:1 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will want". Use present tense
instead.
23:64 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will want". Use present tense
instead.
47:10 [33mwarning[0m If possible, use "information" gitlab.SubstitutionWarning instead of "info".
51:39 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will need". Use present tense
instead.
52:50 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
54:56 [33mwarning[0m 'CNG' is uppercase. Use gitlab.Uppercase
lowercase orbackticks
if
possible. Otherwise add this
word to the rule's exception
list.
62:23 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will need". Use present tense
instead.
68:2 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will be". Use present tense
instead.
71:27 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will be". Use present tense
instead.
72:27 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will be". Use present tense
instead.
73:33 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will be". Use present tense
instead.
74:33 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will be". Use present tense
instead.
80:8 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will be". Use present tense
instead.
88:61 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will perform". Use present
tense instead.
95:1 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
97:24 [34msuggestion[0m Avoid words like "currently" gitlab.CurrentStatus
when you write about future
features. Our documentation is
about the current state of the
product.
97:65 [33mwarning[0m Use "default branch" ormain
gitlab.DefaultBranch
instead ofmaster
, when
possible.[4mdoc/development/index.md[0m 1:1 [34msuggestion[0m The grade level - 10.04 - gitlab.ReadingLevel
refers to how hard the content
is to understand. Aim for
8th grade or lower by using
shorter sentences and words.
69:63 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will be". Use present tense
instead.
70:6 [34msuggestion[0m Consider "in" instead of gitlab.SubstitutionSuggestions "within".
75:1 [33mwarning[0m 'There are' is not precise. gitlab.UnclearAntecedent
Try rewriting with a specific
subject and verb.
80:1 [33mwarning[0m 'There are' is not precise. gitlab.UnclearAntecedent
Try rewriting with a specific
subject and verb.
82:240 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will compile". Use present
tense instead.
88:1 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
94:17 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will not". Use present tense
instead.
100:79 [33mwarning[0m 'This is' is not precise. gitlab.UnclearAntecedent
Try rewriting with a specific
subject and verb.
101:60 [34msuggestion[0m Consider "documentation" gitlab.SubstitutionSuggestions instead of "docs".
103:1 [34msuggestion[0m Be concise: rewrite the gitlab.Wordy
sentence to not use "Note
that".
105:1 [34msuggestion[0m Remove this word from the gitlab.Wordy
sentence: "Please".
106:54 [33mwarning[0m Use "for example" instead of gitlab.LatinTerms
"e.g.", but consider rewriting
the sentence.
107:75 [33mwarning[0m 'This is' is not precise. gitlab.UnclearAntecedent
Try rewriting with a specific
subject and verb.
107:75 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
107:114 [33mwarning[0m Rewrite "container(s)" to be gitlab.BadPlurals
plural, without parentheses.
119:6 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will be". Use present tense
instead.[4mdoc/development/kind/index.md[0m 1:1 [34msuggestion[0m The grade level - 8.06 - gitlab.ReadingLevel
refers to how hard the content
is to understand. Aim for
8th grade or lower by using
shorter sentences and words.
10:16 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"we'll be". Use present tense
instead.
10:124 [34msuggestion[0m Avoid words like "easy" that gitlab.Simplicity
imply ease of use, because
the user may find this action
hard.
12:1 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
12:4 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will also". Use present tense
instead.
14:1 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
15:106 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will have". Use present tense
instead.
27:110 [34msuggestion[0m Remove this word from the gitlab.Wordy
sentence: "please".
37:129 [33mwarning[0m Spelling check: "kubectx"? gitlab.Spelling
41:27 [33mwarning[0m If possible, use "information" gitlab.SubstitutionWarning instead of "info".
47:1 [34msuggestion[0m Be concise: rewrite the gitlab.Wordy
sentence to not use "Note
that".
81:20 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will use". Use present tense
instead.
103:1 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
104:63 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will need". Use present tense
instead.
104:200 [33mwarning[0m Improve SEO and accessibility gitlab.MeaningfulLinkWords by rewriting "here" in the
link text.
104:294 [33mwarning[0m Improve SEO and accessibility gitlab.MeaningfulLinkWords by rewriting "here" in the
link text.
108:20 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will use". Use present tense
instead.
121:63 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will need". Use present tense
instead.
125:106 [34msuggestion[0m Remove this word from the gitlab.Wordy
sentence: "please".
125:220 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will also". Use present tense
instead.[4mdoc/development/preparation/index.md[0m 1:1 [34msuggestion[0m The grade level - 8.39 - gitlab.ReadingLevel
refers to how hard the content
is to understand. Aim for
8th grade or lower by using
shorter sentences and words.
9:1 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
9:73 [34msuggestion[0m Avoid words like "useful" that gitlab.Simplicity
imply ease of use, because
the user may find this action
hard.
13:1 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
18:24 [34msuggestion[0m Consider "OAuth 2.0" instead gitlab.SubstitutionSuggestions of "OAuth2".
23:73 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will need". Use present tense
instead.
26:8 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will need". Use present tense
instead.
46:21 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will need". Use present tense
instead.
46:56 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will resolve". Use present
tense instead.
60:1 [34msuggestion[0m Be concise: use 'to' rather gitlab.Wordy
than "In order to".
60:48 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will need". Use present tense
instead.
83:36 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will be". Use present tense
instead.
84:53 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
87:1 [34msuggestion[0m Consider "in" instead of gitlab.SubstitutionSuggestions "within".
93:44 [34msuggestion[0m Consider "after that" instead gitlab.SubstitutionSuggestions of "Once that".
101:39 [34msuggestion[0m Consider "after that" instead gitlab.SubstitutionSuggestions of "Once that".
109:39 [34msuggestion[0m Consider "after that" instead gitlab.SubstitutionSuggestions of "Once that".
113:24 [34msuggestion[0m Consider "OAuth 2.0" instead gitlab.SubstitutionSuggestions of "OAuth2".
116:22 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
116:26 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will need". Use present tense
instead.
120:76 [33mwarning[0m Improve SEO and accessibility gitlab.MeaningfulLinkWords
by rewriting "here" in the
link text.[4mdoc/development/minikube/index.md[0m 1:1 [34msuggestion[0m The grade level - 8.60 - gitlab.ReadingLevel
refers to how hard the content
is to understand. Aim for
8th grade or lower by using
shorter sentences and words.
10:52 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"we'll be". Use present tense
instead.
15:1 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"We'll extract". Use present
tense instead.
25:52 [34msuggestion[0m Consider "after you" instead gitlab.SubstitutionSuggestions of "Once you".
50:1 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
50:65 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"we'll stick". Use present
tense instead.
51:71 [33mwarning[0m 'KVM' is uppercase. Use gitlab.Uppercase
lowercase orbackticks
if
possible. Otherwise add this
word to the rule's exception
list.
51:80 [33mwarning[0m Spelling check: "Xhyve"? gitlab.Spelling
71:3 [33mwarning[0m 'This is' is not precise. gitlab.UnclearAntecedent
Try rewriting with a specific
subject and verb.
73:78 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will use". Use present tense
instead.
73:88 [33mwarning[0m Use "for example" instead of gitlab.LatinTerms
"e.g.", but consider rewriting
the sentence.
76:1 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
81:1 [34msuggestion[0m Consider "after you" instead gitlab.SubstitutionSuggestions of "Once you".
109:118 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will be". Use present tense
instead.
114:22 [33mwarning[0m 'There are' is not precise. gitlab.UnclearAntecedent
Try rewriting with a specific
subject and verb.
130:40 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will not". Use present tense
instead.
138:30 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"we'll need". Use present
tense instead.
162:14 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will be". Use present tense
instead.
162:59 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will accept". Use present
tense instead.
164:22 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will be". Use present tense
instead.
168:72 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will allow". Use present
tense instead.
172:28 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"we'll show". Use present
tense instead.
176:24 [33mwarning[0m Spelling check: "repo"? gitlab.Spelling
176:24 [33mwarning[0m If possible, use "repository" gitlab.SubstitutionWarning
instead of "repo".
218:1 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
234:1 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
234:1 [34msuggestion[0m Consider "after the" instead gitlab.SubstitutionSuggestions of "Once the".
234:73 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will be". Use present tense
instead.[4mdoc/development/release.md[0m 1:1 [34msuggestion[0m The grade level - 8.71 - gitlab.ReadingLevel
refers to how hard the content
is to understand. Aim for
8th grade or lower by using
shorter sentences and words.
23:16 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will iterate". Use present
tense instead.
25:4 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will bump". Use present tense
instead.
35:4 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will bump". Use present tense
instead.
44:36 [34msuggestion[0m Can this reference to "GitLab gitlab.OutdatedVersions
11 " be refactored?
56:36 [34msuggestion[0m Can this reference to "GitLab gitlab.OutdatedVersions
12 " be refactored?
59:30 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will just". Use present tense
instead.
65:1 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
65:74 [34msuggestion[0m Avoid words like "yet" gitlab.CurrentStatus
when you write about future
features. Our documentation is
about the current state of the
product.
65:247 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
65:258 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will move". Use present tense
instead.
71:5 [33mwarning[0m Use "default branch" ormain
gitlab.DefaultBranch
instead ofmaster
, when
possible.
72:45 [33mwarning[0m Use inclusive language. gitlab.InclusionCultural Consider "primary, main"
instead of "master".
75:1 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
75:86 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will be". Use present tense
instead.
77:21 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will be". Use present tense
instead.
77:39 [33mwarning[0m Use inclusive language. gitlab.InclusionCultural Consider "primary, main"
instead of "master".
77:131 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will happen". Use present
tense instead.
77:178 [33mwarning[0m Use inclusive language. gitlab.InclusionCultural Consider "primary, main"
instead of "master".
77:189 [33mwarning[0m Use inclusive language. gitlab.InclusionCultural Consider "primary, main"
instead of "master".
77:196 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will follow". Use present
tense instead.
85:63 [33mwarning[0m Use inclusive language. gitlab.InclusionCultural Consider "primary, main"
instead of "master".
87:67 [33mwarning[0m Use inclusive language. gitlab.InclusionCultural Consider "primary, main"
instead of "master".
90:54 [33mwarning[0m Use inclusive language. gitlab.InclusionCultural Consider "primary, main"
instead of "master".
93:63 [33mwarning[0m Use inclusive language. gitlab.InclusionCultural Consider "primary, main"
instead of "master".
97:54 [33mwarning[0m Use inclusive language. gitlab.InclusionCultural Consider "primary, main"
instead of "master".
105:23 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will be". Use present tense
instead.
105:100 [33mwarning[0m 'CNG' is uppercase. Use gitlab.Uppercase
lowercase orbackticks
if
possible. Otherwise add this
word to the rule's exception
list.
107:3 [34msuggestion[0m Avoid words like "Currently" gitlab.CurrentStatus
when you write about future
features. Our documentation is
about the current state of the
product.
111:64 [33mwarning[0m Use "default branch" ormain
gitlab.DefaultBranch
instead ofmaster
, when
possible.
133:1 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
133:81 [33mwarning[0m Use "default branch" ormain
gitlab.DefaultBranch
instead ofmaster
, when
possible.
134:35 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will release". Use present
tense instead.
136:80 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will need". Use present tense
instead.[4mdoc/charts/gitlab/webservice/index.md[0m 1:1 [34msuggestion[0m The grade level - 9.09 - gitlab.ReadingLevel
refers to how hard the content
is to understand. Aim for
8th grade or lower by using
shorter sentences and words.
17:27 [33mwarning[0m Spelling check: "recieve"? gitlab.Spelling
21:1 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
39:148 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"Will not". Use present tense
instead.
41:147 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will wait". Use present tense
instead.
63:172 [33mwarning[0m Spelling check: "downscaling"? gitlab.Spelling
84:223 [34msuggestion[0m Be concise: rewrite the gitlab.Wordy
sentence to not use "note
that".
93:138 [33mwarning[0m Use inclusive language. gitlab.InclusionCultural
Consider "allowlist" instead
of "whitelist".
96:130 [33mwarning[0m Spelling check: "psql"? gitlab.Spelling
96:147 [33mwarning[0m Spelling check: "psql"? gitlab.Spelling
97:123 [33mwarning[0m Spelling check: "psql"? gitlab.Spelling
133:153 [33mwarning[0m 'This is' is not precise. gitlab.UnclearAntecedent
Try rewriting with a specific
subject and verb.
136:233 [33mwarning[0m 'This is' is not precise. gitlab.UnclearAntecedent
Try rewriting with a specific
subject and verb.
159:213 [33mwarning[0m 'This is' is not precise. gitlab.UnclearAntecedent
Try rewriting with a specific
subject and verb.
160:1 [33mwarning[0m 'This is' is not precise. gitlab.UnclearAntecedent
Try rewriting with a specific
subject and verb.
160:230 [33mwarning[0m 'This is' is not precise. gitlab.UnclearAntecedent
Try rewriting with a specific
subject and verb.
260:100 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will be". Use present tense
instead.
271:1 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
271:85 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will kill". Use present tense
instead.
271:147 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will be". Use present tense
instead.
290:65 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will secure". Use present
tense instead.
293:20 [33mwarning[0m Use "for example" instead of gitlab.LatinTerms
"e.g.", but consider rewriting
the sentence.
296:1 [34msuggestion[0m Be concise: rewrite the gitlab.Wordy
sentence to not use "Note
that".
300:1 [34msuggestion[0m Consider "after the" instead gitlab.SubstitutionSuggestions of "Once the".
310:1 [33mwarning[0m 'This is' is not precise. gitlab.UnclearAntecedent
Try rewriting with a specific
subject and verb.
336:65 [34msuggestion[0m Be concise: rewrite the gitlab.Wordy
sentence to not use "Note
that".
349:116 [34msuggestion[0m Avoid words like "yet" gitlab.CurrentStatus
when you write about future
features. Our documentation is
about the current state of the
product.
375:1 [34msuggestion[0m Be concise: use 'to' rather gitlab.Wordy
than "In order to".
390:1 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will have". Use present tense
instead.
393:27 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will inherit". Use present
tense instead.
447:26 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will inherit". Use present
tense instead.
447:119 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will override". Use present
tense instead.
463:147 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will never". Use present
tense instead.
484:95 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will be". Use present tense
instead.
488:137 [33mwarning[0m 'This is' is not precise. gitlab.UnclearAntecedent
Try rewriting with a specific
subject and verb.
488:152 [34msuggestion[0m Avoid words like "useful" that gitlab.Simplicity
imply ease of use, because
the user may find this action
hard.
499:8 [34msuggestion[0m Consider "documentation" gitlab.SubstitutionSuggestions instead of "docs".
513:67 [33mwarning[0m 'This is' is not precise. gitlab.UnclearAntecedent
Try rewriting with a specific
subject and verb.
528:33 [34msuggestion[0m Consider "you should" instead gitlab.SubstitutionSuggestions of "We recommend".
533:1 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
533:1 [34msuggestion[0m Be concise: rewrite the gitlab.Wordy
sentence to not use "Note
that".
563:7 [34msuggestion[0m Remove this word from the gitlab.Wordy
sentence: "Please".
568:7 [34msuggestion[0m Remove this word from the gitlab.Wordy
sentence: "Please".
572:62 [34msuggestion[0m Remove this word from the gitlab.Wordy
sentence: "Please".
610:173 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will template". Use present
tense instead.
610:279 [33mwarning[0m 'This is' is not precise. gitlab.UnclearAntecedent
Try rewriting with a specific
subject and verb.
611:133 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will be". Use present tense
instead.
612:238 [33mwarning[0m Rewrite "instance(s)" to be gitlab.BadPlurals
plural, without parentheses.
614:119 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will result". Use present
tense instead.
614:189 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will all". Use present tense
instead.
624:195 [34msuggestion[0m Be concise: rewrite the gitlab.Wordy
sentence to not use "Note
that".
624:238 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will increase". Use present
tense instead.
631:49 [33mwarning[0m Spelling check: gitlab.Spelling
"alternativly"?
633:22 [34msuggestion[0m Verify this use of the gitlab.Admin
word "admin". Can it be
updated to "administration",
"administrator", "administer",
or "Admin Area"?
633:34 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
656:97 [34msuggestion[0m Consider "in" instead of gitlab.SubstitutionSuggestions "within".
680:92 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will be". Use present tense
instead.
680:116 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will block". Use present
tense instead.
682:91 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will be". Use present tense
instead.
682:115 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will block". Use present
tense instead.
687:1 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
687:5 [33mwarning[0m Spelling check: "webservice"? gitlab.Spelling
702:2 [34msuggestion[0m Be concise: rewrite the gitlab.Wordy
sentence to not use "Note
that".
757:1 [33mwarning[0m 'This is' is not precise. gitlab.UnclearAntecedent
Try rewriting with a specific
subject and verb.
757:9 [34msuggestion[0m Avoid words like "currently" gitlab.CurrentStatus
when you write about future
features. Our documentation is
about the current state of the
product.[4mdoc/development/rspec.md[0m 1:1 [34msuggestion[0m The grade level - 7.14 - gitlab.ReadingLevel
refers to how hard the content
is to understand. Aim for
8th grade or lower by using
shorter sentences and words.
16:42 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will be". Use present tense
instead.
35:60 [33mwarning[0m 'This is' is not precise. gitlab.UnclearAntecedent
Try rewriting with a specific
subject and verb.
44:56 [34msuggestion[0m Consider "in" instead of gitlab.SubstitutionSuggestions "within".
52:6 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will return". Use present
tense instead.
56:32 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will always". Use present
tense instead.
89:1 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
96:43 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will find". Use present tense
instead.
96:81 [33mwarning[0m 'There are' is not precise. gitlab.UnclearAntecedent
Try rewriting with a specific
subject and verb.
98:1 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will replace". Use present
tense instead.
98:71 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will not". Use present tense
instead.
99:45 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will be". Use present tense
instead.
101:15 [33mwarning[0m Spelling check: "properites"? gitlab.Spelling
103:317 [34msuggestion[0m Consider "in" instead of gitlab.SubstitutionSuggestions "within".
145:193 [34msuggestion[0m Consider "in" instead of gitlab.SubstitutionSuggestions "within".
145:234 [33mwarning[0m Spelling check: "equavilent"? gitlab.Spelling
145:361 [34msuggestion[0m Consider "in" instead of gitlab.SubstitutionSuggestions "within".
221:105 [33mwarning[0m 'This is' is not precise. gitlab.UnclearAntecedent
Try rewriting with a specific
subject and verb.
223:21 [33mwarning[0m 'This is' is not precise. gitlab.UnclearAntecedent
Try rewriting with a specific
subject and verb.
225:105 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will result". Use present
tense instead.
225:215 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will be". Use present tense
instead.
263:46 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will return". Use present
tense instead.
334:55 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will be". Use present tense
instead.
335:47 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will be". Use present tense
instead.
336:70 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will be". Use present tense
instead.
345:12 [34msuggestion[0m Consider "documentation" gitlab.SubstitutionSuggestions instead of "docs".
349:57 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will be". Use present tense
instead.[4mdoc/development/troubleshooting.md[0m 1:1 [34msuggestion[0m The grade level - 8.56 - gitlab.ReadingLevel refers to how hard the content
is to understand. Aim for
8th grade or lower by using
shorter sentences and words.
21:43 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will fail". Use present tense
instead.
46:6 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will delete". Use present
tense instead.
55:7 [34msuggestion[0m Be concise: rewrite the gitlab.Wordy
sentence to not use "Note
that".
55:22 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will require". Use present
tense instead.
57:36 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will have". Use present tense
instead.
59:52 [34msuggestion[0m Verify this use of the gitlab.Admin
word "admin". Can it be
updated to "administration",
"administrator", "administer",
or "Admin Area"?
71:18 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will now". Use present tense
instead.[4mdoc/development/validation.md[0m 1:1 [34msuggestion[0m The grade level - 9.77 - gitlab.ReadingLevel refers to how hard the content
is to understand. Aim for
8th grade or lower by using
shorter sentences and words.
22:14 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will focus". Use present
tense instead.
38:5 [33mwarning[0m Spelling check: "Statefulset"? gitlab.Spelling
40:3 [33mwarning[0m Spelling check: "Statefulset"? gitlab.Spelling[4mdoc/index.md[0m 1:1 [34msuggestion[0m The grade level - 8.96 - gitlab.ReadingLevel refers to how hard the content
is to understand. Aim for
8th grade or lower by using
shorter sentences and words.[4mdoc/installation/cloud/aks.md[0m 1:1 [34msuggestion[0m The grade level - 7.37 - gitlab.ReadingLevel
refers to how hard the content
is to understand. Aim for
8th grade or lower by using
shorter sentences and words.
7:13 [33mwarning[0m 'AKS' is uppercase. Use gitlab.Uppercase
lowercase orbackticks
if
possible. Otherwise add this
word to the rule's exception
list.
37:8 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will:". Use present tense
instead.
49:8 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will:". Use present tense
instead.
55:23 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will send". Use present tense
instead.
93:65 [34msuggestion[0m Consider "after you" instead gitlab.SubstitutionSuggestions of "once you".[4mdoc/installation/cloud/eks.md[0m 1:1 [34msuggestion[0m The grade level - 9.70 - gitlab.ReadingLevel
refers to how hard the content
is to understand. Aim for
8th grade or lower by using
shorter sentences and words.
25:78 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will need". Use present tense
instead.
27:12 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will:". Use present tense
instead.
63:3 [34msuggestion[0m Consider "you should" instead gitlab.SubstitutionSuggestions of "We recommend".
73:71 [34msuggestion[0m Consider "in" instead of gitlab.SubstitutionSuggestions "within".
79:1 [33mwarning[0m 'There are' is not precise. gitlab.UnclearAntecedent
Try rewriting with a specific
subject and verb.
84:4 [34msuggestion[0m Avoid words like "currently" gitlab.CurrentStatus
when you write about future
features. Our documentation is
about the current state of the
product.
85:46 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
89:1 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
96:41 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will deploy". Use present
tense instead.
96:70 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will create". Use present
tense instead.
97:30 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
97:30 [34msuggestion[0m Consider "because" or "after" gitlab.SubstitutionSuggestions instead of "Since".
98:34 [33mwarning[0m If possible, use "use" instead gitlab.SubstitutionWarning
of "utilize".
101:1 [34msuggestion[0m Consider "you should" instead gitlab.SubstitutionSuggestions of "We recommend".
102:67 [33mwarning[0m 'CNAME' is uppercase. Use gitlab.Uppercase
lowercase orbackticks
if
possible. Otherwise add this
word to the rule's exception
list.
103:9 [34msuggestion[0m Consider "because" or "after" gitlab.SubstitutionSuggestions instead of "Since".
113:65 [34msuggestion[0m Consider "after you" instead gitlab.SubstitutionSuggestions of "once you".
120:5 [33mwarning[0m 'CNAME' is uppercase. Use gitlab.Uppercase
lowercase orbackticks
if
possible. Otherwise add this
word to the rule's exception
list.[4mdoc/development/style_guide.md[0m 1:1 [34msuggestion[0m The grade level - 9.26 - gitlab.ReadingLevel
refers to how hard the content
is to understand. Aim for
8th grade or lower by using
shorter sentences and words.
17:1 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
17:164 [34msuggestion[0m Be concise: rewrite the gitlab.Wordy
sentence to not use "Note
that".
133:39 [33mwarning[0m Spelling check: "gotmpl"? gitlab.Spelling
136:9 [33mwarning[0m Spelling check: "nindent"? gitlab.Spelling
141:17 [34msuggestion[0m Consider "in" instead of gitlab.SubstitutionSuggestions "within".
143:43 [34msuggestion[0m Avoid words like "easily" that gitlab.Simplicity
imply ease of use, because
the user may find this action
hard.
145:3 [34msuggestion[0m Avoid words like "Easy" that gitlab.Simplicity
imply ease of use, because
the user may find this action
hard.
218:13 [33mwarning[0m If possible, use "use" instead gitlab.SubstitutionWarning
of "utilize".
220:1 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
221:6 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will put". Use present tense
instead.
225:16 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
231:1 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
231:51 [34msuggestion[0m Avoid words like "easily" that gitlab.Simplicity
imply ease of use, because
the user may find this action
hard.
232:54 [33mwarning[0m 'HPA' is uppercase. Use gitlab.Uppercase
lowercase orbackticks
if
possible. Otherwise add this
word to the rule's exception
list.
234:29 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
234:43 [33mwarning[0m 'HPA' is uppercase. Use gitlab.Uppercase
lowercase orbackticks
if
possible. Otherwise add this
word to the rule's exception
list.
236:44 [33mwarning[0m If possible, use "use" instead gitlab.SubstitutionWarning
of "utilize".
237:36 [33mwarning[0m 'HPA' is uppercase. Use gitlab.Uppercase
lowercase orbackticks
if
possible. Otherwise add this
word to the rule's exception
list.
253:49 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will be". Use present tense
instead.
253:59 [34msuggestion[0m Avoid words like "simple" that gitlab.Simplicity
imply ease of use, because
the user may find this action
hard.
256:1 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
257:12 [33mwarning[0m 'HPA' is uppercase. Use gitlab.Uppercase
lowercase orbackticks
if
possible. Otherwise add this
word to the rule's exception
list.
258:63 [33mwarning[0m 'HPA' is uppercase. Use gitlab.Uppercase
lowercase orbackticks
if
possible. Otherwise add this
word to the rule's exception
list.
266:6 [34msuggestion[0m Consider "in" instead of gitlab.SubstitutionSuggestions "within".
268:79 [33mwarning[0m Spelling check: "golang"? gitlab.Spelling
272:1 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
275:16 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will sometimes". Use present
tense instead.
293:1 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
294:20 [34msuggestion[0m Consider "in" instead of gitlab.SubstitutionSuggestions "within".
308:49 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will always". Use present
tense instead.
309:17 [34msuggestion[0m Consider "in" instead of gitlab.SubstitutionSuggestions "within".
311:1 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
371:45 [33mwarning[0m 'ERB' is uppercase. Use gitlab.Uppercase
lowercase orbackticks
if
possible. Otherwise add this
word to the rule's exception
list.
372:5 [33mwarning[0m Spelling check: "gomplate"? gitlab.Spelling
376:23 [34msuggestion[0m Consider "in" instead of gitlab.SubstitutionSuggestions "within".
377:50 [34msuggestion[0m Be concise: use 'to' rather gitlab.Wordy
than "in order to".
379:4 [33mwarning[0m 'ERB' is uppercase. Use gitlab.Uppercase
lowercase orbackticks
if
possible. Otherwise add this
word to the rule's exception
list.
380:4 [33mwarning[0m Spelling check: "gomplate"? gitlab.Spelling
382:3 [33mwarning[0m 'ERB' is uppercase. Use gitlab.Uppercase
lowercase orbackticks
if
possible. Otherwise add this
word to the rule's exception
list.
384:25 [33mwarning[0m 'ERB' is uppercase. Use gitlab.Uppercase
lowercase orbackticks
if
possible. Otherwise add this
word to the rule's exception
list.
386:3 [33mwarning[0m Spelling check: "gomplate"? gitlab.Spelling
388:16 [33mwarning[0m Spelling check: "gomplate"? gitlab.Spelling
388:25 [34msuggestion[0m Be concise: use 'to' rather gitlab.Wordy
than "in order to".
388:73 [34msuggestion[0m Consider "in" instead of gitlab.SubstitutionSuggestions "within".
389:26 [33mwarning[0m Spelling check: "gomplate"? gitlab.Spelling
400:17 [33mwarning[0m 'ERB' is uppercase. Use gitlab.Uppercase
lowercase orbackticks
if
possible. Otherwise add this
word to the rule's exception
list.
400:23 [33mwarning[0m Spelling check: "Gomplate"? gitlab.Spelling
450:28 [33mwarning[0m Spelling check: "gomplate"? gitlab.Spelling
460:28 [33mwarning[0m 'NOTES' is uppercase. Use gitlab.Uppercase
lowercase orbackticks
if
possible. Otherwise add this
word to the rule's exception
list.
466:12 [33mwarning[0m 'NOTES' is uppercase. Use gitlab.Uppercase
lowercase orbackticks
if
possible. Otherwise add this
word to the rule's exception
list.
492:1 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).[4mdoc/installation/cloud/index.md[0m 1:1 [34msuggestion[0m The grade level - 8.08 - gitlab.ReadingLevel refers to how hard the content
is to understand. Aim for
8th grade or lower by using
shorter sentences and words.[4mdoc/installation/cloud/gke.md[0m 1:1 [34msuggestion[0m The grade level - 6.46 - gitlab.ReadingLevel
refers to how hard the content
is to understand. Aim for
8th grade or lower by using
shorter sentences and words.
9:45 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will need". Use present tense
instead.
11:12 [34msuggestion[0m Consider "in" instead of gitlab.SubstitutionSuggestions "within".
28:12 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will:". Use present tense
instead.
48:48 [34msuggestion[0m Verify this use of the gitlab.Admin
word "admin". Can it be
updated to "administration",
"administrator", "administer",
or "Admin Area"?
48:107 [33mwarning[0m Spelling check: "gcloud"? gitlab.Spelling
52:41 [34msuggestion[0m Consider "in" instead of gitlab.SubstitutionSuggestions "within".
53:25 [33mwarning[0m Spelling check: "subnetwork"? gitlab.Spelling
53:43 [34msuggestion[0m Consider "in" instead of gitlab.SubstitutionSuggestions "within".
79:3 [34msuggestion[0m Consider "you should" instead gitlab.SubstitutionSuggestions of "We recommend".
80:43 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will be". Use present tense
instead.
96:4 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will use". Use present tense
instead.
100:1 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
101:1 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"you'll need". Use present
tense instead.[4mdoc/installation/cloud/oke.md[0m 1:1 [34msuggestion[0m The grade level - 9.67 - gitlab.ReadingLevel
refers to how hard the content
is to understand. Aim for
8th grade or lower by using
shorter sentences and words.
7:13 [33mwarning[0m 'OKE' is uppercase. Use gitlab.Uppercase
lowercase orbackticks
if
possible. Otherwise add this
word to the rule's exception
list.
30:1 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
57:1 [34msuggestion[0m Consider "after you" instead gitlab.SubstitutionSuggestions of "Once you".[4mdoc/installation/database_upgrade.md[0m 1:1 [34msuggestion[0m The grade level - 7.25 - gitlab.ReadingLevel
refers to how hard the content
is to understand. Aim for
8th grade or lower by using
shorter sentences and words.
13:1 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
16:117 [33mwarning[0m 'This is' is not precise. gitlab.UnclearAntecedent
Try rewriting with a specific
subject and verb.
20:181 [33mwarning[0m 'This is' is not precise. gitlab.UnclearAntecedent
Try rewriting with a specific
subject and verb.
39:18 [33mwarning[0m Spelling check: "kubectx"? gitlab.Spelling
41:1 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
41:17 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will create". Use present
tense instead.
51:1 [34msuggestion[0m Consider "because" or "after" gitlab.SubstitutionSuggestions instead of "Since".
52:40 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will be". Use present tense
instead.
56:1 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will be". Use present tense
instead.
71:4 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will perform". Use present
tense instead.
77:3 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"You'll need". Use present
tense instead.
93:14 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will do". Use present tense
instead.
95:98 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will prevent". Use present
tense instead.
96:59 [33mwarning[0m Spelling check: "pre"? gitlab.Spelling
102:56 [34msuggestion[0m Avoid words like "useful" that gitlab.Simplicity
imply ease of use, because
the user may find this action
hard.[4mdoc/installation/cloud/openshift.md[0m 1:1 [34msuggestion[0m The grade level - 7.47 - gitlab.ReadingLevel
refers to how hard the content
is to understand. Aim for
8th grade or lower by using
shorter sentences and words.
14:44 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will arrange". Use present
tense instead.
14:98 [34msuggestion[0m Consider "after you" instead gitlab.SubstitutionSuggestions of "Once you".
14:142 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will have". Use present tense
instead.
28:131 [33mwarning[0m Spelling check: "gitignored"? gitlab.Spelling
33:1 [34msuggestion[0m Consider "after the" instead gitlab.SubstitutionSuggestions of "Once the".
33:132 [33mwarning[0m Spelling check: "gitignored"? gitlab.Spelling
52:6 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will be". Use present tense
instead.
52:53 [33mwarning[0m Use inclusive language. gitlab.InclusionCultural
Consider "primary, main"
instead of "master".
58:10 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will be". Use present tense
instead.
59:19 [33mwarning[0m Spelling check: "gitignored"? gitlab.Spelling
79:46 [34msuggestion[0m Avoid words like "useful" that gitlab.Simplicity
imply ease of use, because
the user may find this action
hard.
110:46 [34msuggestion[0m Avoid words like "useful" that gitlab.Simplicity
imply ease of use, because
the user may find this action
hard.
121:51 [34msuggestion[0m Consider "documentation" gitlab.SubstitutionSuggestions instead of "docs".
122:18 [34msuggestion[0m Consider "documentation" gitlab.SubstitutionSuggestions instead of "docs".[4mdoc/installation/deployment.md[0m 1:1 [34msuggestion[0m The grade level - 9.62 - gitlab.ReadingLevel
refers to how hard the content
is to understand. Aim for
8th grade or lower by using
shorter sentences and words.
9:78 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will run". Use present tense
instead.
11:12 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will cover". Use present
tense instead.
16:1 [34msuggestion[0m Consider "after you" instead gitlab.SubstitutionSuggestions of "Once you".
36:4 [33mwarning[0m Use "for example" instead of gitlab.LatinTerms
"e.g.", but consider rewriting
the sentence.
53:6 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will output". Use present
tense instead.
53:50 [34msuggestion[0m Consider "after the" instead gitlab.SubstitutionSuggestions of "once the".
55:1 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
85:1 [33mwarning[0m 'This is' is not precise. gitlab.UnclearAntecedent
Try rewriting with a specific
subject and verb.[4mdoc/charts/registry/index.md[0m 1:1 [34msuggestion[0m The grade level - 9.59 - gitlab.ReadingLevel
refers to how hard the content
is to understand. Aim for
8th grade or lower by using
shorter sentences and words.
29:5 [34msuggestion[0m Avoid words like "simple" that gitlab.Simplicity
imply ease of use, because
the user may find this action
hard.
36:62 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will contain". Use present
tense instead.
38:10 [33mwarning[0m Rewrite "instance(s)" to be gitlab.BadPlurals
plural, without parentheses.
40:61 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will contain". Use present
tense instead.
56:4 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will describe". Use present
tense instead.
57:37 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will be". Use present tense
instead.
145:252 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"Will not". Use present tense
instead.
153:412 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will default". Use present
tense instead.
158:327 [34msuggestion[0m Be concise: rewrite the gitlab.Wordy
sentence to not use "note
that".
163:314 [33mwarning[0m Use "for example" instead of gitlab.LatinTerms
"e.g.", but consider rewriting
the sentence.
166:276 [33mwarning[0m Spelling check: "downscaling"? gitlab.Spelling
190:251 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will be". Use present tense
instead.
192:238 [33mwarning[0m 'DSN' is uppercase. Use gitlab.Uppercase
lowercase orbackticks
if
possible. Otherwise add this
word to the rule's exception
list.
199:253 [33mwarning[0m 'This is' is not precise. gitlab.UnclearAntecedent
Try rewriting with a specific
subject and verb.
218:336 [34msuggestion[0m Be concise: rewrite the gitlab.Wordy
sentence to not use "Note
that".
218:387 [34msuggestion[0m Consider "in" instead of gitlab.SubstitutionSuggestions "within".
222:251 [33mwarning[0m Spelling check: "backoff"? gitlab.Spelling
222:414 [34msuggestion[0m Remove this word from the gitlab.Wordy
sentence: "Please".
222:421 [34msuggestion[0m Be concise: rewrite the gitlab.Wordy
sentence to not use "note
that".
223:268 [33mwarning[0m Spelling check: "backoffs"? gitlab.Spelling
231:291 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will be". Use present tense
instead.
231:350 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will continue". Use present
tense instead.
231:375 [33mwarning[0m If possible, use "file system" gitlab.SubstitutionWarning
instead of "filesystem".
231:387 [33mwarning[0m 'This is' is not precise. gitlab.UnclearAntecedent
Try rewriting with a specific
subject and verb.
232:291 [33mwarning[0m If possible, use "file system" gitlab.SubstitutionWarning
instead of "filesystem".
232:359 [33mwarning[0m 'This is' is not precise. gitlab.UnclearAntecedent
Try rewriting with a specific
subject and verb.
233:419 [33mwarning[0m 'This is' is not precise. gitlab.UnclearAntecedent
Try rewriting with a specific
subject and verb.
234:310 [33mwarning[0m 'This is' is not precise. gitlab.UnclearAntecedent
Try rewriting with a specific
subject and verb.
235:255 [33mwarning[0m Spelling check: "pre"? gitlab.Spelling
235:313 [33mwarning[0m 'This is' is not precise. gitlab.UnclearAntecedent
Try rewriting with a specific
subject and verb.
236:306 [33mwarning[0m If possible, use "file system" gitlab.SubstitutionWarning
instead of "filesystem".
236:407 [33mwarning[0m Spelling check: "pre"? gitlab.Spelling
236:433 [33mwarning[0m Spelling check: "Pre"? gitlab.Spelling
236:479 [33mwarning[0m 'This is' is not precise. gitlab.UnclearAntecedent
Try rewriting with a specific
subject and verb.
237:437 [33mwarning[0m 'This is' is not precise. gitlab.UnclearAntecedent
Try rewriting with a specific
subject and verb.
238:279 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will be". Use present tense
instead.
238:353 [33mwarning[0m 'This is' is not precise. gitlab.UnclearAntecedent
Try rewriting with a specific
subject and verb.
239:267 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will be". Use present tense
instead.
240:285 [33mwarning[0m 'This is' is not precise. gitlab.UnclearAntecedent
Try rewriting with a specific
subject and verb.
241:232 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will be". Use present tense
instead.
242:63 [33mwarning[0m 'This is' is not precise. gitlab.UnclearAntecedent
Try rewriting with a specific
subject and verb.
249:251 [33mwarning[0m Spelling check: "midleware"? gitlab.Spelling
250:376 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will be". Use present tense
instead.
251:288 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will be". Use present tense
instead.
256:306 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will be". Use present tense
instead.
320:1 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
340:16 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will be". Use present tense
instead.
363:112 [33mwarning[0m 'This is' is not precise. gitlab.UnclearAntecedent
Try rewriting with a specific
subject and verb.
363:127 [34msuggestion[0m Avoid words like "useful" that gitlab.Simplicity
imply ease of use, because
the user may find this action
hard.
387:38 [33mwarning[0m 'This is' is not precise. gitlab.UnclearAntecedent
Try rewriting with a specific
subject and verb.
420:25 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will fall". Use present tense
instead.
439:92 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will be". Use present tense
instead.
439:116 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will block". Use present
tense instead.
441:91 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will be". Use present tense
instead.
441:115 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will block". Use present
tense instead.
454:2 [34msuggestion[0m Be concise: rewrite the gitlab.Wordy
sentence to not use "Note
that".
495:26 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will automatically". Use
present tense instead.
495:84 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will be". Use present tense
instead.
506:1 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
510:40 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will be". Use present tense
instead.
550:71 [33mwarning[0m Rewrite "instance(s)" to be gitlab.BadPlurals
plural, without parentheses.
551:52 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will authenticate". Use
present tense instead.
553:77 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will automatically". Use
present tense instead.
554:56 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will be". Use present tense
instead.
564:10 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
565:90 [33mwarning[0m Rewrite "instance(s)" to be gitlab.BadPlurals
plural, without parentheses.
568:13 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will be". Use present tense
instead.
610:26 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
611:59 [33mwarning[0m Spelling check: "urls"? gitlab.Spelling
612:1 [34msuggestion[0m Consider "in" instead of gitlab.SubstitutionSuggestions "within".
626:61 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
635:184 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will be". Use present tense
instead.
636:204 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will be". Use present tense
instead.
648:20 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will look". Use present tense
instead.
689:1 [34msuggestion[0m Remove this word from the gitlab.Wordy
sentence: "Please".
692:9 [33mwarning[0m 'GCS' is uppercase. Use gitlab.Uppercase
lowercase orbackticks
if
possible. Otherwise add this
word to the rule's exception
list.
707:70 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will be". Use present tense
instead.
708:49 [34msuggestion[0m Consider "in" instead of gitlab.SubstitutionSuggestions "within".
736:7 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will need". Use present tense
instead.
740:44 [34msuggestion[0m Consider "you should" instead gitlab.SubstitutionSuggestions of "it is recommended".
744:11 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will populate". Use present
tense instead.
747:1 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will supersede". Use present
tense instead.
771:1 [34msuggestion[0m Consider "in" instead of gitlab.SubstitutionSuggestions "Within".
777:2 [33mwarning[0m Spelling check: "privatekey"? gitlab.Spelling
777:92 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will be". Use present tense
instead.
887:47 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will use". Use present tense
instead.
893:7 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will be". Use present tense
instead.
948:22 [33mwarning[0m If possible, use "file system" gitlab.SubstitutionWarning
instead of "filesystem".
951:1 [33mwarning[0m 'This is' is not precise. gitlab.UnclearAntecedent
Try rewriting with a specific
subject and verb.
974:5 [33mwarning[0m Spelling check: "gc"? gitlab.Spelling
980:1 [33mwarning[0m 'This is' is not precise. gitlab.UnclearAntecedent
Try rewriting with a specific
subject and verb.
1004:1 [33mwarning[0m 'This is' is not precise. gitlab.UnclearAntecedent
Try rewriting with a specific
subject and verb.
1037:1 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will take". Use present tense
instead.
1053:21 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will build". Use present
tense instead.
1083:1 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).[4mdoc/installation/index.md[0m 1:1 [34msuggestion[0m The grade level - 12.50 - gitlab.ReadingLevel
refers to how hard the content
is to understand. Aim for
8th grade or lower by using
shorter sentences and words.
20:80 [33mwarning[0m Spelling check: "dataplane"? gitlab.Spelling
31:1 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
42:1 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
42:269 [34msuggestion[0m Consider "in" instead of gitlab.SubstitutionSuggestions "within".[4mdoc/installation/migration/helm.md[0m 1:1 [34msuggestion[0m The grade level - 8.34 - gitlab.ReadingLevel
refers to how hard the content
is to understand. Aim for
8th grade or lower by using
shorter sentences and words.
10:28 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will need". Use present tense
instead.
14:344 [34msuggestion[0m Consider "because" or "after" gitlab.SubstitutionSuggestions instead of "since".
16:115 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
16:188 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will need". Use present tense
instead.
18:48 [34msuggestion[0m Avoid words like "currently" gitlab.CurrentStatus
when you write about future
features. Our documentation is
about the current state of the
product.
23:21 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
26:140 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will only". Use present tense
instead.
46:1 [33mwarning[0m 'This is' is not precise. gitlab.UnclearAntecedent
Try rewriting with a specific
subject and verb.
47:74 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
65:4 [33mwarning[0m 'This is' is not precise. gitlab.UnclearAntecedent
Try rewriting with a specific
subject and verb.
65:34 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"won't be". Use present tense
instead.
71:47 [33mwarning[0m 'PVC' is uppercase. Use gitlab.Uppercase
lowercase orbackticks
if
possible. Otherwise add this
word to the rule's exception
list.
92:67 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
92:231 [34msuggestion[0m Verify this use of the gitlab.Admin
word "admin". Can it be
updated to "administration",
"administrator", "administer",
or "Admin Area"?[4mdoc/installation/migration/helm_to_package.md[0m 1:1 [34msuggestion[0m The grade level - 8.80 - gitlab.ReadingLevel refers to how hard the content
is to understand. Aim for
8th grade or lower by using
shorter sentences and words.
11:14 [34msuggestion[0m Verify this use of the gitlab.Admin
word "admin". Can it be
updated to "administration",
"administrator", "administer",
or "Admin Area"?
11:29 [34msuggestion[0m Verify this use of the gitlab.Admin
word "admin". Can it be
updated to "administration",
"administrator", "administer",
or "Admin Area"?
22:17 [33mwarning[0m Spelling check: "yq"? gitlab.Spelling[4mdoc/installation/migration/index.md[0m 1:1 [34msuggestion[0m The grade level - 4.63 - gitlab.ReadingLevel refers to how hard the content
is to understand. Aim for
8th grade or lower by using
shorter sentences and words.[4mdoc/installation/migration/minio.md[0m 1:1 [34msuggestion[0m The grade level - 8.27 - gitlab.ReadingLevel
refers to how hard the content
is to understand. Aim for
8th grade or lower by using
shorter sentences and words.
9:1 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
11:55 [33mwarning[0m 'This is' is not precise. gitlab.UnclearAntecedent Try rewriting with a specific
subject and verb.
15:1 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).[4mdoc/installation/operator.md[0m 1:1 [34msuggestion[0m The grade level - 9.05 - gitlab.ReadingLevel refers to how hard the content
is to understand. Aim for
8th grade or lower by using
shorter sentences and words.[4mdoc/installation/migration/package_to_helm.md[0m 1:1 [34msuggestion[0m The grade level - 8.03 - gitlab.ReadingLevel
refers to how hard the content
is to understand. Aim for
8th grade or lower by using
shorter sentences and words.
9:12 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will help". Use present tense
instead.
24:3 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will use". Use present tense
instead.
24:33 [34msuggestion[0m Consider "you should" instead gitlab.SubstitutionSuggestions of "we recommend".
26:28 [34msuggestion[0m Consider "documentation" gitlab.SubstitutionSuggestions instead of "docs".
33:26 [34msuggestion[0m Can this reference to "GitLab gitlab.OutdatedVersions
12." be refactored?
91:20 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will be". Use present tense
instead.
96:54 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will need". Use present tense
instead.
97:70 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will be". Use present tense
instead.[4mdoc/installation/rbac.md[0m 1:1 [34msuggestion[0m The grade level - 7.37 - gitlab.ReadingLevel
refers to how hard the content
is to understand. Aim for
8th grade or lower by using
shorter sentences and words.
9:49 [34msuggestion[0m Consider "in" instead of gitlab.SubstitutionSuggestions "within".
9:67 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
9:262 [34msuggestion[0m Consider "in" instead of gitlab.SubstitutionSuggestions "within".
37:39 [34msuggestion[0m Be concise: rewrite the gitlab.Wordy
sentence to not use "Note
that".[4mdoc/installation/command-line-options.md[0m 1:1 [34msuggestion[0m The grade level - 8.50 - gitlab.ReadingLevel
refers to how hard the content
is to understand. Aim for
8th grade or lower by using
shorter sentences and words.
11:60 [33mwarning[0m Improve SEO and accessibility gitlab.MeaningfulLinkWords
by rewriting "here" in the
link text.
29:69 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will be". Use present tense
instead.
31:69 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will be". Use present tense
instead.
36:83 [33mwarning[0m Spelling check: "psql"? gitlab.Spelling
36:110 [33mwarning[0m Spelling check: "psql"? gitlab.Spelling
37:72 [33mwarning[0m Spelling check: "psql"? gitlab.Spelling
37:93 [33mwarning[0m Spelling check: "psql"? gitlab.Spelling
38:93 [33mwarning[0m Spelling check: "psql"? gitlab.Spelling
71:48 [33mwarning[0m 'HELO' is uppercase. Use gitlab.Uppercase
lowercase orbackticks
if
possible. Otherwise add this
word to the rule's exception
list.
78:57 [33mwarning[0m 'SMTPS' is uppercase. Use gitlab.Uppercase
lowercase orbackticks
if
possible. Otherwise add this
word to the rule's exception
list.
92:112 [34msuggestion[0m Consider "OAuth 2.0" instead gitlab.SubstitutionSuggestions of "OAuth2".
93:59 [33mwarning[0m Spelling check: "mailroom"? gitlab.Spelling
102:71 [33mwarning[0m 'IDLE' is uppercase. Use gitlab.Uppercase
lowercase orbackticks
if
possible. Otherwise add this
word to the rule's exception
list.
103:95 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will end". Use present tense
instead.
116:81 [34msuggestion[0m Consider "OAuth 2.0" instead gitlab.SubstitutionSuggestions of "OAuth2".
117:129 [34msuggestion[0m Consider "OAuth 2.0" instead gitlab.SubstitutionSuggestions of "OAuth2".
118:92 [34msuggestion[0m Consider "OAuth 2.0" instead gitlab.SubstitutionSuggestions of "OAuth2".
128:1 [34msuggestion[0m Be concise: rewrite the gitlab.Wordy
sentence to not use "Note
that".
141:115 [34msuggestion[0m Consider "OAuth 2.0" instead gitlab.SubstitutionSuggestions of "OAuth2".
142:62 [33mwarning[0m Spelling check: "mailroom"? gitlab.Spelling
151:61 [33mwarning[0m 'IDLE' is uppercase. Use gitlab.Uppercase
lowercase orbackticks
if
possible. Otherwise add this
word to the rule's exception
list.
152:89 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will end". Use present tense
instead.
165:84 [34msuggestion[0m Consider "OAuth 2.0" instead gitlab.SubstitutionSuggestions of "OAuth2".
166:135 [34msuggestion[0m Consider "OAuth 2.0" instead gitlab.SubstitutionSuggestions of "OAuth2".
167:95 [34msuggestion[0m Consider "OAuth 2.0" instead gitlab.SubstitutionSuggestions of "OAuth2".
295:50 [33mwarning[0m Use "default branch" ormain
gitlab.DefaultBranch
instead ofmaster
, when
possible.
321:55 [33mwarning[0m Use "default branch" ormain
gitlab.DefaultBranch
instead ofmaster
, when
possible.
336:58 [33mwarning[0m Use "default branch" ormain
gitlab.DefaultBranch
instead ofmaster
, when
possible.
337:50 [33mwarning[0m Spelling check: "psql"? gitlab.Spelling
337:67 [33mwarning[0m Spelling check: "psql"? gitlab.Spelling
338:46 [33mwarning[0m Spelling check: "psql"? gitlab.Spelling
349:52 [33mwarning[0m Use "default branch" ormain
gitlab.DefaultBranch
instead ofmaster
, when
possible.
350:47 [33mwarning[0m Spelling check: "psql"? gitlab.Spelling
350:64 [33mwarning[0m Spelling check: "psql"? gitlab.Spelling
351:43 [33mwarning[0m Spelling check: "psql"? gitlab.Spelling
382:52 [33mwarning[0m Use "default branch" ormain
gitlab.DefaultBranch
instead ofmaster
, when
possible.
399:33 [33mwarning[0m Spelling check: "webservice"? gitlab.Spelling
403:42 [33mwarning[0m Spelling check: "webservice"? gitlab.Spelling
404:42 [33mwarning[0m Spelling check: "webservice"? gitlab.Spelling
405:35 [33mwarning[0m Spelling check: "webservice"? gitlab.Spelling
405:58 [33mwarning[0m Use "default branch" ormain
gitlab.DefaultBranch
instead ofmaster
, when
possible.
406:50 [33mwarning[0m Spelling check: "psql"? gitlab.Spelling
406:67 [33mwarning[0m Spelling check: "psql"? gitlab.Spelling
407:46 [33mwarning[0m Spelling check: "psql"? gitlab.Spelling
413:38 [33mwarning[0m Spelling check: "webservice"? gitlab.Spelling
414:48 [33mwarning[0m Spelling check: "webservice"? gitlab.Spelling
415:51 [33mwarning[0m Spelling check: "webservice"? gitlab.Spelling
419:38 [33mwarning[0m Spelling check: "webservice"? gitlab.Spelling
420:46 [33mwarning[0m Spelling check: "webservice"? gitlab.Spelling
421:46 [33mwarning[0m Spelling check: "webservice"? gitlab.Spelling
422:37 [33mwarning[0m Spelling check: "webservice"? gitlab.Spelling
423:40 [33mwarning[0m Spelling check: "webservice"? gitlab.Spelling
424:50 [33mwarning[0m Spelling check: "webservice"? gitlab.Spelling
425:50 [33mwarning[0m Spelling check: "webservice"? gitlab.Spelling
426:38 [33mwarning[0m Spelling check: "webservice"? gitlab.Spelling
431:41 [33mwarning[0m Spelling check: "webservice"? gitlab.Spelling
432:39 [33mwarning[0m Spelling check: "webservice"? gitlab.Spelling
435:45 [33mwarning[0m 'DSN' is uppercase. Use gitlab.Uppercase
lowercase orbackticks
if
possible. Otherwise add this
word to the rule's exception
list.
440:43 [33mwarning[0m 'These are' is not precise. gitlab.UnclearAntecedent
Try rewriting with a specific
subject and verb.
453:23 [33mwarning[0m Use "that is" instead of gitlab.LatinTerms
"i.e.", but consider rewriting
the sentence.[4mdoc/installation/storage.md[0m 1:1 [34msuggestion[0m The grade level - 10.94 - gitlab.ReadingLevel
refers to how hard the content
is to understand. Aim for
8th grade or lower by using
shorter sentences and words.
9:28 [34msuggestion[0m Consider "in" instead of gitlab.SubstitutionSuggestions "within".
52:72 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will mitigate". Use present
tense instead.
56:60 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will be". Use present tense
instead.
81:1 [33mwarning[0m Use a comma before the last gitlab.OxfordComma
"and" or "or" in a list of
four or more items.
82:1 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will need". Use present tense
instead.
135:67 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will need". Use present tense
instead.
147:36 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will still". Use present
tense instead.
151:3 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will use". Use present tense
instead.
155:1 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).[4mdoc/installation/tls.md[0m 1:1 [34msuggestion[0m The grade level - 9.89 - gitlab.ReadingLevel
refers to how hard the content
is to understand. Aim for
8th grade or lower by using
shorter sentences and words.
14:4 [33mwarning[0m Use standard single quotes or gitlab.NonStandardQuotes
double quotes only. Do not use
left or right quotes.
72:71 [33mwarning[0m Use "for example" instead of gitlab.LatinTerms
"e.g.", but consider rewriting
the sentence.
87:13 [33mwarning[0m 'ACM' is uppercase. Use gitlab.Uppercase
lowercase orbackticks
if
possible. Otherwise add this
word to the rule's exception
list.
89:1 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
89:22 [33mwarning[0m 'ACM' is uppercase. Use gitlab.Uppercase
lowercase orbackticks
if
possible. Otherwise add this
word to the rule's exception
list.
89:115 [33mwarning[0m 'ACM' is uppercase. Use gitlab.Uppercase
lowercase orbackticks
if
possible. Otherwise add this
word to the rule's exception
list.
122:1 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
128:13 [34msuggestion[0m Avoid words like "useful" that gitlab.Simplicity
imply ease of use, because
the user may find this action
hard.
131:97 [34msuggestion[0m Consider "you should" instead gitlab.SubstitutionSuggestions of "We recommend".
141:26 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will then". Use present tense
instead.
142:77 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will be". Use present tense
instead.
144:66 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will access". Use present
tense instead.
155:4 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
156:76 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will have". Use present tense
instead.
177:1 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
179:28 [33mwarning[0m Spelling check: "letsdebug"? gitlab.Spelling
180:7 [33mwarning[0m Spelling check: "letsdebug"? gitlab.Spelling[4mdoc/installation/uninstall.md[0m 1:1 [34msuggestion[0m The grade level - 7.57 - gitlab.ReadingLevel
refers to how hard the content
is to understand. Aim for
8th grade or lower by using
shorter sentences and words.
16:51 [33mwarning[0m 'These are' is not precise. gitlab.UnclearAntecedent Try rewriting with a specific
subject and verb.
20:13 [33mwarning[0m 'This is' is not precise. gitlab.UnclearAntecedent Try rewriting with a specific
subject and verb.
21:31 [33mwarning[0m 'This is' is not precise. gitlab.UnclearAntecedent Try rewriting with a specific
subject and verb.
22:26 [33mwarning[0m 'This is' is not precise. gitlab.UnclearAntecedent Try rewriting with a specific
subject and verb.
27:48 [33mwarning[0m 'This is' is not precise. gitlab.UnclearAntecedent Try rewriting with a specific
subject and verb.[4mdoc/installation/secrets.md[0m 1:1 [34msuggestion[0m The grade level - 7.90 - gitlab.ReadingLevel
refers to how hard the content
is to understand. Aim for
8th grade or lower by using
shorter sentences and words.
25:24 [34msuggestion[0m Consider "OAuth 2.0" instead gitlab.SubstitutionSuggestions of "OAuth2".
26:24 [34msuggestion[0m Consider "OAuth 2.0" instead gitlab.SubstitutionSuggestions of "OAuth2".
31:34 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will be". Use present tense
instead.
33:4 [33mwarning[0m If possible, use "use" instead gitlab.SubstitutionWarning
of "utilize".
91:4 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will create". Use present
tense instead.
106:47 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"WILL NOT". Use present tense
instead.
106:47 [33mwarning[0m 'WILL' is uppercase. Use gitlab.Uppercase
lowercase orbackticks
if
possible. Otherwise add this
word to the rule's exception
list.
106:52 [33mwarning[0m 'NOT' is uppercase. Use gitlab.Uppercase
lowercase orbackticks
if
possible. Otherwise add this
word to the rule's exception
list.
116:26 [34msuggestion[0m Consider "in" instead of gitlab.SubstitutionSuggestions "within".
144:13 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will only". Use present tense
instead.
178:1 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
178:54 [34msuggestion[0m Remove this word from the gitlab.Wordy
sentence: "please".
238:67 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will be". Use present tense
instead.
259:12 [33mwarning[0m 'KAS' is uppercase. Use gitlab.Uppercase
lowercase orbackticks
if
possible. Otherwise add this
word to the rule's exception
list.
261:41 [33mwarning[0m 'KAS' is uppercase. Use gitlab.Uppercase
lowercase orbackticks
if
possible. Otherwise add this
word to the rule's exception
list.
261:111 [33mwarning[0m 'KAS' is uppercase. Use gitlab.Uppercase
lowercase orbackticks
if
possible. Otherwise add this
word to the rule's exception
list.
269:12 [33mwarning[0m 'KAS' is uppercase. Use gitlab.Uppercase
lowercase orbackticks
if
possible. Otherwise add this
word to the rule's exception
list.
271:1 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
329:94 [33mwarning[0m Spelling check: "webservice"? gitlab.Spelling
354:1 [34msuggestion[0m Be concise: use 'to' rather gitlab.Wordy
than "In order to".
354:132 [34msuggestion[0m Remove this word from the gitlab.Wordy
sentence: "please".
401:60 [34msuggestion[0m Consider "documentation" gitlab.SubstitutionSuggestions instead of "docs".
417:50 [33mwarning[0m Spelling check: "webservice"? gitlab.Spelling
430:50 [33mwarning[0m Spelling check: "webservice"? gitlab.Spelling
442:56 [34msuggestion[0m Consider "documentation" gitlab.SubstitutionSuggestions instead of "docs".
457:60 [34msuggestion[0m Consider "documentation" gitlab.SubstitutionSuggestions instead of "docs".
481:42 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will need". Use present tense
instead.
491:36 [34msuggestion[0m Consider "documentation" gitlab.SubstitutionSuggestions instead of "docs".
492:71 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
494:57 [33mwarning[0m 'This is' is not precise. gitlab.UnclearAntecedent
Try rewriting with a specific
subject and verb.
501:64 [33mwarning[0m 'MUST' is uppercase. Use gitlab.Uppercase
lowercase orbackticks
if
possible. Otherwise add this
word to the rule's exception
list.
507:73 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).[4mdoc/installation/tools.md[0m 1:1 [34msuggestion[0m The grade level - 10.41 - gitlab.ReadingLevel
refers to how hard the content
is to understand. Aim for
8th grade or lower by using
shorter sentences and words.
10:41 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"you'll use". Use present
tense instead.
17:33 [34msuggestion[0m Consider "in" instead of gitlab.SubstitutionSuggestions "within".
32:50 [34msuggestion[0m Consider "because" or "after" gitlab.SubstitutionSuggestions instead of "since".
53:5 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will use". Use present tense
instead.
81:47 [33mwarning[0m 'CNAME' is uppercase. Use gitlab.Uppercase
lowercase orbackticks
if
possible. Otherwise add this
word to the rule's exception
list.
142:1 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
154:1 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
166:1 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
168:67 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
173:1 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
199:1 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
219:60 [33mwarning[0m Spelling check: "tls"? gitlab.Spelling
219:64 [33mwarning[0m Spelling check: "config"? gitlab.Spelling
221:21 [33mwarning[0m Spelling check: "config"? gitlab.Spelling
260:1 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
260:48 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will also". Use present tense
instead.
272:1 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
276:59 [34msuggestion[0m Consider "documentation" gitlab.SubstitutionSuggestions instead of "Docs".
278:74 [33mwarning[0m 'YES' is uppercase. Use gitlab.Uppercase
lowercase orbackticks
if
possible. Otherwise add this
word to the rule's exception
list.
278:173 [34msuggestion[0m Consider "documentation" gitlab.SubstitutionSuggestions instead of "Docs".
279:74 [33mwarning[0m 'YES' is uppercase. Use gitlab.Uppercase
lowercase orbackticks
if
possible. Otherwise add this
word to the rule's exception
list.
280:74 [33mwarning[0m 'YES' is uppercase. Use gitlab.Uppercase
lowercase orbackticks
if
possible. Otherwise add this
word to the rule's exception
list.
280:194 [34msuggestion[0m Consider "documentation" gitlab.SubstitutionSuggestions instead of "Docs".
283:4 [33mwarning[0m 'KAS' is uppercase. Use gitlab.Uppercase
lowercase orbackticks
if
possible. Otherwise add this
word to the rule's exception
list.
284:74 [33mwarning[0m 'YES' is uppercase. Use gitlab.Uppercase
lowercase orbackticks
if
possible. Otherwise add this
word to the rule's exception
list.
284:177 [34msuggestion[0m Consider "documentation" gitlab.SubstitutionSuggestions instead of "Docs".
285:74 [33mwarning[0m 'YES' is uppercase. Use gitlab.Uppercase
lowercase orbackticks
if
possible. Otherwise add this
word to the rule's exception
list.
285:133 [34msuggestion[0m Consider "documentation" gitlab.SubstitutionSuggestions instead of "Docs".
286:74 [33mwarning[0m 'YES' is uppercase. Use gitlab.Uppercase
lowercase orbackticks
if
possible. Otherwise add this
word to the rule's exception
list.
286:191 [34msuggestion[0m Consider "documentation" gitlab.SubstitutionSuggestions instead of "Docs".
287:74 [33mwarning[0m 'YES' is uppercase. Use gitlab.Uppercase
lowercase orbackticks
if
possible. Otherwise add this
word to the rule's exception
list.
287:197 [34msuggestion[0m Consider "documentation" gitlab.SubstitutionSuggestions instead of "Docs".
288:112 [33mwarning[0m Spelling check: "healthcheck"? gitlab.Spelling
290:9 [33mwarning[0m Spelling check: "webservice"? gitlab.Spelling
290:60 [33mwarning[0m Spelling check: "webrick"? gitlab.Spelling
291:5 [33mwarning[0m Spelling check: "webservice"? gitlab.Spelling
311:2 [33mwarning[0m Spelling check: "mailroom"? gitlab.Spelling
316:2 [33mwarning[0m Spelling check: "mailroom"? gitlab.Spelling[4mdoc/installation/upgrade_old.md[0m 1:1 [34msuggestion[0m The grade level - 7.31 - gitlab.ReadingLevel
refers to how hard the content
is to understand. Aim for
8th grade or lower by using
shorter sentences and words.
15:43 [34msuggestion[0m Be concise: use 'to' rather gitlab.Wordy
than "in order to".
22:1 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength readability (max 25 words).
40:18 [33mwarning[0m Spelling check: "kubectx"? gitlab.Spelling
42:1 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength readability (max 25 words).
42:17 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will create". Use present
tense instead.
59:156 [33mwarning[0m 'NAME' is uppercase. Use gitlab.Uppercase
lowercase orbackticks
if
possible. Otherwise add this
word to the rule's exception
list.
89:6 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will change". Use present
tense instead.
101:4 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will perform". Use present
tense instead.
109:3 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"You'll need". Use present
tense instead.
120:14 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will do". Use present tense
instead.
122:98 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will prevent". Use present
tense instead.
123:59 [33mwarning[0m Spelling check: "pre"? gitlab.Spelling
135:56 [34msuggestion[0m Avoid words like "useful" that gitlab.Simplicity
imply ease of use, because
the user may find this action
hard.
151:44 [33mwarning[0m Spelling check: "configmaps"? gitlab.Spelling
153:31 [33mwarning[0m Spelling check: "configmaps"? gitlab.Spelling[4mdoc/releases/1_0.md[0m 1:1 [34msuggestion[0m The grade level - 9.29 - gitlab.ReadingLevel
refers to how hard the content
is to understand. Aim for
8th grade or lower by using
shorter sentences and words.
9:1 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
20:138 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will require". Use present
tense instead.
31:181 [34msuggestion[0m Consider "you should" instead gitlab.SubstitutionSuggestions of "We recommend".
40:19 [34msuggestion[0m Avoid words like "currently" gitlab.CurrentStatus
when you write about future
features. Our documentation is
about the current state of the
product.
48:4 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will be". Use present tense
instead.
52:167 [34msuggestion[0m Avoid words like "easily" that gitlab.Simplicity
imply ease of use, because
the user may find this action
hard.
57:72 [34msuggestion[0m Remove this word from the gitlab.Wordy
sentence: "please".
59:8 [34msuggestion[0m Avoid words like "currently" gitlab.CurrentStatus
when you write about future
features. Our documentation is
about the current state of the
product.
63:25 [34msuggestion[0m Remove this word from the gitlab.Wordy
sentence: "please".[4mdoc/installation/version_mappings.md[0m 1:1 [34msuggestion[0m The grade level - 9.62 - gitlab.ReadingLevel
refers to how hard the content
is to understand. Aim for
8th grade or lower by using
shorter sentences and words.
10:1 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
459:5 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will receive". Use present
tense instead.
470:40 [33mwarning[0m Improve SEO and accessibility gitlab.MeaningfulLinkWords by rewriting "here" in the
link text.[4mdoc/quickstart/index.md[0m 1:1 [34msuggestion[0m The grade level - 7.45 - gitlab.ReadingLevel
refers to how hard the content
is to understand. Aim for
8th grade or lower by using
shorter sentences and words.
9:1 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
14:19 [33mwarning[0m 'Those are' is not precise. gitlab.UnclearAntecedent
Try rewriting with a specific
subject and verb.
31:15 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
32:61 [34msuggestion[0m Be concise: use 'to' rather gitlab.Wordy
than "in order to".
40:1 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"We'll instead". Use present
tense instead.
96:1 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
113:1 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"You'll notice". Use present
tense instead.
116:12 [34msuggestion[0m Consider "you should" instead gitlab.SubstitutionSuggestions of "we recommend".
120:27 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will be". Use present tense
instead.
130:1 [33mwarning[0m 'This is' is not precise. gitlab.UnclearAntecedent
Try rewriting with a specific
subject and verb.
138:1 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).[4mdoc/releases/2_0.md[0m 1:1 [34msuggestion[0m The grade level - 7.98 - gitlab.ReadingLevel
refers to how hard the content
is to understand. Aim for
8th grade or lower by using
shorter sentences and words.
16:1 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
16:17 [34msuggestion[0m Be concise: use 'to' rather gitlab.Wordy
than "in order to".
19:61 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will see". Use present tense
instead.
27:38 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will see". Use present tense
instead.
37:181 [34msuggestion[0m Consider "you should" instead gitlab.SubstitutionSuggestions of "We recommend".
46:19 [34msuggestion[0m Avoid words like "currently" gitlab.CurrentStatus
when you write about future
features. Our documentation is
about the current state of the
product.
52:4 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will be". Use present tense
instead.
56:167 [34msuggestion[0m Avoid words like "easily" that gitlab.Simplicity
imply ease of use, because
the user may find this action
hard.
65:101 [34msuggestion[0m Remove this word from the gitlab.Wordy
sentence: "please".
67:8 [34msuggestion[0m Avoid words like "currently" gitlab.CurrentStatus
when you write about future
features. Our documentation is
about the current state of the
product.
71:25 [34msuggestion[0m Remove this word from the gitlab.Wordy
sentence: "please".[4mdoc/installation/upgrade.md[0m 1:1 [34msuggestion[0m The grade level - 8.78 - gitlab.ReadingLevel
refers to how hard the content
is to understand. Aim for
8th grade or lower by using
shorter sentences and words.
9:1 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
20:84 [34msuggestion[0m Be concise: rewrite the gitlab.Wordy
sentence to not use "note
that".
30:71 [33mwarning[0m Improve SEO and accessibility gitlab.MeaningfulLinkWords by rewriting "here" in the
link text.
44:1 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
44:6 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will almost". Use present
tense instead.
44:136 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will cause". Use present
tense instead.
56:70 [33mwarning[0m Use a comma before the last gitlab.OxfordComma
"and" or "or" in a list of
four or more items.
92:117 [33mwarning[0m 'This is' is not precise. gitlab.UnclearAntecedent
Try rewriting with a specific
subject and verb.
98:181 [33mwarning[0m 'This is' is not precise. gitlab.UnclearAntecedent
Try rewriting with a specific
subject and verb.
103:1 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
141:1 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
150:1 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
155:43 [34msuggestion[0m Be concise: use 'to' rather gitlab.Wordy
than "in order to".
155:76 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
171:56 [34msuggestion[0m Avoid words like "useful" that gitlab.Simplicity
imply ease of use, because
the user may find this action
hard.
180:43 [34msuggestion[0m Be concise: use 'to' rather gitlab.Wordy
than "in order to".
180:76 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
196:56 [34msuggestion[0m Avoid words like "useful" that gitlab.Simplicity
imply ease of use, because
the user may find this action
hard.
205:27 [34msuggestion[0m Avoid words like "yet" gitlab.CurrentStatus
when you write about future
features. Our documentation is
about the current state of the
product.
207:1 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
208:1 [34msuggestion[0m Be concise: rewrite the gitlab.Wordy
sentence to not use "note
that".
208:43 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will now". Use present tense
instead.
214:36 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will change". Use present
tense instead.
235:55 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will likely". Use present
tense instead.
240:1 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
241:1 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will be". Use present tense
instead.
248:1 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).[4mdoc/releases/4_0.md[0m 1:1 [34msuggestion[0m The grade level - 7.56 - gitlab.ReadingLevel
refers to how hard the content
is to understand. Aim for
8th grade or lower by using
shorter sentences and words.
25:1 [34msuggestion[0m Be concise: use 'to' rather gitlab.Wordy
than "In order to".
28:61 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will see". Use present tense
instead.
36:38 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will see". Use present tense
instead.
47:1 [34msuggestion[0m Remove this word from the gitlab.Wordy
sentence: "Please".
54:85 [33mwarning[0m 'This is' is not precise. gitlab.UnclearAntecedent Try rewriting with a specific
subject and verb.
61:1 [34msuggestion[0m Be concise: rewrite the gitlab.Wordy
sentence to not use "Note
that".
66:75 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will remove". Use present
tense instead.
68:32 [33mwarning[0m Spelling check: "webservers"? gitlab.Spelling
72:8 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will be". Use present tense
instead.
80:23 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will remain". Use present
tense instead.
92:92 [34msuggestion[0m Remove this word from the gitlab.Wordy
sentence: "Please".
97:108 [34msuggestion[0m Remove this word from the gitlab.Wordy
sentence: "Please".
110:19 [34msuggestion[0m Avoid words like "currently" gitlab.CurrentStatus
when you write about future
features. Our documentation is
about the current state of the
product.
116:4 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will be". Use present tense
instead.
120:167 [34msuggestion[0m Avoid words like "easily" that gitlab.Simplicity
imply ease of use, because
the user may find this action
hard.
129:101 [34msuggestion[0m Remove this word from the gitlab.Wordy
sentence: "please".
135:25 [34msuggestion[0m Remove this word from the gitlab.Wordy
sentence: "please".[4mdoc/releases/6_0.md[0m 1:1 [34msuggestion[0m The grade level - 7.72 - gitlab.ReadingLevel refers to how hard the content
is to understand. Aim for
8th grade or lower by using
shorter sentences and words.
21:1 [34msuggestion[0m Be concise: use 'to' rather gitlab.Wordy
than "In order to".
24:62 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will see". Use present tense
instead.
32:38 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will see". Use present tense
instead.
43:1 [34msuggestion[0m Remove this word from the gitlab.Wordy
sentence: "Please".
58:4 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will be". Use present tense
instead.
62:169 [34msuggestion[0m Avoid words like "easily" that gitlab.Simplicity
imply ease of use, because
the user may find this action
hard.
71:101 [34msuggestion[0m Remove this word from the gitlab.Wordy
sentence: "please".
77:25 [34msuggestion[0m Remove this word from the gitlab.Wordy
sentence: "please".[4mdoc/releases/5_0.md[0m 1:1 [34msuggestion[0m The grade level - 8.25 - gitlab.ReadingLevel
refers to how hard the content
is to understand. Aim for
8th grade or lower by using
shorter sentences and words.
20:1 [34msuggestion[0m Be concise: use 'to' rather gitlab.Wordy
than "In order to".
23:62 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will see". Use present tense
instead.
31:38 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will see". Use present tense
instead.
42:1 [34msuggestion[0m Remove this word from the gitlab.Wordy
sentence: "Please".
48:105 [33mwarning[0m 'This is' is not precise. gitlab.UnclearAntecedent Try rewriting with a specific
subject and verb.
55:1 [34msuggestion[0m Be concise: rewrite the gitlab.Wordy
sentence to not use "Note
that".
60:1 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
63:5 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will need". Use present tense
instead.
76:108 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
77:91 [33mwarning[0m Spelling check: "seperate"? gitlab.Spelling
78:65 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will need". Use present tense
instead.
81:113 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
82:104 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will be". Use present tense
instead.
83:14 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will be". Use present tense
instead.
90:93 [34msuggestion[0m Remove this word from the gitlab.Wordy
sentence: "Please".
97:19 [34msuggestion[0m Avoid words like "currently" gitlab.CurrentStatus
when you write about future
features. Our documentation is
about the current state of the
product.
103:4 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will be". Use present tense
instead.
107:169 [34msuggestion[0m Avoid words like "easily" that gitlab.Simplicity
imply ease of use, because
the user may find this action
hard.
116:101 [34msuggestion[0m Remove this word from the gitlab.Wordy
sentence: "please".
122:25 [34msuggestion[0m Remove this word from the gitlab.Wordy
sentence: "please".[4mdoc/releases/3_0.md[0m 1:1 [34msuggestion[0m The grade level - 8.51 - gitlab.ReadingLevel
refers to how hard the content
is to understand. Aim for
8th grade or lower by using
shorter sentences and words.
9:1 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
9:43 [34msuggestion[0m Be concise: use 'to' rather gitlab.Wordy
than "in order to".
29:1 [34msuggestion[0m Be concise: use 'to' rather gitlab.Wordy
than "In order to".
32:61 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will see". Use present tense
instead.
40:38 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will see". Use present tense
instead.
52:60 [34msuggestion[0m Be concise: use 'to' rather gitlab.Wordy
than "in order to".
52:103 [34msuggestion[0m Remove this word from the gitlab.Wordy
sentence: "Please".
60:79 [33mwarning[0m 'This is' is not precise. gitlab.UnclearAntecedent
Try rewriting with a specific
subject and verb.
70:28 [34msuggestion[0m Consider "you should" instead gitlab.SubstitutionSuggestions of "we recommend".
74:1 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
75:17 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will fix". Use present tense
instead.
86:1 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
91:56 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will be". Use present tense
instead.
96:19 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will use". Use present tense
instead.
96:111 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will be". Use present tense
instead.
97:58 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will be". Use present tense
instead.
105:50 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
116:65 [34msuggestion[0m Be concise: use 'to' rather gitlab.Wordy
than "in order to".
124:92 [34msuggestion[0m Remove this word from the gitlab.Wordy
sentence: "Please".
137:19 [34msuggestion[0m Avoid words like "currently" gitlab.CurrentStatus
when you write about future
features. Our documentation is
about the current state of the
product.
143:4 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will be". Use present tense
instead.
147:167 [34msuggestion[0m Avoid words like "easily" that gitlab.Simplicity
imply ease of use, because
the user may find this action
hard.
156:101 [34msuggestion[0m Remove this word from the gitlab.Wordy
sentence: "please".
158:8 [34msuggestion[0m Avoid words like "currently" gitlab.CurrentStatus
when you write about future
features. Our documentation is
about the current state of the
product.
162:25 [34msuggestion[0m Remove this word from the gitlab.Wordy
sentence: "please".[4mdoc/releases/beta.md[0m 1:1 [34msuggestion[0m The grade level - 8.43 - gitlab.ReadingLevel
refers to how hard the content
is to understand. Aim for
8th grade or lower by using
shorter sentences and words.
9:1 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
18:84 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will be". Use present tense
instead.
22:16 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will be". Use present tense
instead.
23:1 [34msuggestion[0m Be concise: use 'to' rather gitlab.Wordy
than "In order to".
23:1 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
23:61 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will be". Use present tense
instead.
27:167 [34msuggestion[0m Avoid words like "easily" that gitlab.Simplicity
imply ease of use, because
the user may find this action
hard.
32:72 [34msuggestion[0m Remove this word from the gitlab.Wordy
sentence: "please".
34:8 [34msuggestion[0m Avoid words like "currently" gitlab.CurrentStatus
when you write about future
features. Our documentation is
about the current state of the
product.
38:25 [34msuggestion[0m Remove this word from the gitlab.Wordy
sentence: "please".
46:181 [34msuggestion[0m Consider "you should" instead gitlab.SubstitutionSuggestions of "We recommend".
65:19 [34msuggestion[0m Avoid words like "currently" gitlab.CurrentStatus
when you write about future
features. Our documentation is
about the current state of the
product.
73:39 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will be". Use present tense
instead.
79:101 [33mwarning[0m 'AKS' is uppercase. Use gitlab.Uppercase
lowercase orbackticks
if
possible. Otherwise add this
word to the rule's exception
list.
79:106 [33mwarning[0m 'PKS' is uppercase. Use gitlab.Uppercase
lowercase orbackticks
if
possible. Otherwise add this
word to the rule's exception
list.[4mdoc/releases/alpha.md[0m 1:1 [34msuggestion[0m The grade level - 8.87 - gitlab.ReadingLevel
refers to how hard the content
is to understand. Aim for
8th grade or lower by using
shorter sentences and words.
12:1 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
21:84 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will be". Use present tense
instead.
25:1 [34msuggestion[0m Be concise: use 'to' rather gitlab.Wordy
than "In order to".
25:81 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will be". Use present tense
instead.
25:101 [33mwarning[0m Use "default branch" ormain
gitlab.DefaultBranch
instead ofmaster
, when
possible.
25:172 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will be". Use present tense
instead.
27:1 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
27:166 [34msuggestion[0m Avoid words like "easily" that gitlab.Simplicity
imply ease of use, because
the user may find this action
hard.
32:72 [34msuggestion[0m Remove this word from the gitlab.Wordy
sentence: "please".
34:8 [34msuggestion[0m Avoid words like "currently" gitlab.CurrentStatus
when you write about future
features. Our documentation is
about the current state of the
product.
40:4 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will be". Use present tense
instead.
44:113 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will not". Use present tense
instead.
46:25 [34msuggestion[0m Remove this word from the gitlab.Wordy
sentence: "please".
56:181 [34msuggestion[0m Consider "you should" instead gitlab.SubstitutionSuggestions of "We recommend".
70:33 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"won't work". Use present
tense instead.
73:19 [34msuggestion[0m Avoid words like "currently" gitlab.CurrentStatus
when you write about future
features. Our documentation is
about the current state of the
product.
81:51 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will be". Use present tense
instead.
90:39 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will be". Use present tense
instead.
96:101 [33mwarning[0m 'AKS' is uppercase. Use gitlab.Uppercase
lowercase orbackticks
if
possible. Otherwise add this
word to the rule's exception
list.
96:106 [33mwarning[0m 'PKS' is uppercase. Use gitlab.Uppercase
lowercase orbackticks
if
possible. Otherwise add this
word to the rule's exception
list.[4mdoc/charts/globals.md[0m 1:1 [34msuggestion[0m The grade level - 9.10 - gitlab.ReadingLevel
refers to how hard the content
is to understand. Aim for
8th grade or lower by using
shorter sentences and words.
12:1 [34msuggestion[0m Consider "in" instead of gitlab.SubstitutionSuggestions "within".
33:4 [33mwarning[0m Spelling check: "Busybox"? gitlab.Spelling
77:91 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will be". Use present tense
instead.
78:87 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will be". Use present tense
instead.
78:127 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will be". Use present tense
instead.
79:74 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will need". Use present tense
instead.
81:125 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will use". Use present tense
instead.
83:141 [34msuggestion[0m Avoid words like "Useful" that gitlab.Simplicity
imply ease of use, because
the user may find this action
hard.
83:187 [33mwarning[0m 'WAF' is uppercase. Use gitlab.Uppercase
lowercase orbackticks
if
possible. Otherwise add this
word to the rule's exception
list.
83:243 [33mwarning[0m Use "for example" instead of gitlab.LatinTerms
"e.g.", but consider rewriting
the sentence.
84:131 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will template". Use present
tense instead.
86:123 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will use". Use present tense
instead.
88:127 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will template". Use present
tense instead.
90:129 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will use". Use present tense
instead.
92:130 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will template". Use present
tense instead.
95:75 [33mwarning[0m 'KAS' is uppercase. Use gitlab.Uppercase
lowercase orbackticks
if
possible. Otherwise add this
word to the rule's exception
list.
96:102 [33mwarning[0m 'KAS' is uppercase. Use gitlab.Uppercase
lowercase orbackticks
if
possible. Otherwise add this
word to the rule's exception
list.
96:119 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will use". Use present tense
instead.
98:197 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will use". Use present tense
instead.
119:37 [33mwarning[0m 'HPA' is uppercase. Use gitlab.Uppercase
lowercase orbackticks
if
possible. Otherwise add this
word to the rule's exception
list.
127:37 [33mwarning[0m 'PDB' is uppercase. Use gitlab.Uppercase
lowercase orbackticks
if
possible. Otherwise add this
word to the rule's exception
list.
148:103 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will be". Use present tense
instead.
152:113 [33mwarning[0m 'This is' is not precise. gitlab.UnclearAntecedent
Try rewriting with a specific
subject and verb.
152:121 [34msuggestion[0m Avoid words like "useful" that gitlab.Simplicity
imply ease of use, because
the user may find this action
hard.
169:1 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
181:14 [33mwarning[0m Spelling check: "aws"? gitlab.Spelling
181:29 [33mwarning[0m Spelling check: gitlab.Spelling
"loadbalancer"?
182:14 [33mwarning[0m Spelling check: "aws"? gitlab.Spelling
182:29 [33mwarning[0m Spelling check: gitlab.Spelling
"loadbalancer"?
189:65 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will activate". Use present
tense instead.
203:97 [34msuggestion[0m Remove this word from the gitlab.Wordy
sentence: "Please".
215:9 [34msuggestion[0m Be concise: rewrite the gitlab.Wordy
sentence to not use "Note
that".
249:182 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will template". Use present
tense instead.
260:96 [33mwarning[0m Spelling check: "keepalives"? gitlab.Spelling
261:129 [33mwarning[0m Spelling check: "keepalive"? gitlab.Spelling
262:103 [33mwarning[0m Spelling check: "keepalive"? gitlab.Spelling
263:81 [33mwarning[0m Spelling check: "keepalives"? gitlab.Spelling
265:177 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will be". Use present tense
instead.
265:225 [33mwarning[0m Use "for example" instead of gitlab.LatinTerms
"e.g.", but consider rewriting
the sentence.
271:22 [34msuggestion[0m Consider "in" instead of gitlab.SubstitutionSuggestions "within".
272:55 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will override". Use present
tense instead.
286:1 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
303:61 [34msuggestion[0m Consider "in" instead of gitlab.SubstitutionSuggestions "within".
304:61 [34msuggestion[0m Consider "in" instead of gitlab.SubstitutionSuggestions "within".
305:61 [34msuggestion[0m Consider "in" instead of gitlab.SubstitutionSuggestions "within".
406:158 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will template". Use present
tense instead.
406:260 [33mwarning[0m 'This is' is not precise. gitlab.UnclearAntecedent
Try rewriting with a specific
subject and verb.
435:45 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will need". Use present tense
instead.
478:28 [34msuggestion[0m Avoid words like "currently" gitlab.CurrentStatus
when you write about future
features. Our documentation is
about the current state of the
product.
490:67 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will be". Use present tense
instead.
573:23 [34msuggestion[0m Remove this word from the gitlab.Wordy
sentence: "Please".
603:135 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
605:30 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will deploy". Use present
tense instead.
623:109 [34msuggestion[0m Consider "in" instead of gitlab.SubstitutionSuggestions "within".
694:43 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will be". Use present tense
instead.
705:12 [34msuggestion[0m Avoid words like "currently" gitlab.CurrentStatus
when you write about future
features. Our documentation is
about the current state of the
product.
707:71 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will be". Use present tense
instead.
708:76 [34msuggestion[0m Consider "in" instead of gitlab.SubstitutionSuggestions "within".
709:82 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will match". Use present
tense instead.
717:9 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will become". Use present
tense instead.
717:34 [34msuggestion[0m Consider "because" or "after" gitlab.SubstitutionSuggestions instead of "Since".
718:24 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will not". Use present tense
instead.
718:48 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
718:74 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will persist". Use present
tense instead.
750:10 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will be". Use present tense
instead.
768:162 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will override". Use present
tense instead.
770:159 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will template". Use present
tense instead.
770:261 [33mwarning[0m 'This is' is not precise. gitlab.UnclearAntecedent
Try rewriting with a specific
subject and verb.
780:26 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
780:81 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will be". Use present tense
instead.
780:124 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will need". Use present tense
instead.
810:107 [33mwarning[0m Spelling check: "psql"? gitlab.Spelling
816:42 [34msuggestion[0m Consider "in" instead of gitlab.SubstitutionSuggestions "within".
1060:66 [33mwarning[0m Spelling check: "Bizible"? gitlab.Spelling
1062:26 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
1066:34 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
1067:19 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will be". Use present tense
instead.
1091:27 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
1095:27 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will automatically". Use
present tense instead.
1133:117 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
1144:158 [33mwarning[0m 'KMS' is uppercase. Use gitlab.Uppercase
lowercase orbackticks
if
possible. Otherwise add this
word to the rule's exception
list.
1177:98 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will be". Use present tense
instead.
1183:62 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will be". Use present tense
instead.
1215:27 [33mwarning[0m Spelling check: "cdn"? gitlab.Spelling
1223:146 [33mwarning[0m 'KAS' is uppercase. Use gitlab.Uppercase
lowercase orbackticks
if
possible. Otherwise add this
word to the rule's exception
list.
1229:26 [33mwarning[0m 'KAS' is uppercase. Use gitlab.Uppercase
lowercase orbackticks
if
possible. Otherwise add this
word to the rule's exception
list.
1251:11 [33mwarning[0m 'KAS' is uppercase. Use gitlab.Uppercase
lowercase orbackticks
if
possible. Otherwise add this
word to the rule's exception
list.
1269:7 [33mwarning[0m 'KAS' is uppercase. Use gitlab.Uppercase
lowercase orbackticks
if
possible. Otherwise add this
word to the rule's exception
list.
1269:12 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
1271:45 [33mwarning[0m 'KAS' is uppercase. Use gitlab.Uppercase
lowercase orbackticks
if
possible. Otherwise add this
word to the rule's exception
list.
1271:57 [33mwarning[0m Use "that is" instead of gitlab.LatinTerms
"i.e.", but consider rewriting
the sentence.
1295:46 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will be". Use present tense
instead.
1299:7 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will then". Use present tense
instead.
1334:112 [34msuggestion[0m Consider "in" instead of gitlab.SubstitutionSuggestions "within".
1340:3 [34msuggestion[0m Avoid words like "useful" that gitlab.Simplicity
imply ease of use, because
the user may find this action
hard.
1342:34 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will not". Use present tense
instead.
1371:6 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will ensure". Use present
tense instead.
1405:174 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will be". Use present tense
instead.
1406:156 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will be". Use present tense
instead.
1409:76 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will be". Use present tense
instead.
1409:107 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will have". Use present tense
instead.
1411:189 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will be". Use present tense
instead.
1411:237 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will need". Use present tense
instead.
1414:124 [33mwarning[0m If possible, use "information" gitlab.SubstitutionWarning
instead of "info".
1434:36 [34msuggestion[0m Consider "OAuth 2.0" instead gitlab.SubstitutionSuggestions of "OAuth2".
1496:22 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will be". Use present tense
instead.
1556:40 [33mwarning[0m 'DSN' is uppercase. Use gitlab.Uppercase
lowercase orbackticks
if
possible. Otherwise add this
word to the rule's exception
list.
1557:40 [33mwarning[0m 'DSN' is uppercase. Use gitlab.Uppercase
lowercase orbackticks
if
possible. Otherwise add this
word to the rule's exception
list.
1558:126 [33mwarning[0m Spelling check: "gitlab"? gitlab.Spelling
1574:58 [33mwarning[0m Spelling check: "gitlab"? gitlab.Spelling
1575:38 [34msuggestion[0m Consider "documentation" gitlab.SubstitutionSuggestions instead of "docs".
1601:76 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
1605:11 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
1637:75 [34msuggestion[0m Consider "in" instead of gitlab.SubstitutionSuggestions "within".
1637:184 [34msuggestion[0m Avoid words like "easy" that gitlab.Simplicity
imply ease of use, because
the user may find this action
hard.
1648:72 [33mwarning[0m 'This is' is not precise. gitlab.UnclearAntecedent
Try rewriting with a specific
subject and verb.
1648:80 [34msuggestion[0m Avoid words like "currently" gitlab.CurrentStatus
when you write about future
features. Our documentation is
about the current state of the
product.
1648:216 [34msuggestion[0m Avoid words like "easy" that gitlab.Simplicity
imply ease of use, because
the user may find this action
hard.
1660:132 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will be". Use present tense
instead.
1663:70 [33mwarning[0m Spelling check: "tls"? gitlab.Spelling
1672:295 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
1674:8 [34msuggestion[0m Consider "you should" instead gitlab.SubstitutionSuggestions of "we recommend".
1676:20 [33mwarning[0m 'There are' is not precise. gitlab.UnclearAntecedent
Try rewriting with a specific
subject and verb.
1698:3 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
1701:51 [33mwarning[0m 'This is' is not precise. gitlab.UnclearAntecedent
Try rewriting with a specific
subject and verb.
1711:52 [34msuggestion[0m Be concise: rewrite the gitlab.Wordy
sentence to not use "Note
that".
1712:62 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will override". Use present
tense instead.
1729:11 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will prevent". Use present
tense instead.
1729:86 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
1731:181 [33mwarning[0m Spelling check: gitlab.Spelling
"loadbalancer"?
1776:151 [34msuggestion[0m Consider "because" or "after" gitlab.SubstitutionSuggestions instead of "since".
1786:74 [34msuggestion[0m Consider "in" instead of gitlab.SubstitutionSuggestions "within".
1788:93 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will be". Use present tense
instead.
1790:74 [34msuggestion[0m Consider "in" instead of gitlab.SubstitutionSuggestions "within".
1806:21 [33mwarning[0m Use inclusive language. gitlab.InclusionCultural
Consider "primary, main"
instead of "master".
1845:22 [33mwarning[0m 'These are' is not precise. gitlab.UnclearAntecedent
Try rewriting with a specific
subject and verb.
1852:49 [34msuggestion[0m Consider "in" instead of gitlab.SubstitutionSuggestions "within".
1853:6 [33mwarning[0m 'CRD' is uppercase. Use gitlab.Uppercase
lowercase orbackticks
if
possible. Otherwise add this
word to the rule's exception
list.
1882:1 [33mwarning[0m Spelling check: "Busybox"? gitlab.Spelling
1887:9 [33mwarning[0m 'This is' is not precise. gitlab.UnclearAntecedent
Try rewriting with a specific
subject and verb.
1903:156 [33mwarning[0m 'This is' is not precise. gitlab.UnclearAntecedent
Try rewriting with a specific
subject and verb.
1916:45 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will create". Use present
tense instead.
1917:45 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will disable". Use present
tense instead.
1918:32 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will use". Use present tense
instead.
1974:80 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will be". Use present tense
instead.
1976:19 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will receive". Use present
tense instead.
1977:52 [33mwarning[0m Spelling check: "Webservices"? gitlab.Spelling
1991:4 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will also". Use present tense
instead.
1991:14 [33mwarning[0m Spelling check: "recieve"? gitlab.Spelling
1995:44 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will receive". Use present
tense instead.
2037:66 [33mwarning[0m If possible, use "information" gitlab.SubstitutionWarning
instead of "info".
2042:55 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
2043:10 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will be". Use present tense
instead.
2118:1 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
2120:1 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
2126:99 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will also". Use present tense
instead.
2128:1 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
2128:35 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will still". Use present
tense instead.
2128:94 [33mwarning[0m Spelling check: "webservice"? gitlab.Spelling
2156:1 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
2158:1 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
2158:30 [34msuggestion[0m Avoid words like "currently" gitlab.CurrentStatus
when you write about future
features. Our documentation is
about the current state of the
product.
2173:259 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
2176:117 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will not". Use present tense
instead.
2176:126 [34msuggestion[0m Avoid words like "currently" gitlab.CurrentStatus
when you write about future
features. Our documentation is
about the current state of the
product.
2176:221 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will need". Use present tense
instead.
2180:1 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
2216:78 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
2233:117 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will try". Use present tense
instead.
2233:150 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will not". Use present tense
instead.[4mdoc/troubleshooting/kubernetes_cheat_sheet.md[0m 1:1 [34msuggestion[0m The grade level - 6.45 - gitlab.ReadingLevel
refers to how hard the content
is to understand. Aim for
8th grade or lower by using
shorter sentences and words.
10:1 [33mwarning[0m 'This is' is not precise. gitlab.UnclearAntecedent
Try rewriting with a specific
subject and verb.
10:19 [34msuggestion[0m Avoid words like "useful" that gitlab.Simplicity
imply ease of use, because
the user may find this action
hard.
17:1 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
19:10 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will assist". Use present
tense instead.
23:59 [34msuggestion[0m Avoid words like "useful" that gitlab.Simplicity
imply ease of use, because
the user may find this action
hard.
74:3 [33mwarning[0m 'This is' is not precise. gitlab.UnclearAntecedent
Try rewriting with a specific
subject and verb.
84:7 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will be". Use present tense
instead.
121:15 [34msuggestion[0m Avoid words like "useful" that gitlab.Simplicity
imply ease of use, because
the user may find this action
hard.
156:28 [34msuggestion[0m Consider "in" instead of gitlab.SubstitutionSuggestions "within".
215:52 [34msuggestion[0m Avoid words like "useful" that gitlab.Simplicity
imply ease of use, because
the user may find this action
hard.
280:39 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will be". Use present tense
instead.[4mdoc/troubleshooting/index.md[0m 1:1 [34msuggestion[0m The grade level - 8.14 - gitlab.ReadingLevel
refers to how hard the content
is to understand. Aim for
8th grade or lower by using
shorter sentences and words.
11:1 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
14:74 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will need". Use present tense
instead.
58:1 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
63:55 [34msuggestion[0m Remove this word from the gitlab.Wordy
sentence: "Please".
101:1 [33mwarning[0m 'This is' is not precise. gitlab.UnclearAntecedent
Try rewriting with a specific
subject and verb.
101:57 [34msuggestion[0m Avoid words like "yet" gitlab.CurrentStatus
when you write about future
features. Our documentation is
about the current state of the
product.
104:74 [33mwarning[0m 'This is' is not precise. gitlab.UnclearAntecedent
Try rewriting with a specific
subject and verb.
116:68 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will block". Use present
tense instead.
125:23 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will perform". Use present
tense instead.
187:40 [33mwarning[0m 'This was' is not precise. gitlab.UnclearAntecedent
Try rewriting with a specific
subject and verb.
190:1 [34msuggestion[0m Consider "after the" instead gitlab.SubstitutionSuggestions of "Once the".
190:1 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
196:23 [34msuggestion[0m Avoid words like "simply" that gitlab.Simplicity
imply ease of use, because
the user may find this action
hard.
205:20 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will not". Use present tense
instead.
208:6 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will change". Use present
tense instead.
217:32 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will automatically". Use
present tense instead.
220:28 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will delete". Use present
tense instead.
220:88 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will use". Use present tense
instead.
233:27 [33mwarning[0m 'NAME' is uppercase. Use gitlab.Uppercase
lowercase orbackticks
if
possible. Otherwise add this
word to the rule's exception
list.
242:1 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
243:13 [34msuggestion[0m Be concise: use 'to' rather gitlab.Wordy
than "in order to".
284:1 [33mwarning[0m 'This is' is not precise. gitlab.UnclearAntecedent
Try rewriting with a specific
subject and verb.
287:37 [33mwarning[0m Spelling check: "mailroom"? gitlab.Spelling
291:38 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"will cause". Use present
tense instead.
303:1 [34msuggestion[0m Be concise: rewrite the gitlab.Wordy
sentence to not use "Note
that".
342:1 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
395:1 [33mwarning[0m 'There are' is not precise. gitlab.UnclearAntecedent
Try rewriting with a specific
subject and verb.
403:28 [33mwarning[0m Spelling check: "keepalive"? gitlab.Spelling
452:1 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
453:2 [33mwarning[0m Spelling check: "gomplate"? gitlab.Spelling
458:1 [33mwarning[0m Shorter sentences improve gitlab.SentenceLength
readability (max 25 words).
491:59 [33mwarning[0m Avoid using future tense: gitlab.FutureTense
"won't work". Use present
tense instead.✖ [31m0 errors[0m, [33m1256 warnings[0m and [34m478 suggestions[0m in 106 files.