Improve instance mirroring help text

A bug was reported with mirroring because it wasn't clear that both
push and pull mirroring are disabled by this option.

Improved help text and API docs should make this clearer for those
who chose to use this feature.

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

@@ -7,9 +7,9 @@
       .form-check
         = f.check_box :mirror_available, class: 'form-check-input'
         = f.label :mirror_available, class: 'form-check-label' do
-          = _('Allow mirrors to be set up for projects')
+          = _('Allow repository mirroring to be configured by project maintainers')
       %span.form-text.text-muted
-        = _('If disabled, only admins will be able to set up mirrors in projects.')
+        = _('If disabled, only admins will be able to configure repository mirroring.')
         = link_to icon('question-circle'), help_page_path('workflow/repository_mirroring')
 
     = render_if_exists 'admin/application_settings/mirror_settings', form: f

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

@@ -5,11 +5,11 @@
 %section.settings.as-mirror.no-animate#js-mirror-settings{ class: ('expanded' if expanded_by_default?) }
   .settings-header
     %h4
-      = _('Repository mirror')
+      = _('Repository mirroring')
     %button.btn.js-settings-toggle{ type: 'button' }
       = expanded_by_default? ? 'Collapse' : 'Expand'
     %p
-      = _('Configure push mirrors.')
+      = _('Configure repository mirroring.')
   .settings-content
     = render partial: 'repository_mirrors_form'
 

changelogs/unreleased/jramsay-admin-mirror-helptext.yml

+---
+title: Improve instance mirroring help text
+merge_request: 19047
+author:
+type: other

doc/api/settings.md

@@ -270,7 +270,7 @@ are listed in the descriptions of the relevant settings.
 | `metrics_port`                           | integer          | required by: `metrics_enabled`       | The UDP port to use for connecting to InfluxDB. |
 | `metrics_sample_interval`                | integer          | required by: `metrics_enabled`       | The sampling interval in seconds. |
 | `metrics_timeout`                        | integer          | required by: `metrics_enabled`       | The amount of seconds after which InfluxDB will time out. |
-| `mirror_available`                       | boolean          | no                                   | Allow mirrors to be set up for projects. If disabled, only admins will be able to set up mirrors in projects. |
+| `mirror_available`                       | boolean          | no                                   | Allow repository mirroring to configured by project Maintainers. If disabled, only Admins will be able to configure repository mirroring. |
 | `mirror_capacity_threshold`              | integer          | no                                   | **(PREMIUM)** Minimum capacity to be available before scheduling more mirrors preemptively |
 | `mirror_max_capacity`                    | integer          | no                                   | **(PREMIUM)** Maximum number of mirrors that can be synchronizing at the same time. |
 | `mirror_max_delay`                       | integer          | no                                   | **(PREMIUM)** Maximum time (in minutes) between updates that a mirror can have when scheduled to synchronize. |

locale/gitlab.pot

@@ -1404,9 +1404,6 @@ msgstr ""
 msgid "Allow group owners to manage LDAP-related settings"
 msgstr ""
 
-msgid "Allow mirrors to be set up for projects"
-msgstr ""
-
 msgid "Allow only the selected protocols to be used for Git access."
 msgstr ""
 
@@ -1419,6 +1416,9 @@ msgstr ""
 msgid "Allow rendering of PlantUML diagrams in Asciidoc documents."
 msgstr ""
 
+msgid "Allow repository mirroring to be configured by project maintainers"
+msgstr ""
+
 msgid "Allow requests to the local network from hooks and services."
 msgstr ""
 
@@ -4328,7 +4328,7 @@ msgstr ""
 msgid "Configure paths to be protected by Rack Attack. A web server restart is required after changing these settings."
 msgstr ""
 
-msgid "Configure push mirrors."
+msgid "Configure repository mirroring."
 msgstr ""
 
 msgid "Configure storage path settings."
@@ -8794,7 +8794,7 @@ msgstr ""
 msgid "If disabled, a diverged local branch will not be automatically updated with commits from its remote counterpart, to prevent local data loss. If the default branch (%{default_branch}) has diverged and cannot be updated, mirroring will fail. Other diverged branches are silently ignored."
 msgstr ""
 
-msgid "If disabled, only admins will be able to set up mirrors in projects."
+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."
@@ -13948,7 +13948,7 @@ msgstr ""
 msgid "Repository maintenance"
 msgstr ""
 
-msgid "Repository mirror"
+msgid "Repository mirroring"
 msgstr ""
 
 msgid "Repository static objects"