diff --git a/doc/development/contributing/index.md b/doc/development/contributing/index.md index e7bd07b923cc0d3839661775b8381917da25ab0a..b929a5c0f04bb21e8c3b9858538f1032ce38ce8a 100644 --- a/doc/development/contributing/index.md +++ b/doc/development/contributing/index.md @@ -71,7 +71,7 @@ To write and test your code, you will use the GitLab Development Kit. Now [Open a merge request](../../user/project/merge_requests/creating_merge_requests.md) to merge your code and its documentation. The earlier you open a merge request, the sooner you can get feedback. You can [mark it as a draft](../../user/project/merge_requests/drafts.md) -to signal that you’re not done yet. +to signal that you're not done yet. 1. In the merge request, fill out all the information requested in the template, like why you are introducing these changes and a link to the issue this merge request is attempting to close/fix. diff --git a/doc/development/database_review.md b/doc/development/database_review.md index 7b121af13cca2c988834a35d418420f2ddc14222..42021a5ae95f4feac71d484dac06dea8aa048f2b 100644 --- a/doc/development/database_review.md +++ b/doc/development/database_review.md @@ -151,9 +151,7 @@ Include in the MR description: - Write the raw SQL in the MR description. Preferably formatted nicely with [pgFormatter](https://sqlformat.darold.net) or <https://paste.depesz.com> and using regular quotes -<!-- vale gitlab.NonStandardQuotes = NO --> - (for example, `"projects"."id"`) and avoiding smart quotes (for example, `“projectsâ€.“idâ€`). -<!-- vale gitlab.NonStandardQuotes = YES --> + (for example, `"projects"."id"`) and avoiding smart quotes (for example, `"projects"."id"`). - 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, diff --git a/doc/development/documentation/workflow.md b/doc/development/documentation/workflow.md index 1a4194aebd9f3e01f65818c7294b13846e7f0d37..eb1ea28d3b819ccb7a81a0f63b790984dca0080a 100644 --- a/doc/development/documentation/workflow.md +++ b/doc/development/documentation/workflow.md @@ -69,7 +69,7 @@ Remember: GitLab documentation is distributed under the [CC BY-SA 4.0 license](https://creativecommons.org/licenses/by-sa/4.0/), which presupposes that GitLab owns the documentation. -Under current law in the US and the EU, it’s possible that AI-generated works might either: +Under current law in the US and the EU, it's possible that AI-generated works might either: - not be owned by anyone because they weren't created by a human, or - belong to the AI training data's creator, if the AI verbatim reproduces content that it trained on diff --git a/doc/development/fe_guide/storybook.md b/doc/development/fe_guide/storybook.md index eaa8f8b40685c89ead52b541f921a54fbde13005..6049dd7c7d3fb2bcb21892693edc5729a120249b 100644 --- a/doc/development/fe_guide/storybook.md +++ b/doc/development/fe_guide/storybook.md @@ -55,7 +55,7 @@ To add a story: ## Using GitLab REST and GraphQL APIs -You can write stories for components that use either GitLab’s [REST](../../api/rest/index.md) or +You can write stories for components that use either the GitLab [REST](../../api/rest/index.md) or [GraphQL](../../api/graphql/index.md) APIs. ### Set up API access token and GitLab instance URL @@ -72,7 +72,7 @@ a starting point. 1. Set the `API_ACCESS_TOKEN` variable to the access token that you created. -1. Set the `GITLAB_URL` variable to the GitLab instance’s domain URL, for example: `http://gdk.test:3000`. +1. Set the `GITLAB_URL` variable to the GitLab instance's domain URL, for example: `http://gdk.test:3000`. 1. Start or restart your storybook. @@ -80,7 +80,7 @@ You can also use the GitLab API Access panel in the Storybook UI to set the GitL ### Set up API access in your stories -You should apply the `withGitLabAPIAccess` decorator to the stories that will consume GitLab’s APIs. This decorator +You should apply the `withGitLabAPIAccess` decorator to the stories that will consume GitLab APIs. This decorator will display a badge indicating that the story won't work without providing the API access parameters: ```javascript diff --git a/doc/development/internal_analytics/service_ping/metrics_dictionary.md b/doc/development/internal_analytics/service_ping/metrics_dictionary.md index d1f1c0b595aa323a2bd7c544b9d251f2c8c3f1e0..7b7468740dcd57ec6271959d8fb1d39446b7bcb9 100644 --- a/doc/development/internal_analytics/service_ping/metrics_dictionary.md +++ b/doc/development/internal_analytics/service_ping/metrics_dictionary.md @@ -135,7 +135,7 @@ For more information about the aggregation type of each feature, see the [`commo | data_source | time_frame | aggregation | Description | |------------------------|------------|----------------|-------------------------------------------------| -| any | `none` | not applicable | A type of data that’s not tracked over time, such as settings and configuration information | +| any | `none` | not applicable | A type of data that's not tracked over time, such as settings and configuration information | | `database` | `all` | not applicable | The whole time the metric has been active (all-time interval) | | `database` | `7d` | not applicable | 9 days ago to 2 days ago | | `database` | `28d` | not applicable | 30 days ago to 2 days ago | diff --git a/doc/development/pipelines/index.md b/doc/development/pipelines/index.md index 5a9f706219c108f2a148124c47021978a7c004c6..8c9b5039a588f9c889d383866ddbf19b28c2570c 100644 --- a/doc/development/pipelines/index.md +++ b/doc/development/pipelines/index.md @@ -214,7 +214,7 @@ graph LR ## Merge Trains -### Why do we need to have a “stable†master branch to enable merge trains? +### Why do we need to have a "stable" master branch to enable merge trains? If the master branch is unstable (i.e. CI/CD pipelines for the master branch are failing frequently), all of the merge requests pipelines that were added AFTER a faulty merge request pipeline would have to be **cancelled** and **added back to the train**, which would create a lot of delays if the merge train is long. diff --git a/doc/integration/kerberos.md b/doc/integration/kerberos.md index 8215842652f31cf3650d0f6a1dc3fcddfa096305..5271f60b5dd8474ef1a0feb4427a3138525f7b03 100644 --- a/doc/integration/kerberos.md +++ b/doc/integration/kerberos.md @@ -417,7 +417,7 @@ There are a number of potential causes and solutions for this error message. #### Kerberos integration not using a dedicated port -GitLab CI/CD doesn’t work with a Kerberos-enabled GitLab instance unless the Kerberos integration +GitLab CI/CD doesn't work with a Kerberos-enabled GitLab instance unless the Kerberos integration is configured to [use a dedicated port](kerberos.md#http-git-access-with-kerberos-token-passwordless-authentication). #### Lack of connectivity between client machine and Kerberos server diff --git a/doc/user/application_security/sast/index.md b/doc/user/application_security/sast/index.md index cb9359db33af417108a4005530369cbcb8e753e8..1d9e9842dab873740ce4fbdc7391fff5ab5c9610 100644 --- a/doc/user/application_security/sast/index.md +++ b/doc/user/application_security/sast/index.md @@ -602,7 +602,7 @@ flags are added to the scanner's CLI options. | Analyzer | CLI option | Description | |------------------------------------------------------------------------------|--------------------|------------------------------------------------------------------------------| | [Semgrep](https://gitlab.com/gitlab-org/security-products/analyzers/semgrep) | `--max-memory` | Sets the maximum system memory to use when running a rule on a single file. Measured in MB. | -| [Flawfinder](https://gitlab.com/gitlab-org/security-products/analyzers/flawfinder) | `--neverignore` | Never ignore security issues, even if they have an “ignore†directive in a comment. Adding this option is likely to result in the analyzer detecting additional vulnerability findings which cannot be automatically resolved. | +| [Flawfinder](https://gitlab.com/gitlab-org/security-products/analyzers/flawfinder) | `--neverignore` | Never ignore security issues, even if they have an "ignore" directive in a comment. Adding this option is likely to result in the analyzer detecting additional vulnerability findings which cannot be automatically resolved. | | [SpotBugs](https://gitlab.com/gitlab-org/security-products/analyzers/spotbugs) | `-effort` | Sets the analysis effort level. Valid values are `min`, `less`, `more` and `max`, defined in increasing order of scan's precision and ability to detect more vulnerabilities. Default value is set to `max` which may require more memory and time to complete the scan, depending on the project's size. In case you face memory or performance issues, you may reduce the analysis effort level to a lower value. For example: `-effort less`. | #### Custom CI/CD variables