diff options
author | GitLab Bot <gitlab-bot@gitlab.com> | 2021-12-02 00:13:44 +0300 |
---|---|---|
committer | GitLab Bot <gitlab-bot@gitlab.com> | 2021-12-02 00:13:44 +0300 |
commit | 7b78125a3829026f54bd87ab560758de3f37ad82 (patch) | |
tree | 23e64653bb916db82b436af4b040582875acb34e /doc | |
parent | 5fc2d78fb96b0fd50dfb737190fd411033b3c3ab (diff) |
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc')
8 files changed, 33 insertions, 27 deletions
diff --git a/doc/development/contributing/style_guides.md b/doc/development/contributing/style_guides.md index e3b8f7372b9..fdb6e99fdcd 100644 --- a/doc/development/contributing/style_guides.md +++ b/doc/development/contributing/style_guides.md @@ -171,10 +171,8 @@ we should track our progress through the exception list. When auto-generating the `.rubocop_todo.yml` exception list for a particular Cop, and more than 15 files are affected, we should add the exception list to -a different file within `.rubocop_todo/` directory. - -For example, the configuration for the cop `Gitlab/NamespacedClass` is located -in `.rubocop_todo/gitlab/namespaced_class.yml`. +a different file in the directory `.rubocop_todo/`. For example, the configuration for the cop +`Gitlab/NamespacedClass` is in `.rubocop_todo/gitlab/namespaced_class.yml`. This ensures that our list isn't mistakenly removed by another auto generation of the `.rubocop_todo.yml`. This also allows us greater visibility into the exceptions diff --git a/doc/user/admin_area/settings/continuous_integration.md b/doc/user/admin_area/settings/continuous_integration.md index 565e905d732..2ed417a2933 100644 --- a/doc/user/admin_area/settings/continuous_integration.md +++ b/doc/user/admin_area/settings/continuous_integration.md @@ -232,11 +232,11 @@ To enable or disable the banner: ## Required pipeline configuration **(PREMIUM SELF)** -WARNING: -This feature is being re-evaluated in favor of a different -[compliance solution](https://gitlab.com/groups/gitlab-org/-/epics/3156). -We recommend that users who haven't yet implemented this feature wait for -the new solution. +NOTE: +An alternative [compliance solution](../../project/settings/index.md#compliance-pipeline-configuration) +is available for Ultimate tier users on both SaaS and self-managed instances. +We recommend this alternative solution for Ultimate-tier users because it provides greater flexibility, +allowing required pipelines to be assigned to specific compliance framework labels. You can set a [CI/CD template](../../../ci/examples/index.md#cicd-templates) as a required pipeline configuration for all projects on a GitLab instance. You can diff --git a/doc/user/application_security/configuration/index.md b/doc/user/application_security/configuration/index.md index a913d5fba92..cdcd334dba6 100644 --- a/doc/user/application_security/configuration/index.md +++ b/doc/user/application_security/configuration/index.md @@ -46,14 +46,14 @@ You can configure the following security controls: - Select **Manage scans** to manage the saved DAST scans, site profiles, and scanner profiles. For more details, read [DAST on-demand scans](../dast/index.md#on-demand-scans). - [Dependency Scanning](../dependency_scanning/index.md) - - Select **Configure via Merge Request** to create a merge request with the changes required to + - Select **Configure with a merge request** to create a merge request with the changes required to enable Dependency Scanning. For more details, see [Enable Dependency Scanning via an automatic merge request](../dependency_scanning/index.md#enable-dependency-scanning-via-an-automatic-merge-request). - [Container Scanning](../container_scanning/index.md) - Can be configured with `.gitlab-ci.yml`. For more details, read [Container Scanning](../../../user/application_security/container_scanning/index.md#configuration). - [Cluster Image Scanning](../cluster_image_scanning/index.md) - Can be configured with `.gitlab-ci.yml`. For more details, read [Cluster Image Scanning](../../../user/application_security/cluster_image_scanning/#configuration). - [Secret Detection](../secret_detection/index.md) - - Select **Configure via Merge Request** to create a merge request with the changes required to + - Select **Configure with a merge request** to create a merge request with the changes required to enable Secret Detection. For more details, read [Enable Secret Detection via an automatic merge request](../secret_detection/index.md#enable-secret-detection-via-an-automatic-merge-request). - [API Fuzzing](../api_fuzzing/index.md) - Select **Enable API Fuzzing** to use API Fuzzing for the current project. For more details, read [API Fuzzing](../../../user/application_security/api_fuzzing/index.md#enable-web-api-fuzzing). diff --git a/doc/user/application_security/dependency_scanning/index.md b/doc/user/application_security/dependency_scanning/index.md index 4b6da3fd482..e7ae8687488 100644 --- a/doc/user/application_security/dependency_scanning/index.md +++ b/doc/user/application_security/dependency_scanning/index.md @@ -9,7 +9,7 @@ info: To determine the technical writer assigned to the Stage/Group associated w INFO: Try out Dependency Scanning in GitLab Ultimate. -[It's free for 30 days](https://about.gitlab.com/free-trial?glm_source=docs.gitlab.com&glm_content=u-dependency-scanning-docs). +[It's free for 30 days](https://about.gitlab.com/free-trial?glm_source=docs.gitlab.com&glm_content=u-dependency-scanning-docs). The Dependency Scanning feature can automatically find security vulnerabilities in your dependencies while you're developing and testing your applications. For example, dependency scanning @@ -444,7 +444,7 @@ from the Security Configuration page. 1. In the project where you want to enable Dependency Scanning, navigate to **Security & Compliance > Configuration**. -1. In the **Dependency Scanning** row, select **Configure via Merge Request**. +1. In the **Dependency Scanning** row, select **Configure with a merge request**. This automatically creates a merge request with the changes necessary to enable Dependency Scanning that you can review and merge to complete the configuration. diff --git a/doc/user/application_security/iac_scanning/index.md b/doc/user/application_security/iac_scanning/index.md index 3d164165de1..8c63996a133 100644 --- a/doc/user/application_security/iac_scanning/index.md +++ b/doc/user/application_security/iac_scanning/index.md @@ -39,7 +39,7 @@ GitLab IaC scanning supports a variety of IaC configuration files. Our IaC secur ### Making IaC analyzers available to all GitLab tiers -All open source (OSS) analyzers are availibile with the GitLab Free tier. Future propietary analyzers may be restricted to higher tiers. +All open source (OSS) analyzers are availibile with the GitLab Free tier. Future propietary analyzers may be restricted to higher tiers. #### Summary of features per tier @@ -84,7 +84,7 @@ from the Security Configuration page: 1. On the top bar, select **Menu > Projects** and find your project. 1. On the left sidebar, select **Security & Compliance > Configuration**. -1. In the **Infrastructure as Code (IaC) Scanning** row, select **Configure via Merge Request**. +1. In the **Infrastructure as Code (IaC) Scanning** row, select **Configure with a merge request**. This automatically creates a merge request with the changes necessary to enable IaC Scanning that you can review and merge to complete the configuration. diff --git a/doc/user/application_security/secret_detection/index.md b/doc/user/application_security/secret_detection/index.md index 4339b5c499d..056c8ac6079 100644 --- a/doc/user/application_security/secret_detection/index.md +++ b/doc/user/application_security/secret_detection/index.md @@ -123,10 +123,10 @@ from the Security Configuration page. 1. In the project where you want to enable Secret Detection, go to **Security & Compliance > Configuration**. -1. In the **Secret Detection** row, select **Configure via Merge Request**. +1. In the **Secret Detection** row, select **Configure with a merge request**. This automatically creates a merge request with the changes necessary to enable Secret Detection -that you can review and merge to complete the configuration. +that you can review and merge to complete the configuration. NOTE: The configuration tool works best with no existing `.gitlab-ci.yml` file, or with a minimal diff --git a/doc/user/infrastructure/iac/terraform_state.md b/doc/user/infrastructure/iac/terraform_state.md index 84d1edbe2f7..a45ef02622f 100644 --- a/doc/user/infrastructure/iac/terraform_state.md +++ b/doc/user/infrastructure/iac/terraform_state.md @@ -17,7 +17,7 @@ to securely store the state files in local storage (the default) or WARNING: Using local storage (the default) on clustered deployments of GitLab will result in a split state across nodes, making subsequent executions of Terraform inconsistent. -You are highly advised to use a remote storage in that case. +You are highly advised to use a remote storage resource in that case. The GitLab managed Terraform state backend can store your Terraform state easily and securely, and spares you from setting up additional remote resources like @@ -28,7 +28,7 @@ Amazon S3 or Google Cloud Storage. Its features include: - Locking and unlocking state. - Remote Terraform plan and apply execution. -A GitLab **administrator** must [setup the Terraform state storage configuration](../../../administration/terraform_state.md) +A GitLab **administrator** must [set up the Terraform state storage configuration](../../../administration/terraform_state.md) before using this feature. ## Permissions for using Terraform @@ -89,7 +89,7 @@ local machine, this is a simple way to get started: ``` If you already have a GitLab-managed Terraform state, you can use the `terraform init` command -with the prepopulated parameters values: +with the pre-populated parameters values: 1. On the top bar, select **Menu > Projects** and find your project. 1. On the left sidebar, select **Infrastructure > Terraform**. @@ -300,7 +300,7 @@ any changes that are required for your infrastructure. All Terraform commands should now work. If you ever set or change modules or backend configuration for Terraform, -rerun this command to reinitialize your working directory. If you forget, other +re-run this command to reinitialize your working directory. If you forget, other commands will detect it and remind you to do so if necessary. ``` diff --git a/doc/user/project/code_owners.md b/doc/user/project/code_owners.md index 7057abe8a0f..7cc8c314c63 100644 --- a/doc/user/project/code_owners.md +++ b/doc/user/project/code_owners.md @@ -177,12 +177,16 @@ entries under **Database**. The entries defined under the sections **Documentati ### Make a Code Owners section optional -> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/232995) in GitLab Premium 13.8 behind a feature flag, enabled by default. -> - [Feature flag removed](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/53227) in GitLab 13.9. +> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/232995) in GitLab Premium 13.8. -You can make a section optional, so that approval from the Code Owners in that section is optional. +You can designate optional sections in your Code Owners file. Prepend the +section name with the caret `^` character to treat the entire section as optional. +Optional sections enable you to designate responsible parties for various parts +of your codebase, but not require approval from them. This approach provides +a more relaxed policy for parts of your project that are frequently updated, +but don't require stringent reviews. -Put a caret `^` character before the Code Owners section name. For example: +In this example, the `[Go]` section is optional: ```plaintext [Documentation] @@ -204,8 +208,12 @@ If a section is duplicated in the file, and one of them is marked as optional an Optional sections in the `CODEOWNERS` file are treated as optional only when changes are submitted by using merge requests. If a change is submitted directly to the protected branch, approval from Code Owners is still required, even if the -section is marked as optional. [An issue exists](https://gitlab.com/gitlab-org/gitlab/-/issues/297638) -to allow direct pushes to the protected branch for sections marked as optional. +section is marked as optional. + +### Allowed to Push + +The Code Owner approval and protected branch features do not apply to users who +are **Allowed to push**. ## Example `CODEOWNERS` file |