Merge branch 'aqualls-inline-vale-issues' into 'master'

Discontinue inline Vale rules thanks to /help

See merge request gitlab-org/gitlab!68315

doc/administration/raketasks/doctor.md

@@ -70,6 +70,7 @@ bundle exec rake gitlab:doctor:secrets RAILS_ENV=production VERBOSE=1
 **Example verbose output**
 
 <!-- vale gitlab.SentenceSpacing = NO -->
+
 ```plaintext
 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
@@ -83,4 +84,5 @@ 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.575711 #27148]  INFO -- : Done!
 ```
+
 <!-- vale gitlab.SentenceSpacing = YES -->

doc/api/project_badges.md

@@ -21,6 +21,7 @@ Badges support placeholders that are replaced in real time in both the link and
 - **%{commit_sha}**: Replaced by the last project's commit SHA.
 
 <!-- vale gitlab.Spelling = YES -->
+
 ## List all badges of a project
 
 Gets a list of a project's badges and its group badges.

doc/api/settings.md

@@ -330,7 +330,7 @@ listed in the descriptions of the relevant settings.
 | `html_emails_enabled`                    | boolean          | no                                   | Enable HTML emails. |
 | `import_sources`                         | array of strings | no                                   | Sources to allow project import from, possible values: `github`, `bitbucket`, `bitbucket_server`, `gitlab`, `fogbugz`, `git`, `gitlab_project`, `gitea`, `manifest`, and `phabricator`. |
 | `in_product_marketing_emails_enabled`    | boolean          | no                                   | Enable [in-product marketing emails](../user/profile/notifications.md#global-notification-settings). Enabled by default. |
-| `invisible_captcha_enabled`              | boolean          | no                                   | <!-- vale gitlab.Spelling = NO --> Enable Invisible Captcha <!-- vale gitlab.Spelling = YES --> spam detection during sign-up. Disabled by default. |
+| `invisible_captcha_enabled`              | boolean          | no                                   | Enable Invisible CAPTCHA spam detection during sign-up. Disabled by default. |
 | `issues_create_limit`                    | integer          | no                                   | Max number of issue creation requests per minute per user. Disabled by default.|
 | `keep_latest_artifact`                   | boolean          | no                                   | Prevent the deletion of the artifacts from the most recent successful jobs, regardless of the expiry time. Enabled by default. |
 | `local_markdown_version`                 | integer          | no                                   | Increase this value when any cached Markdown should be invalidated. |

doc/ci/pipelines/parent_child_pipelines.md

@@ -157,9 +157,13 @@ build a matrix of targets and architectures.
 For an overview, see [Create child pipelines using dynamically generated configurations](https://youtu.be/nMdfus2JWHM).
 
 <!-- vale gitlab.Spelling = NO -->
+
 We also have an example project using
 [Dynamic Child Pipelines with Jsonnet](https://gitlab.com/gitlab-org/project-templates/jsonnet)
-which shows how to use a data templating language to generate your `.gitlab-ci.yml` at runtime. You could use a similar process for other templating languages like [Dhall](https://dhall-lang.org/) or [`ytt`](https://get-ytt.io/).
+which shows how to use a data templating language to generate your `.gitlab-ci.yml` at runtime.
+You could use a similar process for other templating languages like
+[Dhall](https://dhall-lang.org/) or [`ytt`](https://get-ytt.io/).
+
 <!-- vale gitlab.Spelling = NO -->
 
 The artifact path is parsed by GitLab, not the runner, so the path must match the

doc/development/api_graphql_styleguide.md

@@ -11,9 +11,12 @@ This document outlines the style guide for the GitLab [GraphQL API](../api/graph
 ## How GitLab implements GraphQL
 
 <!-- vale gitlab.Spelling = NO -->
+
 We use the [GraphQL Ruby gem](https://graphql-ruby.org/) written by [Robert Mosolgo](https://github.com/rmosolgo/).
+In addition, we have a subscription to [GraphQL Pro](https://graphql.pro/). For
+details see [GraphQL Pro subscription](graphql_guide/graphql_pro.md).
+
 <!-- vale gitlab.Spelling = YES -->
-In addition, we have a subscription to [GraphQL Pro](https://graphql.pro/). For details see [GraphQL Pro subscription](graphql_guide/graphql_pro.md).
 
 All GraphQL queries are directed to a single endpoint
 ([`app/controllers/graphql_controller.rb#execute`](https://gitlab.com/gitlab-org/gitlab/-/blob/master/app%2Fcontrollers%2Fgraphql_controller.rb)),

doc/development/documentation/testing.md

@@ -306,11 +306,14 @@ To configure Vale in your editor, install one of the following as appropriate:
 
   In the extension's settings:
 
+  <!-- vale gitlab.Spelling = NO -->
+
   - Select the **Use CLI** checkbox.
-  - In the <!-- vale gitlab.Spelling = NO --> **Config** setting, enter an absolute
+  - In the  **Config** setting, enter an absolute
     path to [`.vale.ini`](https://gitlab.com/gitlab-org/gitlab/-/blob/master/.vale.ini)
     in one of the cloned GitLab repositories on your computer.
-    <!-- vale gitlab.Spelling = YES -->
+
+  <!-- vale gitlab.Spelling = YES -->
 
   - In the **Path** setting, enter the absolute path to the Vale binary. In most
     cases, `vale` should work. To find the location, run `which vale` in a terminal.

doc/development/fe_guide/index.md

@@ -12,9 +12,13 @@ across the GitLab frontend team.
 ## Overview
 
 GitLab is built on top of [Ruby on Rails](https://rubyonrails.org). It uses [Haml](https://haml.info/) and a JavaScript-based frontend with [Vue.js](https://vuejs.org).
+
 <!-- vale gitlab.Spelling = NO -->
+
 Be wary of [the limitations that come with using Hamlit](https://github.com/k0kubun/hamlit/blob/master/REFERENCE.md#limitations).
+
 <!-- vale gitlab.Spelling = YES -->
+
 We also use [SCSS](https://sass-lang.com) and plain JavaScript with
 modern ECMAScript standards supported through [Babel](https://babeljs.io/) and ES module support through [webpack](https://webpack.js.org/).
 

doc/development/fe_guide/performance.md

@@ -212,6 +212,8 @@ When writing code for real-time features we have to keep a couple of things in m
 Thus, we must strike a balance between sending requests and the feeling of real-time.
 Use the following rules when creating real-time solutions.
 
+<!-- vale gitlab.Spelling = NO -->
+
 1. The server tells you how much to poll by sending `Poll-Interval` in the header.
    Use that as your polling interval. This enables system administrators to change the
    [polling rate](../../administration/polling.md).
@@ -219,11 +221,13 @@ Use the following rules when creating real-time solutions.
 1. A response with HTTP status different from 2XX should disable polling as well.
 1. Use a common library for polling.
 1. Poll on active tabs only. Please use [Visibility](https://github.com/ai/visibilityjs).
-1. Use regular polling intervals, do not use <!-- vale gitlab.Spelling = NO --> backoff polling <!-- vale gitlab.Spelling = YES --> or jitter, as the interval is
+1. Use regular polling intervals, do not use backoff polling or jitter, as the interval is
    controlled by the server.
 1. The backend code is likely to be using ETags. You do not and should not check for status
    `304 Not Modified`. The browser transforms it for you.
 
+<!-- vale gitlab.Spelling = YES -->
+
 ### Lazy Loading Images
 
 To improve the time to first render we are using lazy loading for images. This works by setting

doc/development/fe_guide/style/scss.md

@@ -21,8 +21,11 @@ In order to reduce the generation of more CSS as our site grows, prefer the use
 #### Where are utility classes defined?
 
 Prefer the use of [utility classes defined in GitLab UI](https://gitlab.com/gitlab-org/gitlab-ui/-/blob/main/doc/css.md#utilities).
+
 <!-- vale gitlab.Spelling = NO -->
+
 An easy list of classes can also be [seen on Unpkg](https://unpkg.com/browse/@gitlab/ui/src/scss/utilities.scss).
+
 <!-- vale gitlab.Spelling = YES -->
 
 Classes in [`utilities.scss`](https://gitlab.com/gitlab-org/gitlab/-/blob/master/app/assets/stylesheets/utilities.scss) and [`common.scss`](https://gitlab.com/gitlab-org/gitlab/-/blob/master/app/assets/stylesheets/framework/common.scss) are being deprecated.

doc/development/gitaly.md

@@ -12,12 +12,16 @@ Workhorse and GitLab Shell.
 
 ## Deep Dive
 
-In May 2019, <!-- vale gitlab.Spelling = NO --> Bob Van Landuyt <!-- vale gitlab.Spelling = YES -->
+<!-- vale gitlab.Spelling = NO -->
+
+In May 2019, Bob Van Landuyt
 hosted a Deep Dive (GitLab team members only: `https://gitlab.com/gitlab-org/create-stage/issues/1`)
 on the [Gitaly project](https://gitlab.com/gitlab-org/gitaly). It included how to contribute to it as a
 Ruby developer, and shared domain-specific knowledge with anyone who may work in this part of the
 codebase in the future.
 
+<!-- vale gitlab.Spelling = YES -->
+
 You can find the <i class="fa fa-youtube-play youtube" aria-hidden="true"></i> [recording on YouTube](https://www.youtube.com/watch?v=BmlEWFS8ORo), and the slides
 on [Google Slides](https://docs.google.com/presentation/d/1VgRbiYih9ODhcPnL8dS0W98EwFYpJ7GXMPpX-1TM6YE/edit)
 and in [PDF](https://gitlab.com/gitlab-org/create-stage/uploads/a4fdb1026278bda5c1c5bb574379cf80/Create_Deep_Dive__Gitaly_for_Create_Ruby_Devs.pdf).

doc/development/i18n/proofreader.md

@@ -12,6 +12,7 @@ are very appreciative of the work done by translators and proofreaders!
 ## Proofreaders
 
 <!-- vale gitlab.Spelling = NO -->
+
 - Albanian
   - Proofreaders needed.
 - Amharic
@@ -123,6 +124,7 @@ are very appreciative of the work done by translators and proofreaders!
   - Andrew Vityuk - [GitLab](https://gitlab.com/3_1_3_u), [CrowdIn](https://crowdin.com/profile/andruwa13)
 - Welsh
   - Delyth Prys - [GitLab](https://gitlab.com/Delyth), [CrowdIn](https://crowdin.com/profile/DelythPrys)
+
 <!-- vale gitlab.Spelling = YES -->
 
 ## Become a proofreader

doc/development/i18n/translation.md

@@ -81,8 +81,10 @@ ethnicity. In languages that distinguish between a male and female form, use bot
 neutral formulation.
 
 <!-- vale gitlab.Spelling = NO -->
+
 For example, in German, the word _user_ can be translated into _Benutzer_ (male) or _Benutzerin_
 (female). Therefore, _create a new user_ translates to _Benutzer(in) anlegen_.
+
 <!-- vale gitlab.Spelling = YES -->
 
 ### Updating the glossary
@@ -93,7 +95,9 @@ To propose additions to the glossary, please
 ## French translation guidelines
 
 <!-- vale gitlab.Spelling = NO -->
+
 In French, the _écriture inclusive_ is now over (see on [Legifrance](https://www.legifrance.gouv.fr/jorf/id/JORFTEXT000036068906/)).
 To include both genders, write _Utilisateurs et utilisatrices_ instead of _Utilisateur·rice·s_. If
 there is not enough space, use the male gender alone.
+
 <!-- vale gitlab.Spelling = YES -->

doc/development/integrations/jira_connect.md

@@ -19,11 +19,13 @@ The following are required to install and test the app:
   - [GDK with Gitpod](https://gitlab.com/gitlab-org/gitlab-development-kit/-/blob/main/doc/howto/gitpod.md)
     documentation.
 
-  You **must not** use tunneling tools such as
-  <!-- vale gitlab.Spelling = NO --> Serveo <!-- vale gitlab.Spelling = YES -->
-  or `ngrok`. These are
+  <!-- vale gitlab.Spelling = NO -->
+
+  You **must not** use tunneling tools such as Serveo or `ngrok`. These are
   security risks, and must not be run on developer laptops.
 
+  <!-- vale gitlab.Spelling = YES -->
+
   Jira requires all connections to the app host to be over SSL. If you set up
   your own environment, remember to enable SSL and an appropriate certificate.
 

doc/development/pipelines.md

@@ -637,7 +637,9 @@ that is deployed in stage `review`.
 The default image is defined in [`.gitlab-ci.yml`](https://gitlab.com/gitlab-org/gitlab/-/blob/master/.gitlab-ci.yml).
 
 <!-- vale gitlab.Spelling = NO -->
+
 It includes Ruby, Go, Git, Git LFS, Chrome, Node, Yarn, PostgreSQL, and Graphics Magick.
+
 <!-- vale gitlab.Spelling = YES -->
 
 The images used in our pipelines are configured in the

doc/development/projections.md

@@ -36,7 +36,9 @@ You can find a basic list of projection options in
 ## History
 
 <!-- vale gitlab.Spelling = NO -->
+
 This started as a
 [plugin for vim by tpope](https://github.com/tpope/vim-projectionist)
 It has since become editor-agnostic and ported to most modern editors.
+
 <!-- vale gitlab.Spelling = YES -->
\ No newline at end of file

doc/development/testing_guide/best_practices.md

@@ -996,11 +996,13 @@ describe "#==" do
 end
 ```
 
+<!-- vale gitlab.Spelling = NO -->
+
 WARNING:
-Only use simple values as input in the `where` block. Using
-<!-- vale gitlab.Spelling = NO --> procs, stateful
+Only use simple values as input in the `where` block. Using procs, stateful
 objects, FactoryBot-created objects, and similar items can lead to
 [unexpected results](https://github.com/tomykaira/rspec-parameterized/issues/8).
+
 <!-- vale gitlab.Spelling = YES -->
 
 ### Prometheus tests

doc/topics/autodevops/stages.md

@@ -107,12 +107,14 @@ Check the [currently supported languages](#currently-supported-languages).
 Auto Test uses tests you already have in your application. If there are no
 tests, it's up to you to add them.
 
+<!-- vale gitlab.Spelling = NO -->
+
 NOTE:
 Not all buildpacks supported by [Auto Build](#auto-build) are supported by Auto Test.
 Auto Test uses [Herokuish](https://gitlab.com/gitlab-org/gitlab/-/issues/212689), *not*
 Cloud Native Buildpacks, and only buildpacks that implement the
-<!-- vale gitlab.Spelling = NO -->
 [Testpack API](https://devcenter.heroku.com/articles/testpack-api) are supported.
+
 <!-- vale gitlab.Spelling = YES -->
 
 ### Currently supported languages

doc/topics/git/git_rebase.md

@@ -177,7 +177,9 @@ For example, if you're using [Vim](https://www.vim.org/) as the text editor in
 a macOS's `ZSH` shell, and you want to `squash` or `fixup` all the three commits
 (join them into one):
 
-1. Press <!-- vale gitlab.FirstPerson = NO --> <kbd>i</kbd> <!-- vale gitlab.FirstPerson = YES -->
+<!-- vale gitlab.FirstPerson = NO -->
+
+1. Press <kbd>i</kbd>
    on your keyboard to switch to Vim's editing mode.
 1. Navigate with your keyboard arrows to edit the **second** commit keyword
    from `pick` to `squash` or `fixup` (or `s` or `f`). Do the same to the **third** commit.
@@ -194,6 +196,8 @@ a macOS's `ZSH` shell, and you want to `squash` or `fixup` all the three commits
    push your changes normally. If you had pushed these commits already,
    [force-push](#force-push) instead.
 
+<!-- vale gitlab.FirstPerson = YES -->
+
 Note that the steps for editing through the command line can be slightly
 different depending on your operating system and the shell you're using.
 

doc/topics/git/lfs/index.md

@@ -271,7 +271,11 @@ If you are storing LFS files outside of GitLab you can disable LFS on the projec
 
 It is possible to host LFS objects externally by setting a custom LFS URL with `git config -f .lfsconfig lfs.url https://example.com/<project>.git/info/lfs`.
 
-You might choose to do this if you are using an appliance like a <!-- vale gitlab.Spelling = NO --> Sonatype Nexus <!-- vale gitlab.Spelling = YES --> to store LFS data. If you choose to use an external LFS store,
+<!-- vale gitlab.Spelling = NO -->
+
+You might choose to do this if you are using an appliance like a Sonatype Nexus to store LFS data. If you choose to use an external LFS store,
 GitLab can't verify LFS objects. Pushes then fail if you have GitLab LFS support enabled.
 
+<!-- vale gitlab.Spelling = YES -->
+
 To stop push failure, LFS support can be disabled in the [Project settings](../../../user/project/settings/index.md), which also disables GitLab LFS value-adds (Verifying LFS objects, UI integration for LFS).

doc/user/project/highlighting.md

@@ -14,18 +14,23 @@ The [Web IDE](web_ide/index.md) and [Snippets](../snippets.md) use [Monaco Edito
 for text editing, which internally uses the [Monarch](https://microsoft.github.io/monaco-editor/monarch.html)
 library for syntax highlighting.
 
+<!-- vale gitlab.Spelling = NO -->
+
 If GitLab is guessing wrong, you can override its choice of language using the
-`gitlab-language` attribute in `.gitattributes`. For example, if you are working in a
-<!-- vale gitlab.Spelling = NO --> Prolog <!-- vale gitlab.Spelling = YES -->
+`gitlab-language` attribute in `.gitattributes`. For example, if you are working in a Prolog
 project and using the `.pl` file extension (which would normally be highlighted as Perl),
 you can add the following to your `.gitattributes` file:
 
+<!-- vale gitlab.Spelling = YES -->
+
 ``` conf
 *.pl gitlab-language=prolog
 ```
 
 <!-- vale gitlab.Spelling = NO -->
+
 When you check in and push that change, all `*.pl` files in your project are highlighted as Prolog.
+
 <!-- vale gitlab.Spelling = YES -->
 
 The paths here are Git's built-in [`.gitattributes` interface](https://git-scm.com/docs/gitattributes). So, if you were to invent a file format called a `Nicefile` at the root of your project that used Ruby syntax, all you need is:

doc/user/project/issues/csv_export.md

@@ -18,9 +18,12 @@ file, which stores tabular data in plain text.
 > _CSVs are a handy way of getting data from one program to another where one
 program cannot read the other ones normal output._ [Ref](https://www.quora.com/What-is-a-CSV-file-and-its-uses)
 
+<!-- vale gitlab.Spelling = NO -->
+
 CSV files can be used with any plotter or spreadsheet-based program, such as
-Microsoft Excel, Open Office <!-- vale gitlab.Spelling = NO --> Calc, <!-- vale gitlab.Spelling = NO -->,
-or Google Sheets.
+Microsoft Excel, Open Office Calc, or Google Sheets.
+
+<!-- vale gitlab.Spelling = YES -->
 
 Here are some of the uses of exporting issues as CSV files:
 

doc/user/project/pages/custom_domains_ssl_tls_certification/ssl_tls_concepts.md

@@ -32,8 +32,11 @@ nor credit card transactions, then why do we need secure connections?
 Back in the 1990s, where HTTPS came out, [SSL](https://en.wikipedia.org/wiki/Transport_Layer_Security#SSL_1.0.2C_2.0_and_3.0) was considered a "special"
 security measure, necessary just for big companies like banks and shopping sites
 with financial transactions.
+
 <!-- vale gitlab.Spelling = NO -->
+
 Now we have a different picture. [According to Josh Aas](https://letsencrypt.org/2015/10/29/phishing-and-malware.html), Executive Director at [ISRG](https://en.wikipedia.org/wiki/Internet_Security_Research_Group):
+
 <!-- vale gitlab.rulename = YES -->
 
 > _We've since come to realize that HTTPS is important for almost all websites. It's important for any website that allows people to log in with a password, any website that [tracks its users](https://www.washingtonpost.com/news/the-switch/wp/2013/12/10/nsa-uses-google-cookies-to-pinpoint-targets-for-hacking/) in any way, any website that [doesn't want its content altered](https://arstechnica.com/tech-policy/2014/09/why-comcasts-javascript-ad-injections-threaten-security-net-neutrality/), and for any site that offers content people might not want others to know they are consuming. We've also learned that any site not secured by HTTPS [can be used to attack other sites](https://krebsonsecurity.com/2015/04/dont-be-fodder-for-chinas-great-cannon/)._

doc/user/project/requirements/index.md

@@ -295,8 +295,10 @@ To export requirements:
 ### Exported CSV file format
 
 <!-- vale gitlab.Spelling = NO -->
+
 You can preview the exported CSV file in a spreadsheet editor, such as Microsoft Excel,
 OpenOffice Calc, or Google Sheets.
+
 <!-- vale gitlab.Spelling = YES -->
 
 The exported CSV file contains the following headers: