Commit cc79ca28 authored by Amy Qualls's avatar Amy Qualls

Merge branch 'eread/link-docs-to-vale-rule-searches' into 'master'

Link to Vale rule searches

See merge request gitlab-org/gitlab!50238
parents 9d5c1834 51941e93
---
# Warning: gitlab.CurlStringsQuoted
# Error: gitlab.CurlStringsQuoted
#
# Ensures all code blocks using curl quote any URL strings.
#
......
......@@ -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
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment