diff --git a/doc/administration/auth/ldap/ldap-troubleshooting.md b/doc/administration/auth/ldap/ldap-troubleshooting.md index ce9a40147b3b92ef4a313c08e64fed2e8974e217..520fe220288e1e0a591b1b70e7703a484c46fc94 100644 --- a/doc/administration/auth/ldap/ldap-troubleshooting.md +++ b/doc/administration/auth/ldap/ldap-troubleshooting.md @@ -54,7 +54,7 @@ the following: main: # 'main' is the GitLab 'provider ID' of this LDAP server label: 'LDAP' host: 'ldap.example.com' - ... + # ... group_base: 'cn=my_group,ou=groups,dc=example,dc=com' admin_group: 'my_admin_group' ``` diff --git a/doc/administration/auth/oidc.md b/doc/administration/auth/oidc.md index 5cb81e000fe0b6cb6beccbbff11252c4dfb4648c..6e24292fbd2ec63d7635c2070081b2667b67fd56 100644 --- a/doc/administration/auth/oidc.md +++ b/doc/administration/auth/oidc.md @@ -833,7 +833,7 @@ Example configuration for self-compiled installations (file path: `config/gitlab label: 'Casdoor', # optional label for login button, defaults to "Openid Connect" args: { name: 'openid_connect', - scope: ['openid','profile','email'], + scope: ['openid', 'profile', 'email'], response_type: 'code', issuer: 'https://<CASDOOR_HOSTNAME>', discovery: true, @@ -919,7 +919,7 @@ For self-compiled installations: args: { name: 'openid_connect', strategy_class: "OmniAuth::Strategies::OpenIDConnect", - scope: ['openid','profile','email'], + scope: ['openid', 'profile', 'email'], response_type: 'code', issuer: '<your_oidc_url>', discovery: true, @@ -940,7 +940,7 @@ For self-compiled installations: args: { name: 'openid_connect_2fa', strategy_class: "OmniAuth::Strategies::OpenIDConnect", - scope: ['openid','profile','email'], + scope: ['openid', 'profile', 'email'], response_type: 'code', issuer: '<your_oidc_url>', discovery: true, diff --git a/doc/administration/packages/dependency_proxy.md b/doc/administration/packages/dependency_proxy.md index 7aa9b1ab7598f0147bdff4423d984d35c3016dc4..de6b07f1d7c7a8ac04a43943d36abbc5e6655a66 100644 --- a/doc/administration/packages/dependency_proxy.md +++ b/doc/administration/packages/dependency_proxy.md @@ -60,9 +60,9 @@ global: dependencyProxy: enabled: false bucket: gitlab-dependency-proxy - connection: {} - secret: - key: + connection: + secret: + key: ``` For more information, see [Configure Charts using Globals](https://docs.gitlab.com/charts/charts/globals.html#configure-appconfig-settings). diff --git a/doc/administration/raketasks/ldap.md b/doc/administration/raketasks/ldap.md index 00f5faee9d94e1d1b71a011e8f516c86db74a075..382eeb1e5ed085ddc367cded07941cd955223eca 100644 --- a/doc/administration/raketasks/ldap.md +++ b/doc/administration/raketasks/ldap.md @@ -90,7 +90,7 @@ main: host: '_your_ldap_server' port: 389 uid: 'sAMAccountName' - ... + # ... ``` `main` is the LDAP server ID. Together, the unique provider is `ldapmain`. diff --git a/doc/administration/sidekiq/sidekiq_troubleshooting.md b/doc/administration/sidekiq/sidekiq_troubleshooting.md index aad5747c149b941eb88f5a6af8907990df22da70..a1634ced70782da53d51b2ddd9d1d86a5f08f4c4 100644 --- a/doc/administration/sidekiq/sidekiq_troubleshooting.md +++ b/doc/administration/sidekiq/sidekiq_troubleshooting.md @@ -258,7 +258,7 @@ docker run --cap-add SYS_PTRACE [...] ```yaml services: ruby_container_name: - ... + # ... cap_add: - SYS_PTRACE ``` diff --git a/doc/ci/migration/bamboo.md b/doc/ci/migration/bamboo.md index 99e87a5603bec02b9f69523fac0efbde4a82fcad..926c1340cf4e0933cf7e4ef14a8140d8bee6563a 100644 --- a/doc/ci/migration/bamboo.md +++ b/doc/ci/migration/bamboo.md @@ -521,15 +521,15 @@ For example, in a Bamboo build plan: ```yaml version: 2 # ... +Build: + # ... artifacts: - - - name: Test Reports + - name: Test Reports location: target/reports pattern: '*.xml' required: false shared: false - - - name: Special Reports + - name: Special Reports location: target/reports pattern: 'special/*.xml' shared: true @@ -543,8 +543,7 @@ for example: ```yaml Test app: artifact-subscriptions: - - - artifact: Test Reports + - artifact: Test Reports destination: deploy ``` @@ -553,6 +552,8 @@ Test app: ```yaml version: 2 # ... +Build: + # ... tasks: - artifact-download: source-plan: PROJECTKEY-PLANKEY diff --git a/doc/ci/resource_groups/_index.md b/doc/ci/resource_groups/_index.md index 62e83d4bdaac61ca2b28709d5c7f579df45a783c..7560827b1efea3e200f81a2dcdc6cadb7bd68989 100644 --- a/doc/ci/resource_groups/_index.md +++ b/doc/ci/resource_groups/_index.md @@ -53,7 +53,7 @@ To ensure that a `deploy` job runs once at a time, you can specify ```yaml deploy: - ... + # ... resource_group: production ``` diff --git a/doc/ci/runners/configure_runners.md b/doc/ci/runners/configure_runners.md index 88bba4b7968e8e5a5bc750af351a239d13566251..45c21b11a0b140dfcf33f493d43bc32a25e7c2ee 100644 --- a/doc/ci/runners/configure_runners.md +++ b/doc/ci/runners/configure_runners.md @@ -1063,7 +1063,7 @@ The following fields are populated by default: An example of provenance metadata that the GitLab Runner might generate is as follows: -```yaml +```json { "_type": "https://in-toto.io/Statement/v0.1", "predicateType": "https://slsa.dev/provenance/v1", diff --git a/doc/ci/yaml/inputs.md b/doc/ci/yaml/inputs.md index 086cafab9c0cd807ba5e23f0a347e59211a82eae..49c109470d91afbbedaa1d62b0f65eff17b0e9e1 100644 --- a/doc/ci/yaml/inputs.md +++ b/doc/ci/yaml/inputs.md @@ -454,7 +454,7 @@ when you include the file. For example: include: - component: $CI_SERVER_FQDN/project/path/component@1.0.0 inputs: - test_job_needs: [ my-other-job ] + test_job_needs: [my-other-job] my-other-job: script: diff --git a/doc/development/cells/_index.md b/doc/development/cells/_index.md index 1294b0820c0e24cba1d788adef5409d137b09df1..a53be707678f6bedf1996e75ac29e81f57c8754b 100644 --- a/doc/development/cells/_index.md +++ b/doc/development/cells/_index.md @@ -182,7 +182,7 @@ table_name: security_findings classes: - Security::Finding -... +# ... desired_sharding_key: project_id: diff --git a/doc/development/cicd/pipeline_wizard.md b/doc/development/cicd/pipeline_wizard.md index 75ff2052bda220da5aaa8b98dd4d4bb3e7a8f4f7..bf50d8c1e297e93369598dafc9712f3f593a848f 100644 --- a/doc/development/cicd/pipeline_wizard.md +++ b/doc/development/cicd/pipeline_wizard.md @@ -70,7 +70,7 @@ steps: widget: text target: $BUILD_IMAGE required: true - pattern: "^(?:(?=[^:\/]{1,253})(?!-)[a-zA-Z0-9-]{1,63}(?<!-)(?:\.(?!-)[a-zA-Z0-9-]{1,63}(?<!-))*(?::[0-9]{1,5})?\/)?((?![._-])(?:[a-z0-9._-]*)(?<![._-])(?:\/(?![._-])[a-z0-9._-]*(?<![._-]))*)(?::(?![.-])[a-zA-Z0-9_.-]{1,128})?$" + pattern: '^(?:(?=[^:\/]{1,253})(?!-)[a-zA-Z0-9-]{1,63}(?<!-)(?:\.(?!-)[a-zA-Z0-9-]{1,63}(?<!-))*(?::[0-9]{1,5})?\/)?((?![._-])(?:[a-z0-9._-]*)(?<![._-])(?:\/(?![._-])[a-z0-9._-]*(?<![._-]))*)(?::(?![.-])[a-zA-Z0-9_.-]{1,128})?$' invalid-feedback: Please enter a valid docker image # Second input widget diff --git a/doc/development/fips_gitlab.md b/doc/development/fips_gitlab.md index d0577d93fe15f8e2fa358272ac498956994e3de2..491c15efca6dc8e0aea94362f76d5dcbf8f22f2d 100644 --- a/doc/development/fips_gitlab.md +++ b/doc/development/fips_gitlab.md @@ -268,7 +268,7 @@ Charts variables: ```yaml all: vars: - ... + # ... gitlab_charts_custom_config_file: '/path/to/gitlab-environment-toolkit/ansible/environments/gitlab-10k/inventory/charts.yml' ``` diff --git a/doc/development/geo.md b/doc/development/geo.md index 2b0535fc8a9b846147422203dab61d4bf201bc68..f9261eabc2b630f4bc41dbfbc2e9837ce8681417 100644 --- a/doc/development/geo.md +++ b/doc/development/geo.md @@ -349,8 +349,8 @@ file for the right database ID. For example, for an LFS object, the request must also include the SHA256 sum of the file. An example JWT payload looks like: -```yaml -{"data": {sha256: "31806bb23580caab78040f8c45d329f5016b0115"}, iat: "1234567890"} +```json +{"data": {"sha256": "31806bb23580caab78040f8c45d329f5016b0115"}, "iat": "1234567890"} ``` If the requested file matches the requested SHA256 sum, then the Geo @@ -366,8 +366,8 @@ the Git repository request. This ensures that the **secondary** site downloads the right Git repository for the right database ID. An example JWT payload looks like: -```yaml -{"data": {scope: "mygroup/myproject"}, iat: "1234567890"} +```json +{"data": {"scope": "mygroup/myproject"}, "iat": "1234567890"} ``` ## Git Push to Geo secondary diff --git a/doc/development/testing_guide/end_to_end/test_pipelines.md b/doc/development/testing_guide/end_to_end/test_pipelines.md index 7cc6178951d3b6c3984aeaf1d029cdfb97eca717..156505a683051529720feb401436918d14ce5ccb 100644 --- a/doc/development/testing_guide/end_to_end/test_pipelines.md +++ b/doc/development/testing_guide/end_to_end/test_pipelines.md @@ -163,7 +163,7 @@ A typical job definition in one of the e2e test pipeline definition YAML files w ```yaml my-new-test-job: - ... + # ... variables: QA_SCENARIO: Test::Integration::MyNewTestScenario ``` diff --git a/doc/integration/omniauth.md b/doc/integration/omniauth.md index 3b4a26ef47742a7a33284e1db059fececf406404..2f621e6646cd57dfab6c74e967b1a06399ac02d6 100644 --- a/doc/integration/omniauth.md +++ b/doc/integration/omniauth.md @@ -236,15 +236,15 @@ gitlab_rails['omniauth_providers'] = [ ```yaml - { name: 'PROVIDER_NAME', - ... + # ... args: { gitlab_username_claim: 'sub' } } - { name: 'github', - ... + # ... args: { gitlab_username_claim: 'name' } } - { name: 'kerberos', - ... + # ... args: { gitlab_username_claim: 'uid' } } ``` diff --git a/doc/solutions/components/secret_detection.md b/doc/solutions/components/secret_detection.md index 674fbe791ff044b5f64bcb9fccb39c3f044adb69..d1635e3912e4f4ffb76e6ee4defcf928751f6e41 100644 --- a/doc/solutions/components/secret_detection.md +++ b/doc/solutions/components/secret_detection.md @@ -50,7 +50,7 @@ The rules can be defined using `regex` The extended rules for PII data element detection -```yaml +```toml [[rules]] id = "ssn" description = "Social Security Number" @@ -63,7 +63,7 @@ keywords = ["ssn"] The extended rules for password in plain text -```yaml +```toml [[rules]] id = "password-secret" description = "Detect secrets starting with Password or PASSWORD" diff --git a/doc/topics/runner_fleet_design_guides/gitlab_runner_fleet_config_and_best_practices.md b/doc/topics/runner_fleet_design_guides/gitlab_runner_fleet_config_and_best_practices.md index b58c2bc16d8100af3f8bd876968ff4e60ec6fe92..11672868f891106a20647fb58c6857a897404adb 100644 --- a/doc/topics/runner_fleet_design_guides/gitlab_runner_fleet_config_and_best_practices.md +++ b/doc/topics/runner_fleet_design_guides/gitlab_runner_fleet_config_and_best_practices.md @@ -485,7 +485,7 @@ tests: script: - command_1 - command_2 -... + # ... - command_n tags: - my-custom-tag @@ -505,7 +505,7 @@ tests: script: - cpu_intensive_command_1 - cpu_intensive_command_2 -... + # ... - cpu_intensive_command_n tags: - my-custom-tag diff --git a/doc/user/analytics/analytics_dashboards.md b/doc/user/analytics/analytics_dashboards.md index 52c62a4f9283a85bcf378c705008bb42467a93e5..4b87050277b06661d50229155b7f7a13596eaad4 100644 --- a/doc/user/analytics/analytics_dashboards.md +++ b/doc/user/analytics/analytics_dashboards.md @@ -351,7 +351,7 @@ To enable filters, in the `.yaml` configuration file set the filter's `enabled` ```yaml title: My dashboard -... +# ... filters: excludeAnonymousUsers: enabled: true diff --git a/doc/user/application_security/api_fuzzing/performance.md b/doc/user/application_security/api_fuzzing/performance.md index 8c1ff7d848e2d7f6d9bcd18e34a97c307f873ab5..52acbd2846114f8e127d97ac941f93667084223d 100644 --- a/doc/user/application_security/api_fuzzing/performance.md +++ b/doc/user/application_security/api_fuzzing/performance.md @@ -122,15 +122,14 @@ The rules we are using in the `apifuzzer_v1` and `apifuzzer_v2` jobs are copied # Disable the main apifuzzer_fuzz job apifuzzer_fuzz: rules: - - if: $CI_COMMIT_BRANCH - when: never + - if: $CI_COMMIT_BRANCH + when: never apifuzzer_v1: extends: apifuzzer_fuzz variables: FUZZAPI_EXCLUDE_PATHS: /api/v1/** rules: - rules: - if: $API_FUZZING_DISABLED == 'true' || $API_FUZZING_DISABLED == '1' when: never - if: $API_FUZZING_DISABLED_FOR_DEFAULT_BRANCH == 'true' && @@ -149,7 +148,6 @@ apifuzzer_v2: variables: FUZZAPI_EXCLUDE_PATHS: /api/v2/** rules: - rules: - if: $API_FUZZING_DISABLED == 'true' || $API_FUZZING_DISABLED == '1' when: never - if: $API_FUZZING_DISABLED_FOR_DEFAULT_BRANCH && @@ -185,8 +183,8 @@ To verify the operation is excluded, run the API Fuzzing job and review the job # different names apifuzzer_fuzz: rules: - - if: $CI_COMMIT_BRANCH - when: never + - if: $CI_COMMIT_BRANCH + when: never # API Fuzzing for feature branch work, excludes /api/large_response_json apifuzzer_branch: @@ -194,7 +192,6 @@ apifuzzer_branch: variables: FUZZAPI_EXCLUDE_PATHS: /api/large_response_json rules: - rules: - if: $API_FUZZING_DISABLED == 'true' || $API_FUZZING_DISABLED == '1' when: never - if: $API_FUZZING_DISABLED_FOR_DEFAULT_BRANCH && @@ -212,7 +209,7 @@ apifuzzer_branch: # Includes the long running operations apifuzzer_main: extends: apifuzzer_fuzz - rules: + rules: - if: $API_FUZZING_DISABLED == 'true' || $API_FUZZING_DISABLED == '1' when: never - if: $API_FUZZING_DISABLED_FOR_DEFAULT_BRANCH && diff --git a/doc/user/application_security/dast/browser/configuration/authentication.md b/doc/user/application_security/dast/browser/configuration/authentication.md index aeb9e769d7a4b20bf6a2ef003c194f4206edbabe..34b95dc3b3cb703b77dc42654590029a0683e097 100644 --- a/doc/user/application_security/dast/browser/configuration/authentication.md +++ b/doc/user/application_security/dast/browser/configuration/authentication.md @@ -256,7 +256,7 @@ dast: DAST_TARGET_URL: https://target.example.com DAST_AUTH_URL: https://target.example.com DAST_AUTH_TYPE: basic-digest - DAST_AUTH_NEGOTIATE_DELEGATION: *.example.com,example.com,*.EXAMPLE.COM,EXAMPLE.COM + DAST_AUTH_NEGOTIATE_DELEGATION: '*.example.com,example.com,*.EXAMPLE.COM,EXAMPLE.COM' # Not shown -- DAST_AUTH_USERNAME, DAST_AUTH_PASSWORD set via Settings -> CI -> Variables before_script: - KRB5_CONF=' diff --git a/doc/user/application_security/policies/pipeline_execution_policies.md b/doc/user/application_security/policies/pipeline_execution_policies.md index 9d11c888ac5447f0afa69f99dc6c48ea9c41078b..4cc2eae6d354e3753ef5a8b2d73f68b0b995e4d8 100644 --- a/doc/user/application_security/policies/pipeline_execution_policies.md +++ b/doc/user/application_security/policies/pipeline_execution_policies.md @@ -148,15 +148,15 @@ to be compatible with each other: Valid configuration example: ```yaml - - `override-policy-1` stages: `[build, test, policy-test, deploy]` - - `override-policy-2` stages: `[test, deploy]` + - override-policy-1 stages: [build, test, policy-test, deploy] + - override-policy-2 stages: [test, deploy] ``` Invalid configuration example: ```yaml - - `override-policy-1` stages: `[build, test, policy-test, deploy]` - - `override-policy-2` stages: `[deploy, test]` + - override-policy-1 stages: [build, test, policy-test, deploy] + - override-policy-2 stages: [deploy, test] ``` The pipeline fails if one or more `override_project_ci` policies has an invalid `stages` configuration. diff --git a/doc/user/clusters/agent/troubleshooting.md b/doc/user/clusters/agent/troubleshooting.md index c871d0067a68ae0db10f75a1244c0c9950972ec9..659b378c664ec4bea61d5287a0bbd3860f19f82d 100644 --- a/doc/user/clusters/agent/troubleshooting.md +++ b/doc/user/clusters/agent/troubleshooting.md @@ -93,8 +93,9 @@ Add `--set-file config.kasCaCert=my-custom-ca.pem` to the `helm install` command When you deploy `agentk` with a set `config.kasCaCert` value, the certificate is added to `configmap` and the certificate file is mounted in `/etc/ssl/certs`. +For example, with the command `kubectl get configmap -lapp=gitlab-agent -o yaml`: + ```yaml -$ kubectl get configmap -lapp=gitlab-agent -o yaml apiVersion: v1 items: - apiVersion: v1 diff --git a/doc/user/packages/npm_registry/_index.md b/doc/user/packages/npm_registry/_index.md index afc2b6ecb684ad65eefdb1657f035998bd4be64c..10cb794b04bdfc3cc6a723264ba968fc433019d9 100644 --- a/doc/user/packages/npm_registry/_index.md +++ b/doc/user/packages/npm_registry/_index.md @@ -619,12 +619,12 @@ If the log doesn't appear in the `.npm/_logs/` directory, you can copy the log to your root directory and view it there: ```yaml -script: + script: - npm install --loglevel verbose - cp -r /root/.npm/_logs/ . artifacts: - paths: - - './_logs + paths: + - './_logs' ``` The npm log is copied to `/root/.npm/_logs/` as an artifact. diff --git a/doc/user/packages/workflows/working_with_monorepos.md b/doc/user/packages/workflows/working_with_monorepos.md index 34fbb350ae598e357e3a6228a3ddcc31e0d90ed3..cb884e82f656fdf13f5a6347feff940de06a261b 100644 --- a/doc/user/packages/workflows/working_with_monorepos.md +++ b/doc/user/packages/workflows/working_with_monorepos.md @@ -72,15 +72,12 @@ After you publish the package for `ChildProject`, you should see the package in A package is associated with a project on GitLab. But, a package is not associated with the code in that project. -For example, when configuring a package for npm or Maven, the `project_id` sets the registry URL that the package publishes to: +For example, when configuring a package for npm or Maven, the `project_id` sets the registry URL that the package publishes to. -```yaml -# npm -https://gitlab.example.com/api/v4/projects/<project_id>/packages/npm/ +For example: -# maven -https://gitlab.example.com/api/v4/projects/<project_id>/packages/maven/ -``` +- npm: `https://gitlab.example.com/api/v4/projects/<project_id>/packages/npm/` +- maven: `https://gitlab.example.com/api/v4/projects/<project_id>/packages/maven/` If you change the `project_id` in the registry URL to another project, your package publishes to that project. diff --git a/doc/user/project/requirements/_index.md b/doc/user/project/requirements/_index.md index 139dfb65fd32af73d26d7e226719e1ffb4ff5e8d..8a363727769cd1b22575f0026d34fac543b662a7 100644 --- a/doc/user/project/requirements/_index.md +++ b/doc/user/project/requirements/_index.md @@ -219,7 +219,7 @@ requirements, add a rule which checks `CI_HAS_OPEN_REQUIREMENTS` CI/CD variable. ```yaml requirements_confirmation: rules: - - if: "$CI_HAS_OPEN_REQUIREMENTS" == "true" + - if: '$CI_HAS_OPEN_REQUIREMENTS == "true"' when: manual - when: never allow_failure: false