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
51941e93
Commit
51941e93
authored
Dec 17, 2020
by
Evan Read
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Link to Vale rule searches
parent
445de9c5
Changes
2
Show whitespace changes
Inline
Side-by-side
Showing
2 changed files
with
9 additions
and
5 deletions
+9
-5
doc/.vale/gitlab/CurlStringsQuoted.yml
doc/.vale/gitlab/CurlStringsQuoted.yml
+1
-1
doc/development/documentation/testing.md
doc/development/documentation/testing.md
+8
-4
No files found.
doc/.vale/gitlab/CurlStringsQuoted.yml
View file @
51941e93
---
#
Warning
: gitlab.CurlStringsQuoted
#
Error
: gitlab.CurlStringsQuoted
#
# Ensures all code blocks using curl quote any URL strings.
#
...
...
doc/development/documentation/testing.md
View file @
51941e93
...
...
@@ -183,7 +183,8 @@ Vale configuration is found in the following projects:
-
[
`charts`
](
https://gitlab.com/gitlab-org/charts/gitlab/-/tree/master/doc/.vale/gitlab
)
-
[
`gitlab-development-kit`
](
https://gitlab.com/gitlab-org/gitlab-development-kit/-/tree/master/doc/.vale/gitlab
)
This configuration is also used within build pipelines.
This configuration is also used within build pipelines, where
[
error-level rules
](
#vale-result-types
)
are enforced.
You can use Vale:
...
...
@@ -197,14 +198,17 @@ You can use Vale:
Vale returns three types of results:
`suggestion`
,
`warning`
, and
`error`
:
-
**Suggestion**
-level results are writing tips and aren't displayed in CI
job output. Suggestions don't break CI.
job output. Suggestions don't break CI. See a list of
[
suggestion-level rules
](
https://gitlab.com/search?utf8=✓&snippets=false&scope=&repository_ref=master&search=path%3Adoc%2F.vale%2Fgitlab+Suggestion%3A&group_id=9970&project_id=278964
)
.
-
**Warning**
-level results are
[
Style Guide
](
styleguide/index.md
)
violations, aren't displayed in CI
job output, and should contain clear explanations of how to resolve the warning.
Warnings may be technical debt, or can be future error-level test items
(after the Technical Writing team completes its cleanup). Warnings don't break CI.
(after the Technical Writing team completes its cleanup). Warnings don't break CI. See a list of
[
warning-level rules
](
https://gitlab.com/search?utf8=✓&snippets=false&scope=&repository_ref=master&search=path%3Adoc%2F.vale%2Fgitlab+Warning%3A&group_id=9970&project_id=278964
)
.
-
**Error**
-level results are Style Guide violations, and should contain clear explanations
about how to resolve the error. Errors break CI and are displayed in CI job output.
of how to resolve the error. Errors break CI and are displayed in CI job output.
of how to resolve the error. Errors break CI and are displayed in CI job output. See a list of
[
error-level rules
](
https://gitlab.com/search?utf8=✓&snippets=false&scope=&repository_ref=master&search=path%3Adoc%2F.vale%2Fgitlab+Error%3A&group_id=9970&project_id=278964
)
.
### Install linters
...
...
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