Merge branch 'selhorn-runner-settings-okr' into 'master'

Runners: Updated UI text to match latest style

See merge request gitlab-org/gitlab!50403

app/views/ci/runner/_how_to_setup_runner.html.haml

-- link = link_to _("Install GitLab Runner"), 'https://docs.gitlab.com/runner/install/', target: '_blank'
+- link = link_to _("Install GitLab Runner and ensure it's running."), 'https://docs.gitlab.com/runner/install/', target: '_blank'
 .gl-mb-3
-  %h4= _("Set up a %{type} Runner manually") % { type: type }
+  %h5= _("Set up a %{type} runner manually") % { type: type }
 
 %ol
   %li
     = link.html_safe
   %li
-    = _("Specify the following URL during the Runner setup:")
+    = _("Register the runner with this URL:")
+    %br
     %code#coordinator_address= root_url(only_path: false)
     = clipboard_button(target: '#coordinator_address', title: _("Copy URL"), class: "btn-transparent btn-clipboard")
-  %li
-    = _("Use the following registration token during setup:")
+    %br
+    %br
+    = _("And this registration token:")
+    %br
     %code#registration_token= registration_token
     = clipboard_button(target: '#registration_token', title: _("Copy token"), class: "btn-transparent btn-clipboard")
-    .gl-mt-3.gl-mb-3
-      = button_to _("Reset runners registration token"), reset_token_url,
-      method: :put, class: 'gl-button btn btn-default',
-      data: { confirm: _("Are you sure you want to reset registration token?") }
-  %li
-    = _("Start the Runner!")
+
+.gl-mt-3.gl-mb-3
+= button_to _("Reset registration token"), reset_token_url,
+method: :put, class: 'gl-button btn btn-default',
+data: { confirm: _("Are you sure you want to reset the registration token?") }

app/views/ci/runner/_how_to_setup_runner_automatically.html.haml

-.gl-mb-3
-  %h4= _('Set up a %{type} Runner automatically') % { type: type }
+%h5= _('Set up a %{type} runner automatically') % { type: type }
 
 %p
-  - link_to_help_page = link_to(_('Learn more about Kubernetes'),
+  - link_to_help_page = link_to(_('Learn more.'),
                                 help_page_path('user/project/clusters/index'),
                                 target: '_blank',
                                 rel: 'noopener noreferrer')
 
-  = _('You can easily install a Runner on a Kubernetes cluster. %{link_to_help_page}').html_safe % { link_to_help_page: link_to_help_page }
+  = _('Register a runner on a Kubernetes cluster. %{link_to_help_page}').html_safe % { link_to_help_page: link_to_help_page }
 
 %ol
   %li
-    = _('Click the button below to begin the install process by navigating to the Kubernetes page')
+    = _('Click the button below.')
   %li
-    = _('Select an existing Kubernetes cluster or create a new one')
+    = _('Select an existing Kubernetes cluster or create a new one.')
   %li
-    = _('From the Kubernetes cluster details view, install Runner from the applications list')
+    = _('From the Kubernetes cluster details view, applications list, install GitLab Runner.')
 
-= link_to _('Install Runner on Kubernetes'),
+= link_to _('Install GitLab Runner on Kubernetes'),
   clusters_path,
   class: 'gl-button btn btn-info'

app/views/groups/runners/_group_runners.html.haml

-- link = link_to _('Runners API'), help_page_path('api/runners.md')
+- link = link_to _('Runner API'), help_page_path('api/runners.md')
 
-%h3
-  = _('Group Runners')
+%h4
+  = _('Group runners')
 
-.bs-callout.bs-callout-warning
-  = _('GitLab Group Runners can execute code for all the projects in this group.')
-  = _('They can be managed using the %{link}.').html_safe % { link: link }
+%p
+  = _('These runners are shared across projects in this group.')
+  = _('Group runners can be managed with the %{link}.').html_safe % { link: link }
 
 -# Proper policies should be implemented per
 -# https://gitlab.com/gitlab-org/gitlab-foss/issues/45894
@@ -18,3 +18,4 @@
            locals: { registration_token: @group.runners_token,
                      type: 'group',
                      reset_token_url: reset_registration_token_group_settings_ci_cd_path }
+  %br

app/views/groups/runners/_index.html.haml

@@ -2,8 +2,6 @@
 
 %hr
 
-%p.lead
-  = _('To start serving your jobs you can add Runners to your group')
 .row
   .col-sm-6
     = render 'groups/runners/group_runners'
@@ -11,7 +9,7 @@
     = render 'groups/runners/shared_runners'
 
 %h4.underlined-title
-  = _('Available Runners: %{runners}').html_safe % { runners: limited_counter_with_delimiter(@all_group_runners) }
+  = _('Available runners: %{runners}').html_safe % { runners: limited_counter_with_delimiter(@all_group_runners) }
 
 -# haml-lint:disable NoPlainNodes
 .row

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

@@ -31,8 +31,8 @@
     %button.btn.gl-button.btn-default.js-settings-toggle{ type: "button" }
       = expanded ? _('Collapse') : _('Expand')
     %p
-      = _("Runners are processes that pick up and execute jobs for GitLab. Here you can register and see your Runners for this project.")
-      = link_to s_('More information'), help_page_path('ci/runners/README')
+      = _("Runners are processes that pick up and execute CI/CD jobs for GitLab.")
+      = link_to s_('How do I configure runners?'), help_page_path('ci/runners/README')
   .settings-content
     = render 'groups/runners/index'
 

app/views/projects/runners/_group_runners.html.haml

-- link = link_to _('Runners API'), help_page_path('api/runners.md')
+- link = link_to _('Runner API'), help_page_path('api/runners.md')
 
-%h3
-  = _('Group Runners')
+%h4
+  = _('Group runners')
 
 .bs-callout.bs-callout-warning
-  = _('GitLab Group Runners can execute code for all the projects in this group.')
-  = _('They can be managed using the %{link}.').html_safe % { link: link }
+  = _('These runners are shared across projects in this group.')
+  %br
+  %br
+  = _('Group runners can be managed with the %{link}.').html_safe % { link: link }
 
   - if @project.group
-    %hr
+    %br
+    %br
     - if @project.group_runners_enabled?
       = link_to toggle_group_runners_project_runners_path(@project), class: 'btn btn-close', method: :post do
-        = _('Disable group Runners')
+        = _('Disable group runners')
     - else
       = link_to toggle_group_runners_project_runners_path(@project), class: 'btn btn-success btn-inverted', method: :post do
-        = _('Enable group Runners')
+        = _('Enable group runners')
      
     = _('for this project')
 
 - if !@project.group
-  = _('This project does not belong to a group and can therefore not make use of group Runners.')
+  = _('This project does not belong to a group and cannot make use of group runners.')
 
 - elsif @group_runners.empty?
-  = _('This group does not provide any group Runners yet.')
+  = _('This group does not have any group runners yet.')
 
   - if can?(current_user, :admin_pipeline, @project.group)
-    - group_link = link_to _('Group CI/CD settings'), group_settings_ci_cd_path(@project.group)
+    - group_link = link_to _("group's CI/CD settings."), group_settings_ci_cd_path(@project.group)
     = _('Group maintainers can register group runners in the %{link}').html_safe % { link: group_link }
   - else
-    = _('Ask your group maintainer to set up a group Runner.')
+    = _('Ask your group maintainer to set up a group runner.')
 
 - else
   %h4.underlined-title
-    = _('Available group Runners: %{runners}').html_safe % { runners: @group_runners.count }
+    = _('Available group runners: %{runners}').html_safe % { runners: @group_runners.count }
   %ul.bordered-list
     = render partial: 'projects/runners/runner', collection: @group_runners, as: :runner

app/views/projects/runners/_index.html.haml

 = render 'shared/runners/runner_description'
 
-%hr
-
-%p.lead= _('To start serving your jobs you can either add specific Runners to your project or use shared Runners')
 .row
   .col-sm-6
     = render 'projects/runners/specific_runners'

app/views/projects/runners/_runner.html.haml

@@ -23,7 +23,7 @@
         - else
           = link_to _('Resume'), resume_project_runner_path(@project, runner), method: :post, class: 'btn btn-success btn-sm'
         - if runner.belongs_to_one_project?
-          = link_to _('Remove Runner'), project_runner_path(@project, runner), data: { confirm: _("Are you sure?") }, method: :delete, class: 'btn btn-danger btn-sm'
+          = link_to _('Remove runner'), project_runner_path(@project, runner), data: { confirm: _("Are you sure?") }, method: :delete, class: 'btn btn-danger btn-sm'
         - else
           - runner_project = @project.runner_projects.find_by(runner_id: runner) # rubocop: disable CodeReuse/ActiveRecord
           = link_to _('Disable for this project'), project_runner_project_path(@project, runner_project), data: { confirm: _("Are you sure?") }, method: :delete, class: 'btn btn-danger btn-sm'

app/views/projects/runners/_shared_runners.html.haml

@@ -2,7 +2,8 @@
 
 = render layout: 'shared/runners/shared_runners_description' do
   - if !isVueifySharedRunnersToggleEnabled
-    %hr
+    %br
+    %br
     - if @project.group&.shared_runners_setting == 'disabled_and_unoverridable'
       %h5.gl-text-red-500
         = _('Shared runners disabled on group level')
@@ -19,8 +20,8 @@
   #toggle-shared-runners-form{ data: toggle_shared_runners_settings_data(@project) }
 
 - if @shared_runners_count == 0
-  = _('This GitLab instance does not provide any shared Runners yet. Instance administrators can register shared Runners in the admin area.')
+  = _('This GitLab instance does not provide any shared runners yet. Instance administrators can register shared runners in the admin area.')
 - else
-  %h4.underlined-title #{_('Available shared Runners:')} #{@shared_runners_count}
+  %h4.underlined-title #{_('Available shared runners:')} #{@shared_runners_count}
   %ul.bordered-list.available-shared-runners
     = render partial: 'projects/runners/runner', collection: @shared_runners, as: :runner

app/views/projects/runners/_specific_runners.html.haml

-%h3
-  = _('Specific Runners')
+%h4
+  = _('Specific runners')
 
 .bs-callout.help-callout
+  = _('These runners are specific to this project.')
+  %hr
   = render partial: 'ci/runner/how_to_setup_runner_automatically',
            locals: { type: 'specific',
                      clusters_path: project_clusters_path(@project) }
@@ -11,14 +13,16 @@
                      type: 'specific',
                      reset_token_url: reset_registration_token_namespace_project_settings_ci_cd_path }
 
+%hr
+
 - if @project_runners.any?
-  %h4.underlined-title= _('Runners activated for this project')
+  %h4.underlined-title= _('Available specific runners')
   %ul.bordered-list.activated-specific-runners
     = render partial: 'projects/runners/runner', collection: @project_runners, as: :runner
   = paginate @project_runners, theme: "gitlab", param_name: "project_page", params: { expand_runners: true, anchor: 'js-runners-settings' }
 
 - if @assignable_runners.any?
-  %h4.underlined-title= _('Available specific runners')
+  %h4.underlined-title= _('Other available runners')
   %ul.bordered-list.available-specific-runners
     = render partial: 'projects/runners/runner', collection: @assignable_runners, as: :runner
   = paginate @assignable_runners, theme: "gitlab", param_name: "specific_page", :params => { :anchor => 'js-runners-settings'}

app/views/projects/runners/edit.html.haml

-- page_title _('Edit'), "#{@runner.description} ##{@runner.id}", _('Runners')
+- page_title _('Edit'), "#{@runner.description} ##{@runner.id}", _('runners')
 
 %h4 Runner ##{@runner.id}
 

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

@@ -40,8 +40,8 @@
     %button.btn.js-settings-toggle{ type: 'button' }
       = expanded ? _('Collapse') : _('Expand')
     %p
-      = _("Runners are processes that pick up and execute jobs for GitLab. Here you can register and see your Runners for this project.")
-      = link_to s_('More information'), help_page_path('ci/runners/README')
+      = _("Runners are processes that pick up and execute CI/CD jobs for GitLab.")
+      = link_to s_('How do I configure runners?'), help_page_path('ci/runners/README')
   .settings-content
     = render 'projects/runners/index'
 

app/views/shared/runners/_form.html.haml

@@ -46,7 +46,7 @@
       = _('Tags')
     .col-sm-10
       = f.text_field :tag_list, value: runner.tag_list.sort.join(', '), class: 'form-control'
-      .form-text.text-muted= _('You can configure jobs to use runners that are assigned specific tags. Separate tags with commas.')
+      .form-text.text-muted= _('You can set up jobs to only use runners with specific tags. Separate tags with commas.')
   - if local_assigns[:in_gitlab_com_admin_context]
     .form-group.row
       = label_tag :public_projects_minutes_cost_factor, class: 'col-form-label col-sm-2' do

app/views/shared/runners/_runner_description.html.haml

 .light.gl-mt-3
   %p
-    = _("You can set up as many Runners as you need to run your jobs.")
-    %br
-    = _('Runners can be placed on separate users, servers, and even on your local machine.')
+    = _("Register as many runners as you want. You can register runners as separate users, on separate servers, and on your local machine. Runners are either:")
 
-  %p
-    = _('Each Runner can be in one of the following states:')
   %div
     %ul
       %li
         %span.badge.badge-success active
-        = _('- Runner is active and can process any new jobs')
+        = _('- Available to run jobs.')
       %li
         %span.badge.badge-danger paused
-        = _('- Runner is paused and will not receive any new jobs')
+        = _('- Not available to run jobs.')

app/views/shared/runners/_shared_runners_description.html.haml

 - link = link_to _('MaxBuilds'), 'https://docs.gitlab.com/runner/configuration/advanced-configuration.html#the-runnersmachine-section', target: '_blank'
 
-%h3
+%h4
   = _('Shared runners')
 
 .bs-callout.shared-runners-description
+  = _('These runners are shared across this GitLab instance.')
+  %p
   - if Gitlab::CurrentSettings.shared_runners_text.present?
     = markdown_field(Gitlab::CurrentSettings.current_application_settings, :shared_runners_text)
   - else

changelogs/unreleased/selhorn-runner-settings-okr.yml

+---
+title: Updated UI text to match style guidelines
+merge_request: 50403
+author:
+type: other

spec/features/admin/admin_runners_spec.rb

@@ -23,7 +23,7 @@ RSpec.describe "Admin Runners" do
         create(:ci_build, pipeline: pipeline, runner_id: runner.id)
         visit admin_runners_path
 
-        expect(page).to have_text "Set up a shared Runner manually"
+        expect(page).to have_text "Set up a shared runner manually"
         expect(page).to have_text "Runners currently online: 1"
       end
 
@@ -227,7 +227,7 @@ RSpec.describe "Admin Runners" do
       end
 
       it 'has all necessary texts including no runner message' do
-        expect(page).to have_text "Set up a shared Runner manually"
+        expect(page).to have_text "Set up a shared runner manually"
         expect(page).to have_text "Runners currently online: 0"
         expect(page).to have_text 'No runners found'
       end
@@ -389,7 +389,7 @@ RSpec.describe "Admin Runners" do
       let(:page_token) { find('#registration_token').text }
 
       before do
-        click_button 'Reset runners registration token'
+        click_button 'Reset registration token'
       end
 
       it 'changes registration token' do

spec/features/groups/settings/ci_cd_spec.rb

@@ -28,7 +28,7 @@ RSpec.describe 'Group CI/CD settings' do
       let(:page_token) { find('#registration_token').text }
 
       before do
-        click_button 'Reset runners registration token'
+        click_button 'Reset registration token'
       end
 
       it 'changes registration token' do

spec/features/projects/settings/pipelines_settings_spec.rb

@@ -183,7 +183,7 @@ RSpec.describe "Projects > Settings > Pipelines settings" do
         let(:page_token) { find('#registration_token').text }
 
         before do
-          click_button 'Reset runners registration token'
+          click_button 'Reset registration token'
         end
 
         it 'changes registration token' do

spec/features/runners_spec.rb

@@ -19,7 +19,7 @@ RSpec.describe 'Runners' do
     it 'user can see a button to install runners on kubernetes clusters' do
       visit project_runners_path(project)
 
-      expect(page).to have_link('Install Runner on Kubernetes', href: project_clusters_path(project))
+      expect(page).to have_link('Install GitLab Runner on Kubernetes', href: project_clusters_path(project))
     end
   end
 
@@ -69,7 +69,7 @@ RSpec.describe 'Runners' do
         visit project_runners_path(project)
 
         within '.activated-specific-runners' do
-          click_on 'Remove Runner'
+          click_on 'Remove runner'
         end
 
         expect(page).not_to have_content(specific_runner.display_name)
@@ -226,10 +226,10 @@ RSpec.describe 'Runners' do
         it 'group runners are not available' do
           visit project_runners_path(project)
 
-          expect(page).to have_content 'This group does not provide any group Runners yet'
+          expect(page).to have_content 'This group does not have any group runners yet.'
 
-          expect(page).to have_content 'Group maintainers can register group runners in the Group CI/CD settings'
-          expect(page).not_to have_content 'Ask your group maintainer to set up a group Runner'
+          expect(page).to have_content 'Group maintainers can register group runners in the group\'s CI/CD settings.'
+          expect(page).not_to have_content 'Ask your group maintainer to set up a group runner'
         end
       end
     end
@@ -241,7 +241,7 @@ RSpec.describe 'Runners' do
         it 'group runners are not available' do
           visit project_runners_path(project)
 
-          expect(page).to have_content 'This project does not belong to a group and can therefore not make use of group Runners.'
+          expect(page).to have_content 'This project does not belong to a group and cannot make use of group runners.'
         end
       end
 
@@ -252,10 +252,10 @@ RSpec.describe 'Runners' do
         it 'group runners are not available' do
           visit project_runners_path(project)
 
-          expect(page).to have_content 'This group does not provide any group Runners yet.'
+          expect(page).to have_content 'This group does not have any group runners yet.'
 
-          expect(page).not_to have_content 'Group maintainers can register group runners in the Group CI/CD settings'
-          expect(page).to have_content 'Ask your group maintainer to set up a group Runner.'
+          expect(page).not_to have_content 'Group maintainers can register group runners in the group\'s CI/CD settings.'
+          expect(page).to have_content 'Ask your group maintainer to set up a group runner.'
         end
       end
 
@@ -267,21 +267,21 @@ RSpec.describe 'Runners' do
         it 'group runners are available' do
           visit project_runners_path(project)
 
-          expect(page).to have_content 'Available group Runners: 1'
+          expect(page).to have_content 'Available group runners: 1'
           expect(page).to have_content 'group-runner'
         end
 
         it 'group runners may be disabled for a project' do
           visit project_runners_path(project)
 
-          click_on 'Disable group Runners'
+          click_on 'Disable group runners'
 
-          expect(page).to have_content 'Enable group Runners'
+          expect(page).to have_content 'Enable group runners'
           expect(project.reload.group_runners_enabled).to be false
 
-          click_on 'Enable group Runners'
+          click_on 'Enable group runners'
 
-          expect(page).to have_content 'Disable group Runners'
+          expect(page).to have_content 'Disable group runners'
           expect(project.reload.group_runners_enabled).to be true
         end
       end
@@ -305,7 +305,7 @@ RSpec.describe 'Runners' do
       it 'user can see a link to install runners on kubernetes clusters' do
         visit group_settings_ci_cd_path(group)
 
-        expect(page).to have_link('Install Runner on Kubernetes', href: group_clusters_path(group))
+        expect(page).to have_link('Install GitLab Runner on Kubernetes', href: group_clusters_path(group))
       end
     end
 
@@ -316,7 +316,7 @@ RSpec.describe 'Runners' do
         visit group_settings_ci_cd_path(group)
 
         expect(page).not_to have_content 'No runners found'
-        expect(page).to have_content 'Available Runners: 1'
+        expect(page).to have_content 'Available runners: 1'
         expect(page).to have_content 'group-runner'
       end
 
@@ -396,7 +396,7 @@ RSpec.describe 'Runners' do
         visit group_settings_ci_cd_path(group)
 
         expect(page).not_to have_content 'No runners found'
-        expect(page).to have_content 'Available Runners: 1'
+        expect(page).to have_content 'Available runners: 1'
         expect(page).to have_content 'project-runner'
       end