Improve UI text - deploy keys

- Improve UI text - deploy keys - shared

- Add changelog UI text

- TW review - wording and syntax

- Update translations gitlab.pot

- Update spec files - deploy keys

- Update component - deploy keys

- Update docs - deploy keys

- Update empty_state view

- Make text translatable

app/assets/javascripts/deploy_keys/components/key.vue

@@ -97,7 +97,7 @@ export default {
   methods: {
     projectTooltipTitle(project) {
       return project.can_push
-        ? s__('DeployKeys|Write access allowed')
+        ? s__('DeployKeys|Grant write permissions to this key')
         : s__('DeployKeys|Read access only');
     },
     toggleExpanded() {

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

@@ -15,7 +15,7 @@
       %p.light
         - link_start = "<a href='#{help_page_path('ssh/README')}' target='_blank' rel='noreferrer noopener'>".html_safe
         - link_end = '</a>'
-        = _('Paste a machine public key here. Read more about how to generate it %{link_start}here%{link_end}').html_safe % { link_start: link_start, link_end: link_end.html_safe }
+        = _('Paste a public key here. %{link_start}How do I generate it?%{link_end}').html_safe % { link_start: link_start, link_end: link_end.html_safe }
       = form.text_area :key, class: 'form-control gl-form-input thin_area', rows: 5
   - else
     = form.label :fingerprint, class: 'col-form-label col-sm-2'
@@ -29,6 +29,6 @@
       .col-sm-10
         = deploy_keys_project_form.label :can_push do
           = deploy_keys_project_form.check_box :can_push
-          %strong= _('Write access allowed')
+          %strong= _('Grant write permissions to this key')
         %p.light.gl-mb-0
-          = _('Allow this key to push to repository as well? (Default only allows pull access.)')
+          = _('Allow this key to push to this repository')

app/views/shared/deploy_keys/_index.html.haml

@@ -5,10 +5,10 @@
     %button.btn.js-settings-toggle{ type: 'button' }
       = expanded ? 'Collapse' : 'Expand'
     %p
-      = _('Deploy keys allow read-only or read-write (if enabled) access to your repository. Deploy keys can be used for CI, staging or production servers. You can create a deploy key or add an existing one.')
+      - link_start = '<a href="%{url}" target="_blank" rel="noopener noreferrer">'.html_safe % { url: help_page_path('user/project/deploy_keys/index') }
+      = _("Add deploy keys to grant read/write access to this repository. %{link_start}What are Deploy Keys?%{link_end}").html_safe % { link_start: link_start, link_end: '</a>'.html_safe }
   .settings-content
     %h5.gl-mt-0
-      = _('Create a new deploy key for this project')
     = render @deploy_keys.form_partial_path
     %hr
     #js-deploy-keys{ data: { endpoint: project_deploy_keys_path(@project), project_id: @project.id } }

app/views/shared/deploy_keys/_project_group_form.html.haml

@@ -8,17 +8,17 @@
     = f.text_area :key, class: 'form-control gl-form-input', rows: 5, required: true
   .form-group.row
     %p.light.gl-mb-0
-      = _('Paste a machine public key here. Read more about how to generate it')
-      = link_to "here", help_page_path("ssh/README")
+      = _('Paste a public key here.')
+      = link_to _('How do I generate it?'), help_page_path("ssh/README")
 
   = f.fields_for :deploy_keys_projects do |deploy_keys_project_form|
     .form-group.row
       = deploy_keys_project_form.label :can_push do
         = deploy_keys_project_form.check_box :can_push
-        %strong= _('Write access allowed')
+        %strong= _('Grant write permissions to this key')
     .form-group.row
       %p.light.gl-mb-0
-        = _('Allow this key to push to repository as well? (Default only allows pull access.)')
+        = _('Allow this key to push to this repository')
 
   .form-group.row
     = f.submit _("Add key"), class: "btn-success btn"

app/views/shared/empty_states/_deploy_keys.html.haml

@@ -4,6 +4,6 @@
       = image_tag 'illustrations/empty-state/empty-deploy-keys-lg.svg'
   .gl-flex-grow-0.gl-flex-shrink-0
     .text-content.gl-mx-auto.gl-my-0.gl-p-5
-      %h4.h4= _('Deploy keys allow read-only or read-write (if enabled) access to your repository')
-      %p= _('Deploy keys can be used for CI, staging or production servers. You can create a deploy key or add an existing one.')
+      %h4.h4= _('Deploy Keys')
+      %p= _('Deploy keys grant read/write access to all repositories in your instance')
       = link_to _('New deploy key'), new_admin_deploy_key_path, class: 'btn btn-success btn-md gl-button'

changelogs/unreleased/docs-ui-text-settings-deploy-keys.yml

+---
+title: Review UI text - deploy keys settings
+merge_request: 52830
+author:
+type: other

doc/user/project/deploy_keys/index.md

@@ -7,10 +7,10 @@ type: howto, reference
 
 # Deploy Keys
 
-Deploy keys allow read-only or read-write (if enabled) access to one or
-more repositories, by importing an SSH public key to your GitLab instance.
+Deploy keys allow read-only or read-write access to your
+repositories by importing an SSH public key into your GitLab instance.
 
-This is useful for cloning repositories to your Continuous
+This is useful, for example, for cloning repositories to your Continuous
 Integration (CI) server. By using deploy keys, you don't have to set up a
 fake user account.
 
@@ -82,7 +82,7 @@ can add or enable a deploy key for a project repository:
 1. Navigate to the project's **Settings > Repository** page.
 1. Expand the **Deploy Keys** section.
 1. Specify a title for the new deploy key and paste your public SSH key.
-1. (Optional) Check **Write access allowed** to allow `read-write` access. Leave it unchecked for `read-only` access.
+1. (Optional) Check **Grant write permissions to this key** to allow `read-write` access. Leave it unchecked for `read-only` access.
 
 There are three lists of Project Deploy Keys:
 

locale/gitlab.pot

@@ -1713,6 +1713,9 @@ msgstr ""
 msgid "Add deploy freeze"
 msgstr ""
 
+msgid "Add deploy keys to grant read/write access to this repository. %{link_start}What are Deploy Keys?%{link_end}"
+msgstr ""
+
 msgid "Add domain"
 msgstr ""
 
@@ -2951,7 +2954,7 @@ msgstr ""
 msgid "Allow subgroups to set up their own two-factor authentication rules"
 msgstr ""
 
-msgid "Allow this key to push to repository as well? (Default only allows pull access.)"
+msgid "Allow this key to push to this repository"
 msgstr ""
 
 msgid "Allow this secondary node to replicate content on Object Storage"
@@ -8242,9 +8245,6 @@ msgstr ""
 msgid "Create a new branch"
 msgstr ""
 
-msgid "Create a new deploy key for this project"
-msgstr ""
-
 msgid "Create a new file as there are no files yet. Afterwards, you'll be able to commit your changes."
 msgstr ""
 
@@ -9600,13 +9600,7 @@ msgstr ""
 msgid "Deploy key was successfully updated."
 msgstr ""
 
-msgid "Deploy keys allow read-only or read-write (if enabled) access to your repository"
-msgstr ""
-
-msgid "Deploy keys allow read-only or read-write (if enabled) access to your repository. Deploy keys can be used for CI, staging or production servers. You can create a deploy key or add an existing one."
-msgstr ""
-
-msgid "Deploy keys can be used for CI, staging or production servers. You can create a deploy key or add an existing one."
+msgid "Deploy keys grant read/write access to all repositories in your instance"
 msgstr ""
 
 msgid "Deploy progress not found. To see pods, ensure your environment matches %{linkStart}deploy board criteria%{linkEnd}."
@@ -9657,6 +9651,9 @@ msgstr ""
 msgid "DeployKeys|Expand %{count} other projects"
 msgstr ""
 
+msgid "DeployKeys|Grant write permissions to this key"
+msgstr ""
+
 msgid "DeployKeys|Loading deploy keys"
 msgstr ""
 
@@ -9675,9 +9672,6 @@ msgstr ""
 msgid "DeployKeys|Read access only"
 msgstr ""
 
-msgid "DeployKeys|Write access allowed"
-msgstr ""
-
 msgid "DeployKeys|You are going to remove this deploy key. Are you sure?"
 msgstr ""
 
@@ -13774,6 +13768,9 @@ msgstr ""
 msgid "Grant access"
 msgstr ""
 
+msgid "Grant write permissions to this key"
+msgstr ""
+
 msgid "Graph"
 msgstr ""
 
@@ -14624,6 +14621,9 @@ msgstr ""
 msgid "How do I configure runners?"
 msgstr ""
 
+msgid "How do I generate it?"
+msgstr ""
+
 msgid "How do I mirror repositories?"
 msgstr ""
 
@@ -21128,10 +21128,10 @@ msgstr ""
 msgid "Past due"
 msgstr ""
 
-msgid "Paste a machine public key here. Read more about how to generate it"
+msgid "Paste a public key here."
 msgstr ""
 
-msgid "Paste a machine public key here. Read more about how to generate it %{link_start}here%{link_end}"
+msgid "Paste a public key here. %{link_start}How do I generate it?%{link_end}"
 msgstr ""
 
 msgid "Paste confidential epic link"
@@ -32841,9 +32841,6 @@ msgstr ""
 msgid "Write a comment…"
 msgstr ""
 
-msgid "Write access allowed"
-msgstr ""
-
 msgid "Write milestone description..."
 msgstr ""
 

spec/features/projects/settings/repository_settings_spec.rb

@@ -63,7 +63,7 @@ RSpec.describe 'Projects > Settings > Repository settings' do
         click_button 'Add key'
 
         expect(page).to have_content('new_deploy_key')
-        expect(page).to have_content('Write access allowed')
+        expect(page).to have_content('Grant write permissions to this key')
       end
 
       it 'edit an existing deploy key' do
@@ -77,7 +77,7 @@ RSpec.describe 'Projects > Settings > Repository settings' do
         click_button 'Save changes'
 
         expect(page).to have_content('updated_deploy_key')
-        expect(page).to have_content('Write access allowed')
+        expect(page).to have_content('Grant write permissions to this key')
       end
 
       it 'edit an existing public deploy key to be writable' do
@@ -90,7 +90,7 @@ RSpec.describe 'Projects > Settings > Repository settings' do
         click_button 'Save changes'
 
         expect(page).to have_content('public_deploy_key')
-        expect(page).to have_content('Write access allowed')
+        expect(page).to have_content('Grant write permissions to this key')
       end
 
       it 'edit a deploy key from projects user has access to' do

spec/frontend/deploy_keys/components/key_spec.js

@@ -76,7 +76,7 @@ describe('Deploy keys key', () => {
       createComponent({ deployKey: { ...deployKey, deploy_keys_projects: deployKeysProjects } });
 
       expect(wrapper.find('.deploy-project-label').attributes('title')).toBe(
-        'Write access allowed',
+        'Grant write permissions to this key',
       );
     });