diff options
author | GitLab Bot <gitlab-bot@gitlab.com> | 2020-01-27 06:08:57 +0000 |
---|---|---|
committer | GitLab Bot <gitlab-bot@gitlab.com> | 2020-01-27 06:08:57 +0000 |
commit | eace733dca6e5c87315b42f42eb4d8f05934d6de (patch) | |
tree | ba737686a8c8e5cc12a298db4303c60680e86e00 /doc/development/documentation/index.md | |
parent | c25c2a635b1944f5811d7a5eb9984ce5999e64f6 (diff) | |
download | gitlab-ce-eace733dca6e5c87315b42f42eb4d8f05934d6de.tar.gz |
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc/development/documentation/index.md')
-rw-r--r-- | doc/development/documentation/index.md | 18 |
1 files changed, 18 insertions, 0 deletions
diff --git a/doc/development/documentation/index.md b/doc/development/documentation/index.md index acba09986fb..34cf50f61d9 100644 --- a/doc/development/documentation/index.md +++ b/doc/development/documentation/index.md @@ -420,6 +420,7 @@ The following are some suggested linters you can install locally and sample conf - [`proselint`](#proselint) - [markdownlint](#markdownlint), which is the same as the test run in [`docs-lint`](#testing) +- [Vale](#vale), for English language grammar and syntax suggestions NOTE: **Note:** This list does not limit what other linters you can add to your local documentation writing toolchain. @@ -519,6 +520,23 @@ also check [the issue](https://gitlab.com/gitlab-org/gitlab-foss/issues/64352) t tracked the changes required to implement these rules, and details which rules were on or off when markdownlint was enabled on the docs. +#### `Vale` + +[Vale](https://errata-ai.github.io/vale/) is a grammar, style, and word usage linter +for the English language. Vale's configuration is stored in the +[`.vale.ini`](https://gitlab.com/gitlab-org/gitlab/blob/master/.vale.ini) file +located in the root directory of the [GitLab repository](https://gitlab.com/gitlab-org/gitlab). + +Vale supports creating [custom tests](https://errata-ai.github.io/vale/styles/), +stored in the `doc/.linting/vale/styles/gitlab` directory, that extend any of +several types of checks. + +To view linting suggestions locally, you must install Vale on your own machine, and +[configure the text editor of your choice](https://errata-ai.github.io/vale/#local-use-by-a-single-writer) +to display the results. + +Vale's test results are not currently displayed in CI, but may be displayed in the future. + ## Danger Bot GitLab uses [Danger](https://github.com/danger/danger) for some elements in |