Commit 234df380 authored by Jonston Chan's avatar Jonston Chan Committed by Marcel Amirault

Change NonStandardQuotes Vale rule to error level

parent 7ad08894
...@@ -521,7 +521,7 @@ For instructions about how to set up Patroni on the primary site, see the ...@@ -521,7 +521,7 @@ For instructions about how to set up Patroni on the primary site, see the
#### Configuring Patroni cluster for a Geo secondary site #### Configuring Patroni cluster for a Geo secondary site
In a Geo secondary site, the main PostgreSQL database is a read-only replica of the primary sites PostgreSQL database. In a Geo secondary site, the main PostgreSQL database is a read-only replica of the primary site's PostgreSQL database.
If you are currently using `repmgr` on your Geo primary site, see [these instructions](#migrating-from-repmgr-to-patroni) If you are currently using `repmgr` on your Geo primary site, see [these instructions](#migrating-from-repmgr-to-patroni)
for migrating from `repmgr` to Patroni. for migrating from `repmgr` to Patroni.
...@@ -651,7 +651,7 @@ Refer to your preferred Load Balancer's documentation for further guidance. ...@@ -651,7 +651,7 @@ Refer to your preferred Load Balancer's documentation for further guidance.
##### Step 3. Configure a PgBouncer node on the secondary site ##### Step 3. Configure a PgBouncer node on the secondary site
A production-ready and highly available configuration requires at least A production-ready and highly available configuration requires at least
three Consul nodes, a minimum of one PgBouncer node, but its recommended to have three Consul nodes, a minimum of one PgBouncer node, but it's recommended to have
one per database node. An internal load balancer (TCP) is required when there is one per database node. An internal load balancer (TCP) is required when there is
more than one PgBouncer service nodes. The internal load balancer provides a single more than one PgBouncer service nodes. The internal load balancer provides a single
endpoint for connecting to the PgBouncer cluster. For more information, endpoint for connecting to the PgBouncer cluster. For more information,
......
...@@ -2390,7 +2390,7 @@ The following tables and diagram detail the hybrid environment using the same fo ...@@ -2390,7 +2390,7 @@ The following tables and diagram detail the hybrid environment using the same fo
as the normal environment above. as the normal environment above.
First are the components that run in Kubernetes. The recommendation at this time is to First are the components that run in Kubernetes. The recommendation at this time is to
use Google Clouds Kubernetes Engine (GKE) and associated machine types, but the memory use Google Cloud's Kubernetes Engine (GKE) and associated machine types, but the memory
and CPU requirements should translate to most other providers. We hope to update this in the and CPU requirements should translate to most other providers. We hope to update this in the
future with further specific cloud provider details. future with further specific cloud provider details.
......
...@@ -2402,7 +2402,7 @@ The following tables and diagram detail the hybrid environment using the same fo ...@@ -2402,7 +2402,7 @@ The following tables and diagram detail the hybrid environment using the same fo
as the normal environment above. as the normal environment above.
First are the components that run in Kubernetes. The recommendation at this time is to First are the components that run in Kubernetes. The recommendation at this time is to
use Google Clouds Kubernetes Engine (GKE) and associated machine types, but the memory use Google Cloud's Kubernetes Engine (GKE) and associated machine types, but the memory
and CPU requirements should translate to most other providers. We hope to update this in the and CPU requirements should translate to most other providers. We hope to update this in the
future with further specific cloud provider details. future with further specific cloud provider details.
......
...@@ -995,7 +995,7 @@ The following tables and diagram detail the hybrid environment using the same fo ...@@ -995,7 +995,7 @@ The following tables and diagram detail the hybrid environment using the same fo
as the normal environment above. as the normal environment above.
First are the components that run in Kubernetes. The recommendation at this time is to First are the components that run in Kubernetes. The recommendation at this time is to
use Google Clouds Kubernetes Engine (GKE) and associated machine types, but the memory use Google Cloud's Kubernetes Engine (GKE) and associated machine types, but the memory
and CPU requirements should translate to most other providers. We hope to update this in the and CPU requirements should translate to most other providers. We hope to update this in the
future with further specific cloud provider details. future with further specific cloud provider details.
......
...@@ -2124,7 +2124,7 @@ The following tables and diagram detail the hybrid environment using the same fo ...@@ -2124,7 +2124,7 @@ The following tables and diagram detail the hybrid environment using the same fo
as the normal environment above. as the normal environment above.
First are the components that run in Kubernetes. The recommendation at this time is to First are the components that run in Kubernetes. The recommendation at this time is to
use Google Clouds Kubernetes Engine (GKE) and associated machine types, but the memory use Google Cloud's Kubernetes Engine (GKE) and associated machine types, but the memory
and CPU requirements should translate to most other providers. We hope to update this in the and CPU requirements should translate to most other providers. We hope to update this in the
future with further specific cloud provider details. future with further specific cloud provider details.
......
...@@ -2413,7 +2413,7 @@ The following tables and diagram detail the hybrid environment using the same fo ...@@ -2413,7 +2413,7 @@ The following tables and diagram detail the hybrid environment using the same fo
as the normal environment above. as the normal environment above.
First are the components that run in Kubernetes. The recommendation at this time is to First are the components that run in Kubernetes. The recommendation at this time is to
use Google Clouds Kubernetes Engine (GKE) and associated machine types, but the memory use Google Cloud's Kubernetes Engine (GKE) and associated machine types, but the memory
and CPU requirements should translate to most other providers. We hope to update this in the and CPU requirements should translate to most other providers. We hope to update this in the
future with further specific cloud provider details. future with further specific cloud provider details.
......
...@@ -2094,7 +2094,7 @@ The following tables and diagram detail the hybrid environment using the same fo ...@@ -2094,7 +2094,7 @@ The following tables and diagram detail the hybrid environment using the same fo
as the normal environment above. as the normal environment above.
First are the components that run in Kubernetes. The recommendation at this time is to First are the components that run in Kubernetes. The recommendation at this time is to
use Google Clouds Kubernetes Engine (GKE) and associated machine types, but the memory use Google Cloud's Kubernetes Engine (GKE) and associated machine types, but the memory
and CPU requirements should translate to most other providers. We hope to update this in the and CPU requirements should translate to most other providers. We hope to update this in the
future with further specific cloud provider details. future with further specific cloud provider details.
......
...@@ -440,7 +440,7 @@ WARNING: ...@@ -440,7 +440,7 @@ WARNING:
subsequent revisions for anything that would be spotted after that. subsequent revisions for anything that would be spotted after that.
- For merge requests that have had [Squash and - For merge requests that have had [Squash and
merge](../user/project/merge_requests/squash_and_merge.md#squash-and-merge) set, merge](../user/project/merge_requests/squash_and_merge.md#squash-and-merge) set,
the squashed commits default commit message is taken from the merge request title. the squashed commit's default commit message is taken from the merge request title.
You're encouraged to [select a commit with a more informative commit message](../user/project/merge_requests/squash_and_merge.md) before merging. You're encouraged to [select a commit with a more informative commit message](../user/project/merge_requests/squash_and_merge.md) before merging.
Thanks to **Pipeline for Merged Results**, authors no longer have to rebase their Thanks to **Pipeline for Merged Results**, authors no longer have to rebase their
......
...@@ -128,7 +128,9 @@ test its execution using `CREATE INDEX CONCURRENTLY` in the `#database-lab` Slac ...@@ -128,7 +128,9 @@ test its execution using `CREATE INDEX CONCURRENTLY` in the `#database-lab` Slac
- Write the raw SQL in the MR description. Preferably formatted - Write the raw SQL in the MR description. Preferably formatted
nicely with [pgFormatter](https://sqlformat.darold.net) or nicely with [pgFormatter](https://sqlformat.darold.net) or
[paste.depesz.com](https://paste.depesz.com) and using regular quotes [paste.depesz.com](https://paste.depesz.com) and using regular quotes
<!-- vale off -->
(for example, `"projects"."id"`) and avoiding smart quotes (for example, `“projects”.“id”`). (for example, `"projects"."id"`) and avoiding smart quotes (for example, `“projects”.“id”`).
<!-- vale on -->
- In case of queries generated dynamically by using parameters, there should be one raw SQL query for each variation. - In case of queries generated dynamically by using parameters, there should be one raw SQL query for each variation.
For example, a finder for issues that may take as a parameter an optional filter on projects, For example, a finder for issues that may take as a parameter an optional filter on projects,
......
...@@ -474,6 +474,7 @@ Follow these guidelines for punctuation: ...@@ -474,6 +474,7 @@ Follow these guidelines for punctuation:
| Use serial commas (Oxford commas) before the final **and** or **or** in a list of three or more items. (Tested in [`OxfordComma.yml`](https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/.vale/gitlab/OxfordComma.yml).) | You can create new issues, merge requests, and milestones. | | Use serial commas (Oxford commas) before the final **and** or **or** in a list of three or more items. (Tested in [`OxfordComma.yml`](https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/.vale/gitlab/OxfordComma.yml).) | You can create new issues, merge requests, and milestones. |
| Always add a space before and after dashes when using it in a sentence (for replacing a comma, for example). | You should try this - or not. | | Always add a space before and after dashes when using it in a sentence (for replacing a comma, for example). | You should try this - or not. |
| When a colon is part of a sentence, always use lowercase after the colon. | Linked issues: a way to create a relationship between issues. | | When a colon is part of a sentence, always use lowercase after the colon. | Linked issues: a way to create a relationship between issues. |
| Do not use typographer's quotes. Use straight quotes instead. (Tested in [`NonStandardQuotes.yml`](https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/.vale/gitlab/NonStandardQuotes.yml).) | "It's the questions we can't answer that teach us the most"---Patrick Rothfuss |
<!-- vale gitlab.Repetition = YES --> <!-- vale gitlab.Repetition = YES -->
...@@ -765,6 +766,7 @@ Valid for Markdown content only, not for front matter entries: ...@@ -765,6 +766,7 @@ Valid for Markdown content only, not for front matter entries:
For other punctuation rules, refer to the For other punctuation rules, refer to the
[Pajamas Design System Punctuation section](https://design.gitlab.com/content/punctuation/). [Pajamas Design System Punctuation section](https://design.gitlab.com/content/punctuation/).
This is overridden by the [documentation-specific punctuation rules](#punctuation).
## Headings ## Headings
......
...@@ -19,7 +19,7 @@ The browser-based crawler works by loading the target application into a special ...@@ -19,7 +19,7 @@ The browser-based crawler works by loading the target application into a special
such as clicking on a link or filling in a form. For each action found, the crawler will execute it, take a new snapshot and determine what in the page changed from the previous snapshot. such as clicking on a link or filling in a form. For each action found, the crawler will execute it, take a new snapshot and determine what in the page changed from the previous snapshot.
Crawling continues by taking more snapshots and finding subsequent actions. Crawling continues by taking more snapshots and finding subsequent actions.
The benefit of crawling by following user actions in a browser is that the crawler can interact with the target application much like a real user would, identifying complex flows that traditional web crawlers dont understand. This results in better coverage of the website. The benefit of crawling by following user actions in a browser is that the crawler can interact with the target application much like a real user would, identifying complex flows that traditional web crawlers don't understand. This results in better coverage of the website.
Using the browser-based crawler should provide greater coverage for most web applications, compared with the current DAST AJAX crawler. The new crawler replaces the AJAX crawler and is specifically designed to maximize crawl coverage in modern web applications. While both crawlers are currently used in conjunction with the existing DAST scanner, the combination of the browser-based crawler with the current DAST scanner is much more effective at finding and testing every page in an application. Using the browser-based crawler should provide greater coverage for most web applications, compared with the current DAST AJAX crawler. The new crawler replaces the AJAX crawler and is specifically designed to maximize crawl coverage in modern web applications. While both crawlers are currently used in conjunction with the existing DAST scanner, the combination of the browser-based crawler with the current DAST scanner is much more effective at finding and testing every page in an application.
......
...@@ -49,7 +49,7 @@ can also be sorted by name or by the packager that installed them. ...@@ -49,7 +49,7 @@ can also be sorted by name or by the packager that installed them.
If a dependency has known vulnerabilities, view them by clicking the arrow next to the If a dependency has known vulnerabilities, view them by clicking the arrow next to the
dependency's name or the badge that indicates how many known vulnerabilities exist. For each dependency's name or the badge that indicates how many known vulnerabilities exist. For each
vulnerability, its severity and description appears below it. To view more details of a vulnerability, vulnerability, its severity and description appears below it. To view more details of a vulnerability,
select the vulnerabilitys description. The [vulnerability's details](../vulnerabilities) page is opened. select the vulnerability's description. The [vulnerability's details](../vulnerabilities) page is opened.
### Dependency paths ### Dependency paths
...@@ -78,8 +78,8 @@ You can download your project's full list of dependencies and their details in ...@@ -78,8 +78,8 @@ You can download your project's full list of dependencies and their details in
### In the UI ### In the UI
You can download your projects list of dependencies and their details in JSON format by selecting the **Export** button. Note that the dependency list only shows the results of the last successful pipeline to run on the default branch. You can download your project's list of dependencies and their details in JSON format by selecting the **Export** button. Note that the dependency list only shows the results of the last successful pipeline to run on the default branch.
### Using the API ### Using the API
You can download your projects list of dependencies [using the API](../../../api/dependencies.md#list-project-dependencies). Note this only provides the dependencies identified by the gemnasium family of analyzers and [not any other of the GitLab dependency analyzers](../dependency_scanning/analyzers.md). You can download your project's list of dependencies [using the API](../../../api/dependencies.md#list-project-dependencies). Note this only provides the dependencies identified by the gemnasium family of analyzers and [not any other of the GitLab dependency analyzers](../dependency_scanning/analyzers.md).
...@@ -271,7 +271,7 @@ under your project's settings: ...@@ -271,7 +271,7 @@ under your project's settings:
## DAST On-Demand Scans ## DAST On-Demand Scans
If you dont want scans running in your normal DevOps process you can use on-demand scans instead. For more details, see [on-demand scans](dast/index.md#on-demand-scans). This feature is only available for DAST. If you run an on-demand scan against the default branch, it is reported as a "successful pipeline" and these results are included in the security dashboard and vulnerability report. If you don't want scans running in your normal DevOps process you can use on-demand scans instead. For more details, see [on-demand scans](dast/index.md#on-demand-scans). This feature is only available for DAST. If you run an on-demand scan against the default branch, it is reported as a "successful pipeline" and these results are included in the security dashboard and vulnerability report.
## Security report validation ## Security report validation
......
...@@ -524,7 +524,7 @@ To avoid the time sync issue, enable time synchronization in the device that gen ...@@ -524,7 +524,7 @@ To avoid the time sync issue, enable time synchronization in the device that gen
1. Go to Settings. 1. Go to Settings.
1. Select General. 1. Select General.
1. Select Date & Time. 1. Select Date & Time.
1. Enable Set Automatically. If its already enabled, disable it, wait a few seconds, and re-enable. 1. Enable Set Automatically. If it's already enabled, disable it, wait a few seconds, and re-enable.
<!-- ## Troubleshooting <!-- ## Troubleshooting
......
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