Commit 48380e4b authored by Marcel Amirault's avatar Marcel Amirault

Merge branch 'docs-aqualls-spelling-more' into 'master'

Another round of spelling dispositions

See merge request gitlab-org/gitlab!54523
parents 1c2b87b0 71287d1b
...@@ -373,6 +373,7 @@ nullable ...@@ -373,6 +373,7 @@ nullable
Nurtch Nurtch
nyc nyc
OAuth OAuth
Octokit
offboarded offboarded
offboarding offboarding
offboards offboards
...@@ -421,6 +422,7 @@ prepend ...@@ -421,6 +422,7 @@ prepend
prepended prepended
prepending prepending
prepends prepends
prepopulated
Prettifier Prettifier
Pritaly Pritaly
Priyanka Priyanka
...@@ -523,6 +525,7 @@ scatterplot ...@@ -523,6 +525,7 @@ scatterplot
scatterplots scatterplots
Schemastore Schemastore
scrollable scrollable
Semgrep
Sendmail Sendmail
Sentry Sentry
serializer serializer
...@@ -665,6 +668,9 @@ unencoded ...@@ -665,6 +668,9 @@ unencoded
unencoder unencoder
unencodes unencodes
unencrypted unencrypted
unfollow
unfollowed
unfollows
Unicorn Unicorn
unindexed unindexed
unlink unlink
...@@ -703,6 +709,7 @@ unreplicated ...@@ -703,6 +709,7 @@ unreplicated
unresolve unresolve
unresolved unresolved
unresolving unresolving
unreviewed
unsanitized unsanitized
unschedule unschedule
unscoped unscoped
...@@ -772,3 +779,4 @@ Yubico ...@@ -772,3 +779,4 @@ Yubico
Zeitwerk Zeitwerk
Zendesk Zendesk
zsh zsh
Zstandard
...@@ -816,7 +816,7 @@ exceed 1, and the concurrency limiter has no effect. ...@@ -816,7 +816,7 @@ exceed 1, and the concurrency limiter has no effect.
## Background Repository Optimization ## Background Repository Optimization
Empty directories and unneeded config settings may accumulate in a repository and Empty directories and unneeded configuration settings may accumulate in a repository and
slow down Git operations. Gitaly can schedule a daily background task with a maximum duration slow down Git operations. Gitaly can schedule a daily background task with a maximum duration
to clean up these items and improve performance. to clean up these items and improve performance.
......
...@@ -720,7 +720,7 @@ preferred source is `gitlab`, which uses [API-based configuration](#gitlab-api-b ...@@ -720,7 +720,7 @@ preferred source is `gitlab`, which uses [API-based configuration](#gitlab-api-b
For more details see this [blog post](https://about.gitlab.com/blog/2020/08/03/how-gitlab-pages-uses-the-gitlab-api-to-serve-content/). For more details see this [blog post](https://about.gitlab.com/blog/2020/08/03/how-gitlab-pages-uses-the-gitlab-api-to-serve-content/).
### Deprecated domain_config_source ### Deprecated `domain_config_source`
WARNING: WARNING:
The flag `gitlab_pages['domain_config_source']` is deprecated for use in [GitLab 13.9](https://gitlab.com/gitlab-org/gitlab/-/issues/217913), The flag `gitlab_pages['domain_config_source']` is deprecated for use in [GitLab 13.9](https://gitlab.com/gitlab-org/gitlab/-/issues/217913),
......
...@@ -17,23 +17,23 @@ full list of reference architectures, see ...@@ -17,23 +17,23 @@ full list of reference architectures, see
| Service | Nodes | Configuration | GCP | AWS | Azure | | Service | Nodes | Configuration | GCP | AWS | Azure |
|--------------------------------------------|-------------|-------------------------|-----------------|-------------|----------| |--------------------------------------------|-------------|-------------------------|-----------------|-------------|----------|
| External load balancing node | 1 | 2 vCPU, 1.8 GB memory | n1-highcpu-2 | c5.large | F2s v2 | | External load balancing node | 1 | 2 vCPU, 1.8 GB memory | n1-highcpu-2 | `c5.large` | F2s v2 |
| Consul | 3 | 2 vCPU, 1.8 GB memory | n1-highcpu-2 | c5.large | F2s v2 | | Consul | 3 | 2 vCPU, 1.8 GB memory | n1-highcpu-2 | `c5.large` | F2s v2 |
| PostgreSQL | 3 | 8 vCPU, 30 GB memory | n1-standard-8 | m5.2xlarge | D8s v3 | | PostgreSQL | 3 | 8 vCPU, 30 GB memory | n1-standard-8 | `m5.2xlarge` | D8s v3 |
| PgBouncer | 3 | 2 vCPU, 1.8 GB memory | n1-highcpu-2 | c5.large | F2s v2 | | PgBouncer | 3 | 2 vCPU, 1.8 GB memory | n1-highcpu-2 | `c5.large` | F2s v2 |
| Internal load balancing node | 1 | 2 vCPU, 1.8 GB memory | n1-highcpu-2 | c5.large | F2s v2 | | Internal load balancing node | 1 | 2 vCPU, 1.8 GB memory | n1-highcpu-2 | `c5.large` | F2s v2 |
| Redis - Cache | 3 | 4 vCPU, 15 GB memory | n1-standard-4 | m5.xlarge | D4s v3 | | Redis - Cache | 3 | 4 vCPU, 15 GB memory | n1-standard-4 | `m5.xlarge` | D4s v3 |
| Redis - Queues / Shared State | 3 | 4 vCPU, 15 GB memory | n1-standard-4 | m5.xlarge | D4s v3 | | Redis - Queues / Shared State | 3 | 4 vCPU, 15 GB memory | n1-standard-4 | `m5.xlarge` | D4s v3 |
| Redis Sentinel - Cache | 3 | 1 vCPU, 1.7 GB memory | g1-small | t3.small | B1MS | | Redis Sentinel - Cache | 3 | 1 vCPU, 1.7 GB memory | g1-small | `t3.small` | B1MS |
| Redis Sentinel - Queues / Shared State | 3 | 1 vCPU, 1.7 GB memory | g1-small | t3.small | B1MS | | Redis Sentinel - Queues / Shared State | 3 | 1 vCPU, 1.7 GB memory | g1-small | `t3.small` | B1MS |
| Gitaly Cluster | 3 | 16 vCPU, 60 GB memory | n1-standard-16 | m5.4xlarge | D16s v3 | | Gitaly Cluster | 3 | 16 vCPU, 60 GB memory | n1-standard-16 | `m5.4xlarge` | D16s v3 |
| Praefect | 3 | 2 vCPU, 1.8 GB memory | n1-highcpu-2 | c5.large | F2s v2 | | Praefect | 3 | 2 vCPU, 1.8 GB memory | n1-highcpu-2 | `c5.large` | F2s v2 |
| Praefect PostgreSQL | 1+* | 2 vCPU, 1.8 GB memory | n1-highcpu-2 | c5.large | F2s v2 | | Praefect PostgreSQL | 1+* | 2 vCPU, 1.8 GB memory | n1-highcpu-2 | `c5.large` | F2s v2 |
| Sidekiq | 4 | 4 vCPU, 15 GB memory | n1-standard-4 | m5.xlarge | D4s v3 | | Sidekiq | 4 | 4 vCPU, 15 GB memory | n1-standard-4 | `m5.xlarge` | D4s v3 |
| GitLab Rails | 3 | 32 vCPU, 28.8 GB memory | n1-highcpu-32 | c5.9xlarge | F32s v2 | | GitLab Rails | 3 | 32 vCPU, 28.8 GB memory | n1-highcpu-32 | `c5.9xlarge` | F32s v2 |
| Monitoring node | 1 | 4 vCPU, 3.6 GB memory | n1-highcpu-4 | c5.xlarge | F4s v2 | | Monitoring node | 1 | 4 vCPU, 3.6 GB memory | n1-highcpu-4 | `c5.xlarge` | F4s v2 |
| Object storage | n/a | n/a | n/a | n/a | n/a | | Object storage | n/a | n/a | n/a | n/a | n/a |
| NFS server | 1 | 4 vCPU, 3.6 GB memory | n1-highcpu-4 | c5.xlarge | F4s v2 | | NFS server | 1 | 4 vCPU, 3.6 GB memory | n1-highcpu-4 | `c5.xlarge` | F4s v2 |
```plantuml ```plantuml
@startuml 10k @startuml 10k
...@@ -1508,7 +1508,7 @@ Praefect requires several secret tokens to secure communications across the Clus ...@@ -1508,7 +1508,7 @@ Praefect requires several secret tokens to secure communications across the Clus
Gitaly Cluster nodes are configured in Praefect via a `virtual storage`. Each storage contains Gitaly Cluster nodes are configured in Praefect via a `virtual storage`. Each storage contains
the details of each Gitaly node that makes up the cluster. Each storage is also given a name the details of each Gitaly node that makes up the cluster. Each storage is also given a name
and this name is used in several areas of the config. In this guide, the name of the storage will be and this name is used in several areas of the configuration. In this guide, the name of the storage will be
`default`. Also, this guide is geared towards new installs, if upgrading an existing environment `default`. Also, this guide is geared towards new installs, if upgrading an existing environment
to use Gitaly Cluster, you may need to use a different name. to use Gitaly Cluster, you may need to use a different name.
Refer to the [Praefect documentation](../gitaly/praefect.md#praefect) for more info. Refer to the [Praefect documentation](../gitaly/praefect.md#praefect) for more info.
...@@ -1756,7 +1756,7 @@ Note the following: ...@@ -1756,7 +1756,7 @@ Note the following:
necessary. necessary.
- The Internal Load Balancer will also access to the certificates and need to be configured - The Internal Load Balancer will also access to the certificates and need to be configured
to allow for TLS passthrough. to allow for TLS pass-through.
Refer to the load balancers documentation on how to configure this. Refer to the load balancers documentation on how to configure this.
To configure Praefect with TLS: To configure Praefect with TLS:
......
...@@ -27,7 +27,7 @@ and example server responses. Some parameters include a default or a list of all ...@@ -27,7 +27,7 @@ and example server responses. Some parameters include a default or a list of all
![API viewer screenshot](img/apiviewer04-fs8.png) ![API viewer screenshot](img/apiviewer04-fs8.png)
## Starting an interactive sesssion ## Starting an interactive session
A [Personal access token](../../user/profile/personal_access_tokens.md) (PAT) is one way to A [Personal access token](../../user/profile/personal_access_tokens.md) (PAT) is one way to
start an interactive session. To do this, select **Authorize** from the main page, and a start an interactive session. To do this, select **Authorize** from the main page, and a
......
...@@ -153,7 +153,7 @@ Job grouping is evaluated with an improved regular expression to group jobs by n ...@@ -153,7 +153,7 @@ Job grouping is evaluated with an improved regular expression to group jobs by n
The new implementation removes one or more `: [...]`, `X Y`, `X/Y`, or `X\Y` sequences The new implementation removes one or more `: [...]`, `X Y`, `X/Y`, or `X\Y` sequences
from the **end** of job names only. from the **end** of job names only.
Matching substrings occuring at the beginning or in the middle of build names are Matching substrings occurring at the beginning or in the middle of build names are
no longer removed. no longer removed.
## Specifying variables when running manual jobs ## Specifying variables when running manual jobs
......
...@@ -17,7 +17,7 @@ Note the following: ...@@ -17,7 +17,7 @@ Note the following:
- The dark mode palette is defined in `app/assets/stylesheets/themes/_dark.scss`. - The dark mode palette is defined in `app/assets/stylesheets/themes/_dark.scss`.
This is loaded _before_ application.scss to generate `application_dark.css` This is loaded _before_ application.scss to generate `application_dark.css`
- We define two types of variables in `_dark.scss`: - We define two types of variables in `_dark.scss`:
- SCSS variables are used in framework, components, and utitlity classes. - SCSS variables are used in framework, components, and utility classes.
- CSS variables are used for any colors within the `app/assets/stylesheets/page_bundles` directory. - CSS variables are used for any colors within the `app/assets/stylesheets/page_bundles` directory.
- `app/views/layouts/_head.html.haml` then loads application or application_dark based on the user's theme preference. - `app/views/layouts/_head.html.haml` then loads application or application_dark based on the user's theme preference.
...@@ -68,7 +68,7 @@ We [plan to add](https://gitlab.com/gitlab-org/gitlab/-/issues/301147) the CSS v ...@@ -68,7 +68,7 @@ We [plan to add](https://gitlab.com/gitlab-org/gitlab/-/issues/301147) the CSS v
## When to use SCSS variables ## When to use SCSS variables
There are a few things we do in SCSS that we cannot (easily) do with CSS, such as the following There are a few things we do in SCSS that we cannot (easily) do with CSS, such as the following
functions: functions:
- `lighten` - `lighten`
- `darken` - `darken`
......
...@@ -17,6 +17,6 @@ feedback, and suggestions. ...@@ -17,6 +17,6 @@ feedback, and suggestions.
- [GraphQL API documentation style guide](../documentation/graphql_styleguide.md): documentation - [GraphQL API documentation style guide](../documentation/graphql_styleguide.md): documentation
style guide for GraphQL. style guide for GraphQL.
- [GraphQL API](../../api/graphql/index.md): user documentation for the GitLab GraphQL API. - [GraphQL API](../../api/graphql/index.md): user documentation for the GitLab GraphQL API.
- [GraphQL BatchLoader](batchloader.md): development documentation on the batchloader. - [GraphQL BatchLoader](batchloader.md): development documentation on the BatchLoader.
- [GraphQL pagination](pagination.md): development documentation on pagination. - [GraphQL pagination](pagination.md): development documentation on pagination.
- [GraphQL Pro](graphql_pro.md): information on our GraphQL Pro subscription. - [GraphQL Pro](graphql_pro.md): information on our GraphQL Pro subscription.
...@@ -263,14 +263,14 @@ and what `bundle audit` writes to the standard output. ...@@ -263,14 +263,14 @@ and what `bundle audit` writes to the standard output.
If the command line fails, then it should be logged with the `error` log level; If the command line fails, then it should be logged with the `error` log level;
this makes it possible to debug the problem without having to change the log level to `debug` and rerun the scanning job. this makes it possible to debug the problem without having to change the log level to `debug` and rerun the scanning job.
#### common logutil package #### common `logutil` package
If you are using [go](https://golang.org/) and If you are using [go](https://golang.org/) and
[common](https://gitlab.com/gitlab-org/security-products/analyzers/common), [common](https://gitlab.com/gitlab-org/security-products/analyzers/common),
then it is suggested that you use [logrus](https://github.com/Sirupsen/logrus) then it is suggested that you use [Logrus](https://github.com/Sirupsen/logrus)
and [common's logutil package](https://gitlab.com/gitlab-org/security-products/analyzers/common/-/tree/master/logutil) and [common's `logutil` package](https://gitlab.com/gitlab-org/security-products/analyzers/common/-/tree/master/logutil)
to configure the formatter for [logrus](https://github.com/Sirupsen/logrus). to configure the formatter for [Logrus](https://github.com/Sirupsen/logrus).
See the [logutil README.md](https://gitlab.com/gitlab-org/security-products/analyzers/common/-/tree/master/logutil/README.md) See the [`logutil` README](https://gitlab.com/gitlab-org/security-products/analyzers/common/-/tree/master/logutil/README.md)
## Report ## Report
......
...@@ -591,7 +591,7 @@ repository's root as `.gitlab-api-fuzzing.yml`. ...@@ -591,7 +591,7 @@ repository's root as `.gitlab-api-fuzzing.yml`.
### Overrides ### Overrides
API Fuzzing provides a method to add or overide specific items in your request, for example: API Fuzzing provides a method to add or override specific items in your request, for example:
- Headers - Headers
- Cookies - Cookies
...@@ -615,19 +615,19 @@ Overrides use a JSON document, where each type of override is represented by a J ...@@ -615,19 +615,19 @@ Overrides use a JSON document, where each type of override is represented by a J
"cookie1": "value", "cookie1": "value",
"cookie2": "value" "cookie2": "value"
}, },
"query": { "query": {
"query-string1": "value", "query-string1": "value",
"query-string2": "value" "query-string2": "value"
}, },
"body-form": { "body-form": {
"form-param1": "value", "form-param1": "value",
"form-param1": "value", "form-param1": "value",
}, },
"body-json": { "body-json": {
"json-path1": "value", "json-path1": "value",
"json-path2": "value", "json-path2": "value",
}, },
"body-xml" : { "body-xml" : {
"xpath1": "value", "xpath1": "value",
"xpath2": "value", "xpath2": "value",
} }
...@@ -661,7 +661,7 @@ Example usage for setting a `body-form` override: ...@@ -661,7 +661,7 @@ Example usage for setting a `body-form` override:
```json ```json
{ {
"body-form": { "body-form": {
"username": "john.doe" "username": "john.doe"
} }
} }
...@@ -673,7 +673,7 @@ Example usage for setting a `body-json` override: ...@@ -673,7 +673,7 @@ Example usage for setting a `body-json` override:
```json ```json
{ {
"body-json": { "body-json": {
"$.credentials.access-token": "iddqd!42.$" "$.credentials.access-token": "iddqd!42.$"
} }
} }
...@@ -711,7 +711,7 @@ the second entry overrides an XML element: ...@@ -711,7 +711,7 @@ the second entry overrides an XML element:
```json ```json
{ {
"body-xml" : { "body-xml" : {
"/credentials/@isEnabled": "true", "/credentials/@isEnabled": "true",
"/credentials/access-token/text()" : "iddqd!42.$" "/credentials/access-token/text()" : "iddqd!42.$"
} }
......
...@@ -83,7 +83,7 @@ You can also [view our language roadmap](https://about.gitlab.com/direction/secu ...@@ -83,7 +83,7 @@ You can also [view our language roadmap](https://about.gitlab.com/direction/secu
| Objective-C (iOS) | [MobSF (beta)](https://github.com/MobSF/Mobile-Security-Framework-MobSF) | 13.5 | | Objective-C (iOS) | [MobSF (beta)](https://github.com/MobSF/Mobile-Security-Framework-MobSF) | 13.5 |
| PHP | [phpcs-security-audit](https://github.com/FloeDesignTechnologies/phpcs-security-audit) | 10.8 | | PHP | [phpcs-security-audit](https://github.com/FloeDesignTechnologies/phpcs-security-audit) | 10.8 |
| Python ([pip](https://pip.pypa.io/en/stable/)) | [bandit](https://github.com/PyCQA/bandit) | 10.3 | | Python ([pip](https://pip.pypa.io/en/stable/)) | [bandit](https://github.com/PyCQA/bandit) | 10.3 |
| Python | [semgrep](https://semgrep.dev) | 13.9 | | Python | [Semgrep](https://semgrep.dev) | 13.9 |
| React | [ESLint react plugin](https://github.com/yannickcr/eslint-plugin-react) | 12.5 | | React | [ESLint react plugin](https://github.com/yannickcr/eslint-plugin-react) | 12.5 |
| Ruby on Rails | [brakeman](https://brakemanscanner.org) | 10.3 | | Ruby on Rails | [brakeman](https://brakemanscanner.org) | 10.3 |
| Scala ([Ant](https://ant.apache.org/), [Gradle](https://gradle.org/), [Maven](https://maven.apache.org/), and [SBT](https://www.scala-sbt.org/)) | [SpotBugs](https://spotbugs.github.io/) with the [find-sec-bugs](https://find-sec-bugs.github.io/) plugin | 11.0 (SBT) & 11.9 (Ant, Gradle, Maven) | | Scala ([Ant](https://ant.apache.org/), [Gradle](https://gradle.org/), [Maven](https://maven.apache.org/), and [SBT](https://www.scala-sbt.org/)) | [SpotBugs](https://spotbugs.github.io/) with the [find-sec-bugs](https://find-sec-bugs.github.io/) plugin | 11.0 (SBT) & 11.9 (Ant, Gradle, Maven) |
......
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