Copy edit CI general pipelines settings text

Simplify settings text as part of OKR work.
Reorders the settings to make settings easier
to read, adds one more docs link, and moves
coverage regex examples into the docs.

app/views/admin/application_settings/_ci_cd.html.haml

@@ -58,6 +58,6 @@
       = f.text_field :default_ci_config_path, class: 'form-control', placeholder: '.gitlab-ci.yml'
       %p.form-text.text-muted
         = _("The default CI configuration path for new projects.").html_safe
-        = link_to sprite_icon('question-o'), help_page_path('ci/pipelines/settings', anchor: 'custom-ci-configuration-path'), target: '_blank'
+        = link_to sprite_icon('question-o'), help_page_path('ci/pipelines/settings', anchor: 'custom-cicd-configuration-path'), target: '_blank'
 
   = f.submit _('Save changes'), class: "gl-button btn btn-success"

app/views/groups/settings/ci_cd/_form.html.haml

@@ -4,10 +4,10 @@
       = form_errors(group)
       %fieldset.builds-feature
         .form-group
-          = f.label :max_artifacts_size, _('Maximum artifacts size (MB)'), class: 'label-bold'
+          = f.label :max_artifacts_size, _('Maximum artifacts size'), class: 'label-bold'
           = f.number_field :max_artifacts_size, class: 'form-control'
           %p.form-text.text-muted
-            = _("Set the maximum file size for each job's artifacts")
+            = _("The maximum file size in megabytes for individual job artifacts.")
             = link_to sprite_icon('question-o'), help_page_path('user/admin_area/settings/continuous_integration', anchor: 'maximum-artifacts-size'), target: '_blank'
 
         = f.submit _('Save changes'), class: "btn btn-success"

app/views/projects/settings/ci_cd/show.html.haml

@@ -12,7 +12,7 @@
     %button.btn.js-settings-toggle{ type: 'button' }
       = expanded ? _('Collapse') : _('Expand')
     %p
-      = _("Customize your pipeline configuration, view your pipeline status and coverage report.")
+      = _("Customize your pipeline configuration and coverage report.")
   .settings-content
     = render 'form'
 

changelogs/unreleased/298822-ci-cd-general-pipelines-settings-ui-text.yml

+---
+title: Update CI general pipeline settings UI text
+merge_request: 51806
+author:
+type: other

doc/administration/compliance.md

@@ -26,4 +26,4 @@ relevant compliance standards.
 |**[Audit events](audit_events.md)**<br>To maintain the integrity of your code, GitLab Enterprise Edition Premium gives admins the ability to view any modifications made within the GitLab server in an advanced audit events system, so you can control, analyze, and track every change.|Premium+|✓|Instance, Group, Project|
 |**[Auditor users](auditor_users.md)**<br>Auditor users are users who are given read-only access to all projects, groups, and other resources on the GitLab instance.|Premium+||Instance|
 |**[Credentials inventory](../user/admin_area/credentials_inventory.md)**<br>With a credentials inventory, GitLab administrators can keep track of the credentials used by all of the users in their GitLab instance. |Ultimate||Instance|
-|**Separation of Duties using [Protected branches](../user/project/protected_branches.md#protected-branches-approval-by-code-owners) and [custom CI Configuration Paths](../ci/pipelines/settings.md#custom-ci-configuration-path)**<br> GitLab Silver and Premium users can leverage the GitLab cross-project YAML configurations to define deployers of code and developers of code. View the [Separation of Duties Deploy Project](https://gitlab.com/guided-explorations/separation-of-duties-deploy/blob/master/README.md) and [Separation of Duties Project](https://gitlab.com/guided-explorations/separation-of-duties/blob/master/README.md) to see how to use this set up to define these roles.|Premium+|✓|Project|
+|**Separation of Duties using [Protected branches](../user/project/protected_branches.md#protected-branches-approval-by-code-owners) and [custom CI Configuration Paths](../ci/pipelines/settings.md#custom-cicd-configuration-path)**<br> GitLab Silver and Premium users can leverage the GitLab cross-project YAML configurations to define deployers of code and developers of code. View the [Separation of Duties Deploy Project](https://gitlab.com/guided-explorations/separation-of-duties-deploy/blob/master/README.md) and [Separation of Duties Project](https://gitlab.com/guided-explorations/separation-of-duties/blob/master/README.md) to see how to use this set up to define these roles.|Premium+|✓|Project|

doc/ci/README.md

@@ -105,7 +105,7 @@ GitLab CI/CD supports numerous configuration options:
 | Configuration                                                                           | Description                                                                               |
 |:----------------------------------------------------------------------------------------|:------------------------------------------------------------------------------------------|
 | [Schedule pipelines](pipelines/schedules.md)                                            | Schedule pipelines to run as often as you need.                                           |
-| [Custom path for `.gitlab-ci.yml`](pipelines/settings.md#custom-ci-configuration-path)  | Define a custom path for the CI/CD configuration file.                                    |
+| [Custom path for `.gitlab-ci.yml`](pipelines/settings.md#custom-cicd-configuration-path) | Define a custom path for the CI/CD configuration file.                                   |
 | [Git submodules for CI/CD](git_submodules.md)                                           | Configure jobs for using Git submodules.                                                  |
 | [SSH keys for CI/CD](ssh_keys/README.md)                                                | Using SSH keys in your CI pipelines.                                                      |
 | [Pipeline triggers](triggers/README.md)                                                 | Trigger pipelines through the API.                                                        |

doc/ci/environments/deployment_safety.md

@@ -141,7 +141,7 @@ reference a file in another project with a completely different set of permissio
 In this scenario, the `gitlab-ci.yml` is publicly accessible, but can only be edited by users with
 appropriate permissions in the other project.
 
-For more information, see [Custom CI configuration path](../pipelines/settings.md#custom-ci-configuration-path).
+For more information, see [Custom CI/CD configuration path](../pipelines/settings.md#custom-cicd-configuration-path).
 
 ## Troubleshooting
 

doc/ci/pipelines/settings.md

@@ -68,7 +68,7 @@ Project defined timeout (either specific timeout set by user or the default
 For information about setting a maximum artifact size for a project, see
 [Maximum artifacts size](../../user/admin_area/settings/continuous_integration.md#maximum-artifacts-size).
 
-## Custom CI configuration path
+## Custom CI/CD configuration path
 
 > - [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/12509) in GitLab 9.4.
 > - [Support for external `.gitlab-ci.yml` locations](https://gitlab.com/gitlab-org/gitlab/-/issues/14376) introduced in GitLab 12.6.
@@ -80,7 +80,7 @@ To customize the path:
 
 1. Go to the project's **Settings > CI / CD**.
 1. Expand the **General pipelines** section.
-1. Provide a value in the **Custom CI configuration path** field.
+1. Provide a value in the **CI/CD configuration file** field.
 1. Click **Save changes**.
 
 If the CI configuration is stored within the repository in a non-default
@@ -131,8 +131,19 @@ averaged.
 
 ![Build status coverage](img/pipelines_test_coverage_build.png)
 
-A few examples of known coverage tools for a variety of languages can be found
-in the pipelines settings page.
+| Coverage Tool                                  | Sample regular expression |
+|------------------------------------------------|---------------------------|
+| Simplecov (Ruby)                               | `\(\d+.\d+\%\) covered` |
+| pytest-cov (Python)                            | `^TOTAL.+?(\d+\%)$` |
+| Scoverage (Scala)                              | `Statement coverage[A-Za-z\.*]\s*:\s*([^%]+)` |
+| `phpunit --coverage-text --colors=never` (PHP) | `^\s*Lines:\s*\d+.\d+\%` |
+| gcovr (C/C++)                                  | `^TOTAL.*\s+(\d+\%)$` |
+| `tap --coverage-report=text-summary` (NodeJS)  | `^Statements\s*:\s*([^%]+)` |
+| `nyc npm test` (NodeJS)                        | `All files[^|]*\|[^|]*\s+([\d\.]+)` |
+| excoveralls (Elixir)                           | `\[TOTAL\]\s+(\d+\.\d+)%` |
+| `mix test --cover` (Elixir)                    | `\d+.\d+\%\s+\|\s+Total` |
+| JaCoCo (Java/Kotlin)                           | `Total.*?([0-9]{1,3})%` |
+| `go test -cover` (Go)                          | `coverage: \d+.\d+% of statements` |
 
 ### Code Coverage history
 
@@ -198,7 +209,7 @@ If **Public pipelines** is disabled:
 - For **private** projects, only project members (reporter or higher)
   can view the pipelines or access the related features.
 
-## Auto-cancel pending pipelines
+## Auto-cancel redundant pipelines
 
 > [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/9362) in GitLab 9.1.
 
@@ -206,7 +217,7 @@ You can set pending or running pipelines to cancel automatically when a new pipe
 
 1. Go to **Settings > CI / CD**.
 1. Expand **General Pipelines**.
-1. Check the **Auto-cancel redundant, pending pipelines** checkbox.
+1. Check the **Auto-cancel redundant pipelines** checkbox.
 1. Click **Save changes**.
 
 Use the [`interruptible`](../yaml/README.md#interruptible) keyword to indicate if a

doc/ci/variables/README.md

@@ -618,7 +618,7 @@ variables, an `Insufficient permissions to set pipeline variables` error occurs.
 
 The setting is `disabled` by default.
 
-If you [store your CI configurations in a different repository](../../ci/pipelines/settings.md#custom-ci-configuration-path),
+If you [store your CI configurations in a different repository](../../ci/pipelines/settings.md#custom-cicd-configuration-path),
 use this setting for strict control over all aspects of the environment
 the pipeline runs in.
 

doc/ci/yaml/README.md

@@ -3850,7 +3850,7 @@ The trigger token is different than the [`trigger`](#trigger) keyword.
 `interruptible` is used to indicate that a running job should be canceled if made redundant by a newer pipeline run.
 Defaults to `false` (uninterruptible). Jobs that have not started yet (pending) are considered interruptible
 and safe to be cancelled.
-This value is used only if the [automatic cancellation of redundant pipelines feature](../pipelines/settings.md#auto-cancel-pending-pipelines)
+This value is used only if the [automatic cancellation of redundant pipelines feature](../pipelines/settings.md#auto-cancel-redundant-pipelines)
 is enabled.
 
 When enabled, a pipeline is immediately canceled when a new pipeline starts on the same branch if either of the following is true:

doc/user/admin_area/settings/continuous_integration.md

@@ -156,7 +156,7 @@ Area of your GitLab instance (`.gitlab-ci.yml` if not set):
 1. Input the new path in the **Default CI configuration path** field.
 1. Hit **Save changes** for the changes to take effect.
 
-It is also possible to specify a [custom CI configuration path for a specific project](../../../ci/pipelines/settings.md#custom-ci-configuration-path).
+It is also possible to specify a [custom CI/CD configuration path for a specific project](../../../ci/pipelines/settings.md#custom-cicd-configuration-path).
 
 <!-- ## Troubleshooting
 

locale/gitlab.pot

@@ -1337,9 +1337,6 @@ msgstr ""
 msgid "A rebase is already in progress."
 msgstr ""
 
-msgid "A regular expression that will be used to find the test coverage output in the job log. Leave blank to disable"
-msgstr ""
-
 msgid "A secure token that identifies an external storage request."
 msgstr ""
 
@@ -2904,7 +2901,7 @@ msgstr ""
 msgid "Allow projects within this group to use Git LFS"
 msgstr ""
 
-msgid "Allow public access to pipelines and job details, including output logs and artifacts"
+msgid "Allow public access to pipelines and job details, including output logs and artifacts."
 msgstr ""
 
 msgid "Allow rendering of PlantUML diagrams in Asciidoc documents."
@@ -4178,7 +4175,7 @@ msgstr ""
 msgid "Auto stop successfully canceled."
 msgstr ""
 
-msgid "Auto-cancel redundant, pending pipelines"
+msgid "Auto-cancel redundant pipelines"
 msgstr ""
 
 msgid "Auto-close referenced issues on default branch"
@@ -4427,9 +4424,6 @@ msgstr ""
 msgid "Begin with the selected commit"
 msgstr ""
 
-msgid "Below are examples of regex for existing tools:"
-msgstr ""
-
 msgid "Below are the fingerprints for the current instance SSH host keys."
 msgstr ""
 
@@ -4975,6 +4969,9 @@ msgstr ""
 msgid "CI/CD configuration"
 msgstr ""
 
+msgid "CI/CD configuration file"
+msgstr ""
+
 msgid "CI/CD for external repo"
 msgstr ""
 
@@ -5629,9 +5626,6 @@ msgstr ""
 msgid "Choose any color. Or you can choose one of the suggested colors below"
 msgstr ""
 
-msgid "Choose between %{code_open}clone%{code_close} or %{code_open}fetch%{code_close} to get the recent application code"
-msgstr ""
-
 msgid "Choose file…"
 msgstr ""
 
@@ -5650,6 +5644,9 @@ msgstr ""
 msgid "Choose what content you want to see on a group’s overview page."
 msgstr ""
 
+msgid "Choose which Git strategy to use when fetching the project."
+msgstr ""
+
 msgid "Choose which repositories you want to connect and run CI/CD pipelines."
 msgstr ""
 
@@ -8561,9 +8558,6 @@ msgstr ""
 msgid "Custom Attributes"
 msgstr ""
 
-msgid "Custom CI configuration path"
-msgstr ""
-
 msgid "Custom Git clone URL for HTTP(S)"
 msgstr ""
 
@@ -8636,7 +8630,7 @@ msgstr ""
 msgid "Customize name"
 msgstr ""
 
-msgid "Customize your pipeline configuration, view your pipeline status and coverage report."
+msgid "Customize your pipeline configuration and coverage report."
 msgstr ""
 
 msgid "Customize your pipeline configuration."
@@ -12177,9 +12171,6 @@ msgstr ""
 msgid "Fast-forward merge without a merge commit"
 msgstr ""
 
-msgid "Faster as it re-uses the project workspace (falling back to clone if it doesn't exist)"
-msgstr ""
-
 msgid "Faster releases. Better code. Less pain."
 msgstr ""
 
@@ -12701,13 +12692,16 @@ msgstr ""
 msgid "For additional information, review your group membership: %{link_to} or contact your group owner."
 msgstr ""
 
-msgid "For help setting up the Service Desk for your instance, please contact an administrator."
+msgid "For each job, clone the repository."
 msgstr ""
 
-msgid "For individual use, create a separate account under your personal email address, not tied to the Enterprise email domain or group."
+msgid "For each job, re-use the project workspace. If the workspace doesn't exist, use %{code_open}git clone%{code_close}."
 msgstr ""
 
-msgid "For internal projects, any logged in user except external users can view pipelines and access job details (output logs and artifacts)"
+msgid "For help setting up the Service Desk for your instance, please contact an administrator."
+msgstr ""
+
+msgid "For individual use, create a separate account under your personal email address, not tied to the Enterprise email domain or group."
 msgstr ""
 
 msgid "For more info, read the documentation."
@@ -12731,12 +12725,6 @@ msgstr ""
 msgid "For more information, see the documentation on %{link_start}disabling Seat Link%{link_end}."
 msgstr ""
 
-msgid "For private projects, any member (guest or higher) can view pipelines and access job details (output logs and artifacts)"
-msgstr ""
-
-msgid "For public projects, anyone can view pipelines and access job details (output logs and artifacts)"
-msgstr ""
-
 msgid "Forgot your password?"
 msgstr ""
 
@@ -13277,7 +13265,7 @@ msgstr ""
 msgid "Git shallow clone"
 msgstr ""
 
-msgid "Git strategy for pipelines"
+msgid "Git strategy"
 msgstr ""
 
 msgid "Git transfer in progress"
@@ -14667,9 +14655,6 @@ msgstr ""
 msgid "If any indexed field exceeds this limit it will be truncated to this number of characters and the rest will not be indexed or searchable. This does not apply to repository and wiki indexing. Setting this to 0 means it is unlimited."
 msgstr ""
 
-msgid "If any job surpasses this timeout threshold, it will be marked as failed. Human readable time input language is accepted like \"1 hour\". Values without specification represent seconds."
-msgstr ""
-
 msgid "If blank, set allowable lifetime to %{instance_level_policy_in_words}, as defined by the instance admin. Once set, existing tokens for users in this group may be revoked."
 msgstr ""
 
@@ -14685,12 +14670,6 @@ msgstr ""
 msgid "If disabled, only admins will be able to configure repository mirroring."
 msgstr ""
 
-msgid "If disabled, the access level will depend on the user's permissions in the project."
-msgstr ""
-
-msgid "If enabled"
-msgstr ""
-
 msgid "If enabled, GitLab will handle Object Storage replication using Geo. %{linkStart}More information%{linkEnd}"
 msgstr ""
 
@@ -16265,6 +16244,9 @@ msgstr ""
 msgid "Jobs"
 msgstr ""
 
+msgid "Jobs fail if they run longer than the timeout time. Input value is in seconds by default. Human readable input is also accepted, for example %{code_open}1 hour%{code_close}."
+msgstr ""
+
 msgid "Jobs|Are you sure you want to proceed?"
 msgstr ""
 
@@ -17466,6 +17448,9 @@ msgstr ""
 msgid "Maximum allowable lifetime for personal access token (days)"
 msgstr ""
 
+msgid "Maximum artifacts size"
+msgstr ""
+
 msgid "Maximum artifacts size (MB)"
 msgstr ""
 
@@ -19186,7 +19171,7 @@ msgstr ""
 msgid "New password"
 msgstr ""
 
-msgid "New pipelines will cancel older, pending pipelines on the same branch"
+msgid "New pipelines cause older pending pipelines on the same branch to be cancelled."
 msgstr ""
 
 msgid "New project"
@@ -26371,9 +26356,6 @@ msgstr ""
 msgid "SlackService|This service allows users to perform common operations on this project by entering slash commands in Slack."
 msgstr ""
 
-msgid "Slower but makes sure the project workspace is pristine as it clones the repository from scratch for every job"
-msgstr ""
-
 msgid "Smartcard"
 msgstr ""
 
@@ -28313,6 +28295,9 @@ msgstr ""
 msgid "The maximum file size allowed is %{size}."
 msgstr ""
 
+msgid "The maximum file size in megabytes for individual job artifacts."
+msgstr ""
+
 msgid "The maximum file size is %{size}."
 msgstr ""
 
@@ -28331,7 +28316,10 @@ msgstr ""
 msgid "The name \"%{name}\" is already taken in this directory."
 msgstr ""
 
-msgid "The number of changes to be fetched from GitLab when cloning a repository. This can speed up Pipelines execution. Keep empty or set to 0 to disable shallow clone by default and make GitLab CI fetch all branches and tags each time."
+msgid "The name of the CI/CD configuration file. A path relative to the root directory is optional (for example %{code_open}my/path/.myfile.yml%{code_close})."
+msgstr ""
+
+msgid "The number of changes to fetch from GitLab when cloning a repository. Lower values can speed up pipeline execution. Set to %{code_open}0%{code_close} or blank to fetch all branches and tags for each job"
 msgstr ""
 
 msgid "The number of merge requests merged by month."
@@ -28349,9 +28337,6 @@ msgstr ""
 msgid "The passphrase required to decrypt the private key. This is optional and the value is encrypted at rest."
 msgstr ""
 
-msgid "The path to the CI configuration file. Defaults to %{code_open}.gitlab-ci.yml%{code_close}"
-msgstr ""
-
 msgid "The phase of the development lifecycle."
 msgstr ""
 
@@ -28397,6 +28382,9 @@ msgstr ""
 msgid "The pseudonymizer data collection is disabled. When enabled, GitLab will run a background job that will produce pseudonymized CSVs of the GitLab database that will be uploaded to your configured object storage directory."
 msgstr ""
 
+msgid "The regular expression used to find test coverage output in the job log. For example, use %{regex} for Simplecov (Ruby). Leave blank to disable."
+msgstr ""
+
 msgid "The remote mirror took to long to complete."
 msgstr ""
 
@@ -31992,7 +31980,7 @@ msgstr ""
 msgid "When Kroki is enabled, GitLab sends diagrams to an instance of Kroki to display them as images. You can use the free public cloud instance %{kroki_public_url} or you can %{install_link} on your own infrastructure. Once you've installed Kroki, make sure to update the server URL to point to your instance."
 msgstr ""
 
-msgid "When a deployment job is successful, skip older deployment jobs that are still pending"
+msgid "When a deployment job is successful, skip older deployment jobs that are still pending."
 msgstr ""
 
 msgid "When a runner is locked, it cannot be assigned to other projects"

spec/features/projects/settings/pipelines_settings_spec.rb

@@ -46,7 +46,7 @@ RSpec.describe "Projects > Settings > Pipelines settings" do
     it 'updates auto_cancel_pending_pipelines' do
       visit project_settings_ci_cd_path(project)
 
-      page.check('Auto-cancel redundant, pending pipelines')
+      page.check('Auto-cancel redundant pipelines')
       page.within '#js-general-pipeline-settings' do
         click_on 'Save changes'
       end