diff --git a/doc/.vale/gitlab/Uppercase.yml b/doc/.vale/gitlab/Uppercase.yml index 642693e82301378d6af8fd02babeb2fd420f5d04..c2c565bacac8b2cba8f4906f15f11e31ec9e78a9 100644 --- a/doc/.vale/gitlab/Uppercase.yml +++ b/doc/.vale/gitlab/Uppercase.yml @@ -26,6 +26,7 @@ exceptions: - BSD - CAS - CDN + - CGI - CIDR - CLI - CNA @@ -35,6 +36,7 @@ exceptions: - CPU - CRIME - CRM + - CRUD - CSRF - CSS - CSV @@ -145,6 +147,7 @@ exceptions: - PNG - POSIX - POST + - PROXY - PUT - RAID - RAM @@ -169,6 +172,7 @@ exceptions: - SATA - SBOM - SCIM + - SCM - SCP - SCSS - SDK @@ -176,6 +180,7 @@ exceptions: - SEO - SFTP - SHA + - SKI - SLA - SLI - SLO diff --git a/doc/development/internal_api/index.md b/doc/development/internal_api/index.md index 4630cd079e5d2cc1bcf0012565f5d700466f980c..06252ed1f7916f93491b83d86c23e09962b59f62 100644 --- a/doc/development/internal_api/index.md +++ b/doc/development/internal_api/index.md @@ -816,7 +816,7 @@ Each array element contains: | Attribute | Type | Required | Description | |:-------------------|:-----------|:---------|:------------| | `namespace_id` | integer | yes | ID of the namespace to be reconciled | -| `next_reconciliation_date` | date | yes | Date when next reconciliation will happen | +| `next_reconciliation_date` | date | yes | Date of the next reconciliation | | `display_alert_from` | date | yes | Start date to display alert of upcoming reconciliation | Example request: diff --git a/doc/development/workhorse/configuration.md b/doc/development/workhorse/configuration.md index 2030ec15b96e7405b604aa38c2bf18979b8ac381..b86bb824ea1eb349a51aecee9ed649a1922d5a51 100644 --- a/doc/development/workhorse/configuration.md +++ b/doc/development/workhorse/configuration.md @@ -254,7 +254,7 @@ recommended that this option be used with an IP allow list to ensure arbitrary values cannot be generated by untrusted clients. An IP allow list is specified via the `trusted_cidrs_for_propagation` -opton in the Workhorse configuration file. Specify a list of CIDR blocks +option in the Workhorse configuration file. Specify a list of CIDR blocks that can be trusted. For example: ```toml diff --git a/doc/development/workhorse/gitlab_features.md b/doc/development/workhorse/gitlab_features.md index 2aa8d9d239935a0469efd31e18ee967a1a63c6ba..365cc7991d89556fb1c2c601ce6154b6107874fd 100644 --- a/doc/development/workhorse/gitlab_features.md +++ b/doc/development/workhorse/gitlab_features.md @@ -53,14 +53,14 @@ memory than it costs to have Workhorse look after it. for example, JavaScript files and CSS files are served straight from disk. - Workhorse can modify responses sent by Rails: for example if you use - `send_file` in Rails then GitLab Workhorse will open the file on + `send_file` in Rails then GitLab Workhorse opens the file on disk and send its contents as the response body to the client. - Workhorse can take over requests after asking permission from Rails. Example: handling `git clone`. - Workhorse can modify requests before passing them to Rails. Example: when handling a Git LFS upload Workhorse first asks permission from - Rails, then it stores the request body in a tempfile, then it sends - a modified request containing the tempfile path to Rails. + Rails, then it stores the request body in a temporary file, then it sends + a modified request containing the file path to Rails. - Workhorse can manage long-lived WebSocket connections for Rails. Example: handling the terminal websocket for environments. - Workhorse does not connect to PostgreSQL, only to Rails and (optionally) Redis. diff --git a/doc/user/admin_area/settings/index.md b/doc/user/admin_area/settings/index.md index 970897fd8da4cb7b11f411959329a2dbdec2e451..c877ca9837d8ccff77788442be978637b107a58c 100644 --- a/doc/user/admin_area/settings/index.md +++ b/doc/user/admin_area/settings/index.md @@ -160,7 +160,7 @@ The **Preferences** settings contain: The **Reporting** settings contain: - [Spam and Anti-bot Protection](../../../integration/recaptcha.md) - - Enable anti-spam services, like reCAPTCHA, Akismet or [Spamcheck](../reporting/spamcheck.md), and set IP limits. + Enable anti-spam services, like reCAPTCHA, Akismet, or [Spamcheck](../reporting/spamcheck.md), and set IP limits. - [Abuse reports](../review_abuse_reports.md) - Set notification email for abuse reports. ### Repository diff --git a/doc/user/admin_area/settings/visibility_and_access_controls.md b/doc/user/admin_area/settings/visibility_and_access_controls.md index 103eae07517ecb2d5aa02ab33e3bc81e4a6a6c03..55a399f0241bde69c7377494e787a55b41a98652 100644 --- a/doc/user/admin_area/settings/visibility_and_access_controls.md +++ b/doc/user/admin_area/settings/visibility_and_access_controls.md @@ -95,7 +95,7 @@ To set the default [visibility levels for new projects](../../public_access.md): 1. Expand the **Visibility and access controls** section. 1. Select the desired default project visibility: - **Private** - Project access must be granted explicitly to each user. If this - project is part of a group, access will be granted to members of the group. + project is part of a group, access is granted to members of the group. - **Internal** - The project can be accessed by any logged in user except external users. - **Public** - The project can be accessed without any authentication. 1. Select **Save changes**. diff --git a/doc/user/asciidoc.md b/doc/user/asciidoc.md index 41e4929576b6bf5e674cb565ffcbeef9851f4bd8..b55a55eebe57904cf6c4eeb1e7fb5dce88ff9954 100644 --- a/doc/user/asciidoc.md +++ b/doc/user/asciidoc.md @@ -399,10 +399,10 @@ Color written inside backticks is followed by a color "chip": - `HSLA(540,70%,50%,0.3)` ``` -### STEM +### Equations and Formulas (STEM) -To activate equation and formula support, -set the `stem` attribute in the document's header to `latexmath`. +If you need to include Science, Technology, Engineering and Math (STEM) +expressions, set the `stem` attribute in the document's header to `latexmath`. Equations and formulas are rendered using [KaTeX](https://katex.org/): ```plaintext diff --git a/doc/user/project/highlighting.md b/doc/user/project/highlighting.md index ef0c787b9d32d23116faed184ef20e7e77ba168e..37ec7c8e8d3d10999daf7d078fbe824f1a00fb28 100644 --- a/doc/user/project/highlighting.md +++ b/doc/user/project/highlighting.md @@ -42,7 +42,7 @@ To override syntax highlighting for a file type: After the changes merge into your [default branch](repository/branches/default.md), all `*.pl` files in your project are highlighted in your preferred language. -You can also extend the highlighting with common gateway interface (CGI) options, such as: +You can also extend the highlighting with Common Gateway Interface (CGI) options, such as: ``` conf # JSON file with .erb in it diff --git a/doc/user/project/repository/branches/default.md b/doc/user/project/repository/branches/default.md index f9fd1a48b9a8e57d3071d9650d8951f115dbefa0..e087ed6c4392558c7c3aaabd3d4e02edf95185ec 100644 --- a/doc/user/project/repository/branches/default.md +++ b/doc/user/project/repository/branches/default.md @@ -252,7 +252,7 @@ We are tracking this problem in [issue 20474](https://gitlab.com/gitlab-org/gitl This issue often occurs when a branch named `HEAD` is present in the repository. To fix the problem: -1. In your local repository, create a new, temporary branch and push it: +1. In your local repository, create a new temporary branch and push it: ```shell git checkout -b tmp_default && git push -u origin tmp_default diff --git a/doc/user/project/repository/branches/index.md b/doc/user/project/repository/branches/index.md index 14ad550fe794286c0f5b0ad5ebefc02db8901f37..6da2e5fc7ee9a6b10fcfeae738eec2dca894aff2 100644 --- a/doc/user/project/repository/branches/index.md +++ b/doc/user/project/repository/branches/index.md @@ -98,7 +98,7 @@ Sometimes when you have hundreds of branches you may want a more flexible matchi  -The Swap revisions feature allows you to swap the Source and Target revisions. When the Swap revisions button is clicked, the selected revisions for Source and Target will be swapped. +The Swap revisions feature allows you to swap the Source and Target revisions. When the Swap revisions button is clicked, the selected revisions for Source and Target is swapped.  diff --git a/doc/user/project/repository/csv.md b/doc/user/project/repository/csv.md index 4bf6c7451d5b2334f76d87cbdf85639238590c56..27424268d2b7b621ebb23c5606aca48ac10b0c63 100644 --- a/doc/user/project/repository/csv.md +++ b/doc/user/project/repository/csv.md @@ -13,7 +13,7 @@ A comma-separated values (CSV) file is a delimited text file that uses a comma t Each line of the file is a data record. Each record consists of one or more fields, separated by commas. The use of the comma as a field separator is the source of the name for this file format. A CSV file typically stores tabular data (numbers and text) in plain text, in which case each line -will have the same number of fields. +has the same number of fields. The CSV file format is not fully standardized. Other characters can be used as column delimiters. Fields may or may not be surrounded to escape special characters.