Commit afba310e authored by Evan Read's avatar Evan Read

Merge branch 'remove-vale-exceptions' into 'master'

Update vale docs and exceptions

See merge request gitlab-org/gitlab!40992
parents c160b8f6 91716835
...@@ -33,7 +33,6 @@ bundle exec rake gitlab:doctor:secrets RAILS_ENV=production ...@@ -33,7 +33,6 @@ bundle exec rake gitlab:doctor:secrets RAILS_ENV=production
**Example output** **Example output**
<!-- vale gitlab.SentenceSpacing = NO -->
```plaintext ```plaintext
I, [2020-06-11T17:17:54.951815 #27148] INFO -- : Checking encrypted values in the database I, [2020-06-11T17:17:54.951815 #27148] INFO -- : Checking encrypted values in the database
I, [2020-06-11T17:18:12.677708 #27148] INFO -- : - ApplicationSetting failures: 0 I, [2020-06-11T17:18:12.677708 #27148] INFO -- : - ApplicationSetting failures: 0
...@@ -45,7 +44,6 @@ I, [2020-06-11T17:18:15.575533 #27148] INFO -- : - ScimOauthAccessToken failure ...@@ -45,7 +44,6 @@ I, [2020-06-11T17:18:15.575533 #27148] INFO -- : - ScimOauthAccessToken failure
I, [2020-06-11T17:18:15.575678 #27148] INFO -- : Total: 1 row(s) affected I, [2020-06-11T17:18:15.575678 #27148] INFO -- : Total: 1 row(s) affected
I, [2020-06-11T17:18:15.575711 #27148] INFO -- : Done! I, [2020-06-11T17:18:15.575711 #27148] INFO -- : Done!
``` ```
<!-- vale gitlab.SentenceSpacing = YES -->
### Verbose mode ### Verbose mode
......
...@@ -72,7 +72,7 @@ Use these instructions for exploring the GitLab database while developing with t ...@@ -72,7 +72,7 @@ Use these instructions for exploring the GitLab database while developing with t
1. **Port number to connect to**: `5432` (default). 1. **Port number to connect to**: `5432` (default).
1. <!-- vale gitlab.Spelling = NO --> 1. <!-- vale gitlab.Spelling = NO -->
**Use an ssl connection?** **Use an ssl connection?**
<!-- vale gitlab.rulename = NO --> This depends on your installation. Options are: <!-- vale gitlab.Spelling = YES --> This depends on your installation. Options are:
- **Use Secure Connection** - **Use Secure Connection**
- **Standard Connection** (default) - **Standard Connection** (default)
1. **(Optional) The database to connect to**: `gitlabhq_development`. 1. **(Optional) The database to connect to**: `gitlabhq_development`.
......
...@@ -701,9 +701,9 @@ To configure markdownlint within your editor, install one of the following as ap ...@@ -701,9 +701,9 @@ To configure markdownlint within your editor, install one of the following as ap
To configure Vale within your editor, install one of the following as appropriate: To configure Vale within your editor, install one of the following as appropriate:
- The Sublime Text [`SublimeLinter-contrib-vale` plugin](https://packagecontrol.io/packages/SublimeLinter-contrib-vale) - The Sublime Text [`SublimeLinter-contrib-vale` plugin](https://packagecontrol.io/packages/SublimeLinter-contrib-vale).
- The Visual Studio Code [`testthedocs.vale` extension](https://marketplace.visualstudio.com/items?itemName=testthedocs.vale) - The Visual Studio Code [`errata-ai.vale-server` extension](https://marketplace.visualstudio.com/items?itemName=errata-ai.vale-server). You don't need Vale Server to use the plugin.
- [Vim](https://github.com/dense-analysis/ale) - [Vim](https://github.com/dense-analysis/ale).
We don't use [Vale Server](https://errata-ai.github.io/vale/#using-vale-with-a-text-editor-or-another-third-party-application). We don't use [Vale Server](https://errata-ai.github.io/vale/#using-vale-with-a-text-editor-or-another-third-party-application).
...@@ -736,9 +736,7 @@ document: ...@@ -736,9 +736,7 @@ document:
- To disable all Vale linting rules, add a `<!-- vale off -->` tag before the text, and a - To disable all Vale linting rules, add a `<!-- vale off -->` tag before the text, and a
`<!-- vale on -->` tag after the text. `<!-- vale on -->` tag after the text.
Whenever possible, exclude only the problematic rule and line(s). In some cases, such as list items, Whenever possible, exclude only the problematic rule and line(s).
you may need to disable linting for the entire list until
[Vale issue #175](https://github.com/errata-ai/vale/issues/175) is resolved.
For more information, see For more information, see
[Vale's documentation](https://errata-ai.gitbook.io/vale/getting-started/markup#markup-based-configuration). [Vale's documentation](https://errata-ai.gitbook.io/vale/getting-started/markup#markup-based-configuration).
......
...@@ -497,7 +497,7 @@ tenses, words, and phrases: ...@@ -497,7 +497,7 @@ tenses, words, and phrases:
- Instead of "e.g.," use "for example," "such as," "for instance," or "like." - Instead of "e.g.," use "for example," "such as," "for instance," or "like."
- Instead of "etc.," either use "and so on" or consider editing it out, since - Instead of "etc.," either use "and so on" or consider editing it out, since
it can be vague. it can be vague.
<!-- vale gitlab.rulename = NO --> <!-- vale gitlab.LatinTerms = YES -->
- Avoid using the word *currently* when talking about the product or its - Avoid using the word *currently* when talking about the product or its
features. The documentation describes the product as it is, and not as it features. The documentation describes the product as it is, and not as it
will be at some indeterminate point in the future. will be at some indeterminate point in the future.
...@@ -534,6 +534,9 @@ tenses, words, and phrases: ...@@ -534,6 +534,9 @@ tenses, words, and phrases:
[user interfaces](https://design.gitlab.com/content/punctuation/#contractions). [user interfaces](https://design.gitlab.com/content/punctuation/#contractions).
(Tested in [`Contractions.yml`](https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/.vale/gitlab/Contractions.yml).) (Tested in [`Contractions.yml`](https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/.vale/gitlab/Contractions.yml).)
<!-- vale gitlab.ContractionsKeep = NO -->
<!-- vale gitlab.ContractionsDiscard = NO -->
<!-- vale gitlab.FutureTense = NO -->
| Do | Don't | | Do | Don't |
|----------|-----------| |----------|-----------|
| it's | it is | | it's | it is |
...@@ -582,7 +585,9 @@ tenses, words, and phrases: ...@@ -582,7 +585,9 @@ tenses, words, and phrases:
| Requests to localhost are not allowed | Requests to localhost aren't allowed | | Requests to localhost are not allowed | Requests to localhost aren't allowed |
| Specified URL cannot be used | Specified URL can't be used | | Specified URL cannot be used | Specified URL can't be used |
<!-- vale on --> <!-- vale gitlab.ContractionsKeep = YES -->
<!-- vale gitlab.ContractionsDiscard = YES -->
<!-- vale gitlab.FutureTense = YES -->
## Text ## Text
......
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