Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Support
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
G
gitlab-ce
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Issues
0
Issues
0
List
Boards
Labels
Milestones
Merge Requests
1
Merge Requests
1
Analytics
Analytics
Repository
Value Stream
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Commits
Issue Boards
Open sidebar
nexedi
gitlab-ce
Commits
45d583f4
Commit
45d583f4
authored
Jun 24, 2020
by
Evan Read
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Update link to Vale styles documentation
parent
ac722682
Changes
22
Hide whitespace changes
Inline
Side-by-side
Showing
22 changed files
with
22 additions
and
22 deletions
+22
-22
doc/.vale/gitlab/Acronyms.yml
doc/.vale/gitlab/Acronyms.yml
+1
-1
doc/.vale/gitlab/BadgeCapitalization.yml
doc/.vale/gitlab/BadgeCapitalization.yml
+1
-1
doc/.vale/gitlab/British.yml
doc/.vale/gitlab/British.yml
+1
-1
doc/.vale/gitlab/CodeblockFences.yml
doc/.vale/gitlab/CodeblockFences.yml
+1
-1
doc/.vale/gitlab/Contractions.yml
doc/.vale/gitlab/Contractions.yml
+1
-1
doc/.vale/gitlab/CurlStringsQuoted.yml
doc/.vale/gitlab/CurlStringsQuoted.yml
+1
-1
doc/.vale/gitlab/CurrentStatus.yml
doc/.vale/gitlab/CurrentStatus.yml
+1
-1
doc/.vale/gitlab/FirstPerson.yml
doc/.vale/gitlab/FirstPerson.yml
+1
-1
doc/.vale/gitlab/InternalLinkExtension.yml
doc/.vale/gitlab/InternalLinkExtension.yml
+1
-1
doc/.vale/gitlab/LatinTerms.yml
doc/.vale/gitlab/LatinTerms.yml
+1
-1
doc/.vale/gitlab/MeaningfulLinkWords.yml
doc/.vale/gitlab/MeaningfulLinkWords.yml
+1
-1
doc/.vale/gitlab/MergeConflictMarkers.yml
doc/.vale/gitlab/MergeConflictMarkers.yml
+1
-1
doc/.vale/gitlab/OxfordComma.yml
doc/.vale/gitlab/OxfordComma.yml
+1
-1
doc/.vale/gitlab/ReferenceLinks.yml
doc/.vale/gitlab/ReferenceLinks.yml
+1
-1
doc/.vale/gitlab/RelativeLinks.yml
doc/.vale/gitlab/RelativeLinks.yml
+1
-1
doc/.vale/gitlab/Repetition.yml
doc/.vale/gitlab/Repetition.yml
+1
-1
doc/.vale/gitlab/SentenceLength.yml
doc/.vale/gitlab/SentenceLength.yml
+1
-1
doc/.vale/gitlab/SentenceSpacing.yml
doc/.vale/gitlab/SentenceSpacing.yml
+1
-1
doc/.vale/gitlab/Spelling.yml
doc/.vale/gitlab/Spelling.yml
+1
-1
doc/.vale/gitlab/SubstitutionWarning.yml
doc/.vale/gitlab/SubstitutionWarning.yml
+1
-1
doc/.vale/gitlab/Substitutions.yml
doc/.vale/gitlab/Substitutions.yml
+1
-1
doc/.vale/gitlab/VersionText.yml
doc/.vale/gitlab/VersionText.yml
+1
-1
No files found.
doc/.vale/gitlab/Acronyms.yml
View file @
45d583f4
...
@@ -3,7 +3,7 @@
...
@@ -3,7 +3,7 @@
#
#
# Checks for unexpanded acronyms.
# Checks for unexpanded acronyms.
#
#
# For a list of all options, see https://errata-ai.git
hub.io/vale/styles/
# For a list of all options, see https://errata-ai.git
book.io/vale/getting-started/styles
extends
:
conditional
extends
:
conditional
message
:
'
"%s"
has
no
definition.'
message
:
'
"%s"
has
no
definition.'
link
:
https://about.gitlab.com/handbook/marketing/growth-marketing/content/editorial-team/#acronyms
link
:
https://about.gitlab.com/handbook/marketing/growth-marketing/content/editorial-team/#acronyms
...
...
doc/.vale/gitlab/BadgeCapitalization.yml
View file @
45d583f4
...
@@ -3,7 +3,7 @@
...
@@ -3,7 +3,7 @@
#
#
# Verifies that badges are not mixed case, which won't render properly.
# Verifies that badges are not mixed case, which won't render properly.
#
#
# For a list of all options, see https://errata-ai.git
hub.io/vale/styles/
# For a list of all options, see https://errata-ai.git
book.io/vale/getting-started/styles
extends
:
existence
extends
:
existence
message
:
'
Badge
"%s"
must
be
capitalized.'
message
:
'
Badge
"%s"
must
be
capitalized.'
link
:
https://docs.gitlab.com/ee/development/documentation/styleguide.html#product-badges
link
:
https://docs.gitlab.com/ee/development/documentation/styleguide.html#product-badges
...
...
doc/.vale/gitlab/British.yml
View file @
45d583f4
...
@@ -3,7 +3,7 @@
...
@@ -3,7 +3,7 @@
#
#
# Checks that US spelling is used over British spelling.
# Checks that US spelling is used over British spelling.
#
#
# For a list of all options, see https://errata-ai.git
hub.io/vale/styles/
# For a list of all options, see https://errata-ai.git
book.io/vale/getting-started/styles
extends
:
substitution
extends
:
substitution
message
:
'
Use
the
US
spelling
"%s"
instead
of
the
British
"%s".'
message
:
'
Use
the
US
spelling
"%s"
instead
of
the
British
"%s".'
link
:
https://about.gitlab.com/handbook/communication/#top-misused-terms
link
:
https://about.gitlab.com/handbook/communication/#top-misused-terms
...
...
doc/.vale/gitlab/CodeblockFences.yml
View file @
45d583f4
...
@@ -3,7 +3,7 @@
...
@@ -3,7 +3,7 @@
#
#
# Ensures all codeblock language tags use the full name, not aliases.
# Ensures all codeblock language tags use the full name, not aliases.
#
#
# For a list of all options, see https://errata-ai.git
hub.io/vale/styles/
# For a list of all options, see https://errata-ai.git
book.io/vale/getting-started/styles
extends
:
existence
extends
:
existence
message
:
'
Syntax
highlighting
hint
"%s"
must
be
one
of:
yaml,
ruby,
plaintext,
markdown,
javascript,
shell,
golang,
python,
dockerfile,
or
typescript.'
message
:
'
Syntax
highlighting
hint
"%s"
must
be
one
of:
yaml,
ruby,
plaintext,
markdown,
javascript,
shell,
golang,
python,
dockerfile,
or
typescript.'
link
:
https://docs.gitlab.com/ee/development/documentation/styleguide.html#code-blocks
link
:
https://docs.gitlab.com/ee/development/documentation/styleguide.html#code-blocks
...
...
doc/.vale/gitlab/Contractions.yml
View file @
45d583f4
...
@@ -3,7 +3,7 @@
...
@@ -3,7 +3,7 @@
#
#
# Checks for use of common and uncommon contractions.
# Checks for use of common and uncommon contractions.
#
#
# For a list of all options, see https://errata-ai.git
hub.io/vale/styles/
# For a list of all options, see https://errata-ai.git
book.io/vale/getting-started/styles
extends
:
substitution
extends
:
substitution
message
:
'
Use
"%s"
instead
of
"%s",
for
a
friendly,
informal
tone.'
message
:
'
Use
"%s"
instead
of
"%s",
for
a
friendly,
informal
tone.'
link
:
https://docs.gitlab.com/ee/development/documentation/styleguide.html#language
link
:
https://docs.gitlab.com/ee/development/documentation/styleguide.html#language
...
...
doc/.vale/gitlab/CurlStringsQuoted.yml
View file @
45d583f4
...
@@ -3,7 +3,7 @@
...
@@ -3,7 +3,7 @@
#
#
# Ensures all codeblocks using curl quote any URL strings.
# Ensures all codeblocks using curl quote any URL strings.
#
#
# For a list of all options, see https://errata-ai.git
hub.io/vale/styles/
# For a list of all options, see https://errata-ai.git
book.io/vale/getting-started/styles
extends
:
existence
extends
:
existence
message
:
'
Curl
commands
must
wrap
URLs
in
double
quotes
("):
%s'
message
:
'
Curl
commands
must
wrap
URLs
in
double
quotes
("):
%s'
link
:
https://docs.gitlab.com/ee/development/documentation/styleguide.html#curl-commands
link
:
https://docs.gitlab.com/ee/development/documentation/styleguide.html#curl-commands
...
...
doc/.vale/gitlab/CurrentStatus.yml
View file @
45d583f4
...
@@ -2,7 +2,7 @@
...
@@ -2,7 +2,7 @@
# Suggestion: gitlab.CurrentStatus
# Suggestion: gitlab.CurrentStatus
# Checks for words that indicate a product or feature may change in the future.
# Checks for words that indicate a product or feature may change in the future.
#
#
# For a list of all options, see https://errata-ai.git
hub.io/vale/styles/
# For a list of all options, see https://errata-ai.git
book.io/vale/getting-started/styles
extends
:
existence
extends
:
existence
message
:
'
Avoid
words
like
"%s"
that
promise
future
changes.'
message
:
'
Avoid
words
like
"%s"
that
promise
future
changes.'
level
:
suggestion
level
:
suggestion
...
...
doc/.vale/gitlab/FirstPerson.yml
View file @
45d583f4
...
@@ -3,7 +3,7 @@
...
@@ -3,7 +3,7 @@
#
#
# Checks for use of first person pronouns.
# Checks for use of first person pronouns.
#
#
# For a list of all options, see https://errata-ai.git
hub.io/vale/styles/
# For a list of all options, see https://errata-ai.git
book.io/vale/getting-started/styles
extends
:
existence
extends
:
existence
message
:
'
"%s"
is
a
first-person
pronoun.
Use
second-
or
third-person
pronouns
(like
we,
you,
us,
one)
instead.'
message
:
'
"%s"
is
a
first-person
pronoun.
Use
second-
or
third-person
pronouns
(like
we,
you,
us,
one)
instead.'
level
:
warning
level
:
warning
...
...
doc/.vale/gitlab/InternalLinkExtension.yml
View file @
45d583f4
...
@@ -3,7 +3,7 @@
...
@@ -3,7 +3,7 @@
#
#
# Checks that internal links have .md extenstion and not .html extension.
# Checks that internal links have .md extenstion and not .html extension.
#
#
# For a list of all options, see https://errata-ai.git
hub.io/vale/styles/
# For a list of all options, see https://errata-ai.git
book.io/vale/getting-started/styles
extends
:
existence
extends
:
existence
message
:
'
Link
"%s"
must
use
the
.md
file
extension.'
message
:
'
Link
"%s"
must
use
the
.md
file
extension.'
link
:
https://docs.gitlab.com/ee/development/documentation/styleguide.html#links-to-internal-documentation
link
:
https://docs.gitlab.com/ee/development/documentation/styleguide.html#links-to-internal-documentation
...
...
doc/.vale/gitlab/LatinTerms.yml
View file @
45d583f4
...
@@ -3,7 +3,7 @@
...
@@ -3,7 +3,7 @@
#
#
# Checks for use of latin terms.
# Checks for use of latin terms.
#
#
# For a list of all options, see https://errata-ai.git
hub.io/vale/styles/
# For a list of all options, see https://errata-ai.git
book.io/vale/getting-started/styles
extends
:
substitution
extends
:
substitution
message
:
'
Use
"%s"
instead
of
"%s",
but
consider
rewriting
the
sentence.'
message
:
'
Use
"%s"
instead
of
"%s",
but
consider
rewriting
the
sentence.'
link
:
https://docs.gitlab.com/ee/development/documentation/styleguide.html#language
link
:
https://docs.gitlab.com/ee/development/documentation/styleguide.html#language
...
...
doc/.vale/gitlab/MeaningfulLinkWords.yml
View file @
45d583f4
...
@@ -3,7 +3,7 @@
...
@@ -3,7 +3,7 @@
#
#
# Checks for the presence of semantically unhelpful words in link text.
# Checks for the presence of semantically unhelpful words in link text.
#
#
# For a list of all options, see https://errata-ai.git
hub.io/vale/styles/
# For a list of all options, see https://errata-ai.git
book.io/vale/getting-started/styles
extends
:
existence
extends
:
existence
message
:
'
Improve
SEO
and
accessibility
by
rewriting
"%s"
in
the
link
text.'
message
:
'
Improve
SEO
and
accessibility
by
rewriting
"%s"
in
the
link
text.'
level
:
warning
level
:
warning
...
...
doc/.vale/gitlab/MergeConflictMarkers.yml
View file @
45d583f4
...
@@ -3,7 +3,7 @@
...
@@ -3,7 +3,7 @@
#
#
# Checks for the presence of merge conflict markers.
# Checks for the presence of merge conflict markers.
#
#
# For a list of all options, see https://errata-ai.git
hub.io/vale/styles/
# For a list of all options, see https://errata-ai.git
book.io/vale/getting-started/styles
extends
:
existence
extends
:
existence
message
:
'
Merge
conflict
marker
"%s"
found.'
message
:
'
Merge
conflict
marker
"%s"
found.'
link
:
https://docs.gitlab.com/ee/development/code_review.html#merging-a-merge-request
link
:
https://docs.gitlab.com/ee/development/code_review.html#merging-a-merge-request
...
...
doc/.vale/gitlab/OxfordComma.yml
View file @
45d583f4
...
@@ -4,7 +4,7 @@
...
@@ -4,7 +4,7 @@
# Checks for the lack of an Oxford comma. In some cases, will catch overly
# Checks for the lack of an Oxford comma. In some cases, will catch overly
# complex sentence structures with lots of commas.
# complex sentence structures with lots of commas.
#
#
# For a list of all options, see https://errata-ai.git
hub.io/vale/styles/
# For a list of all options, see https://errata-ai.git
book.io/vale/getting-started/styles
extends
:
existence
extends
:
existence
message
:
'
Use
a
comma
before
the
last
"and"
or
"or"
in
a
list
of
four
or
more
items.'
message
:
'
Use
a
comma
before
the
last
"and"
or
"or"
in
a
list
of
four
or
more
items.'
link
:
https://docs.gitlab.com/ee/development/documentation/styleguide.html#punctuation
link
:
https://docs.gitlab.com/ee/development/documentation/styleguide.html#punctuation
...
...
doc/.vale/gitlab/ReferenceLinks.yml
View file @
45d583f4
...
@@ -3,7 +3,7 @@
...
@@ -3,7 +3,7 @@
#
#
# Checks for the presence of reference-style links that must be inline.
# Checks for the presence of reference-style links that must be inline.
#
#
# For a list of all options, see https://errata-ai.git
hub.io/vale/styles/
# For a list of all options, see https://errata-ai.git
book.io/vale/getting-started/styles
extends
:
existence
extends
:
existence
message
:
'
Link
"%s"
must
be
inline.'
message
:
'
Link
"%s"
must
be
inline.'
link
:
https://docs.gitlab.com/ee/development/documentation/styleguide.html#basic-link-criteria
link
:
https://docs.gitlab.com/ee/development/documentation/styleguide.html#basic-link-criteria
...
...
doc/.vale/gitlab/RelativeLinks.yml
View file @
45d583f4
...
@@ -3,7 +3,7 @@
...
@@ -3,7 +3,7 @@
#
#
# Checks for the presence of absolute hyperlinks that should be relative.
# Checks for the presence of absolute hyperlinks that should be relative.
#
#
# For a list of all options, see https://errata-ai.git
hub.io/vale/styles/
# For a list of all options, see https://errata-ai.git
book.io/vale/getting-started/styles
extends
:
existence
extends
:
existence
message
:
'
Link
"%s"
must
be
relative.'
message
:
'
Link
"%s"
must
be
relative.'
link
:
https://docs.gitlab.com/ee/development/documentation/styleguide.html#links-to-internal-documentation
link
:
https://docs.gitlab.com/ee/development/documentation/styleguide.html#links-to-internal-documentation
...
...
doc/.vale/gitlab/Repetition.yml
View file @
45d583f4
...
@@ -3,7 +3,7 @@
...
@@ -3,7 +3,7 @@
#
#
# Checks for duplicate words, like `the the` or `and and`.
# Checks for duplicate words, like `the the` or `and and`.
#
#
# For a list of all options, see https://errata-ai.git
hub.io/vale/styles/
# For a list of all options, see https://errata-ai.git
book.io/vale/getting-started/styles
extends
:
repetition
extends
:
repetition
message
:
'
"%s"
is
repeated.'
message
:
'
"%s"
is
repeated.'
level
:
error
level
:
error
...
...
doc/.vale/gitlab/SentenceLength.yml
View file @
45d583f4
...
@@ -3,7 +3,7 @@
...
@@ -3,7 +3,7 @@
#
#
# Counts words in a sentence and alerts if a sentence exceeds 25 words.
# Counts words in a sentence and alerts if a sentence exceeds 25 words.
#
#
# For a list of all options, see https://errata-ai.git
hub.io/vale/styles/
# For a list of all options, see https://errata-ai.git
book.io/vale/getting-started/styles
extends
:
occurrence
extends
:
occurrence
message
:
'
Shorter
sentences
improve
readability
(max
25
words).'
message
:
'
Shorter
sentences
improve
readability
(max
25
words).'
scope
:
sentence
scope
:
sentence
...
...
doc/.vale/gitlab/SentenceSpacing.yml
View file @
45d583f4
...
@@ -6,7 +6,7 @@
...
@@ -6,7 +6,7 @@
# - No spaces.
# - No spaces.
# - More than one space.
# - More than one space.
#
#
# For a list of all options, see https://errata-ai.git
hub.io/vale/styles/
# For a list of all options, see https://errata-ai.git
book.io/vale/getting-started/styles
extends
:
existence
extends
:
existence
message
:
'
"%s"
must
contain
one
and
only
one
space.'
message
:
'
"%s"
must
contain
one
and
only
one
space.'
link
:
https://docs.gitlab.com/ee/development/documentation/styleguide.html#punctuation
link
:
https://docs.gitlab.com/ee/development/documentation/styleguide.html#punctuation
...
...
doc/.vale/gitlab/Spelling.yml
View file @
45d583f4
...
@@ -9,7 +9,7 @@
...
@@ -9,7 +9,7 @@
# Commands, like `git clone` must use backticks, and must not be added to the
# Commands, like `git clone` must use backticks, and must not be added to the
# exceptions.
# exceptions.
#
#
# For a list of all options, see https://errata-ai.git
hub.io/vale/styles/
# For a list of all options, see https://errata-ai.git
book.io/vale/getting-started/styles
extends
:
spelling
extends
:
spelling
message
:
'
Spelling
check:
"%s"?'
message
:
'
Spelling
check:
"%s"?'
level
:
warning
level
:
warning
...
...
doc/.vale/gitlab/SubstitutionWarning.yml
View file @
45d583f4
...
@@ -4,7 +4,7 @@
...
@@ -4,7 +4,7 @@
# Warns against using common shorthand for terms.
# Warns against using common shorthand for terms.
# For substitutions flagged as errors, see Substitutions.yml
# For substitutions flagged as errors, see Substitutions.yml
#
#
# For a list of all options, see https://errata-ai.git
hub.io/vale/styles/
# For a list of all options, see https://errata-ai.git
book.io/vale/getting-started/styles
extends
:
substitution
extends
:
substitution
message
:
'
If
possible,
use
"%s"
instead
of
"%s".'
message
:
'
If
possible,
use
"%s"
instead
of
"%s".'
link
:
https://about.gitlab.com/handbook/communication/#top-misused-terms
link
:
https://about.gitlab.com/handbook/communication/#top-misused-terms
...
...
doc/.vale/gitlab/Substitutions.yml
View file @
45d583f4
...
@@ -4,7 +4,7 @@
...
@@ -4,7 +4,7 @@
# Checks for use of some of the top misused terms at GitLab.
# Checks for use of some of the top misused terms at GitLab.
# For substitutions only flagged as warnings, see SubstitutionWarning.yml
# For substitutions only flagged as warnings, see SubstitutionWarning.yml
#
#
# For a list of all options, see https://errata-ai.git
hub.io/vale/styles/
# For a list of all options, see https://errata-ai.git
book.io/vale/getting-started/styles
extends
:
substitution
extends
:
substitution
message
:
'
Use
"%s"
instead
of
"%s".'
message
:
'
Use
"%s"
instead
of
"%s".'
link
:
https://about.gitlab.com/handbook/communication/#top-misused-terms
link
:
https://about.gitlab.com/handbook/communication/#top-misused-terms
...
...
doc/.vale/gitlab/VersionText.yml
View file @
45d583f4
...
@@ -13,7 +13,7 @@
...
@@ -13,7 +13,7 @@
# immediately on the next line is ok. However, this will often highlight where multi-line version
# immediately on the next line is ok. However, this will often highlight where multi-line version
# text is attempted without `-` characters.
# text is attempted without `-` characters.
#
#
# For a list of all options, see https://errata-ai.git
hub.io/vale/styles/
# For a list of all options, see https://errata-ai.git
book.io/vale/getting-started/styles
extends
:
existence
extends
:
existence
message
:
'
"%s"
is
not
formatted
correctly.'
message
:
'
"%s"
is
not
formatted
correctly.'
link
:
https://docs.gitlab.com/ee/development/documentation/styleguide.html#text-for-documentation-requiring-version-text
link
:
https://docs.gitlab.com/ee/development/documentation/styleguide.html#text-for-documentation-requiring-version-text
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment