Merge branch 'russell-improve-ui-text-help-preferences' into 'master'

Improve UI text for Help page preferences

See merge request gitlab-org/gitlab!64836

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

@@ -5,18 +5,18 @@
     = render_if_exists 'admin/application_settings/help_text_setting', form: f
 
     .form-group
-      = f.label :help_page_text, class: 'label-bold'
+      = f.label :help_page_text, _('Additional text to show on the Help page'), class: 'label-bold'
       = f.text_area :help_page_text, class: 'form-control gl-form-input', rows: 4
       .form-text.text-muted= _('Markdown enabled')
     .form-group
       .form-check
         = f.check_box :help_page_hide_commercial_content, class: 'form-check-input'
         = f.label :help_page_hide_commercial_content, class: 'form-check-label' do
-          = _('Hide marketing-related entries from help')
+          = _('Hide marketing-related entries from the Help page.')
     .form-group
       = f.label :help_page_support_url, _('Support page URL'), class: 'label-bold'
       = f.text_field :help_page_support_url, class: 'form-control gl-form-input', placeholder: 'http://company.example.com/getting-help', :'aria-describedby' => 'support_help_block'
-      %span.form-text.text-muted#support_help_block= _('Alternate support URL for help page and help dropdown')
+      %span.form-text.text-muted#support_help_block= _('Alternate support URL for Help page and Help dropdown')
 
     - if show_documentation_base_url_field?
       .form-group

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

@@ -27,11 +27,12 @@
 %section.settings.as-help-page.no-animate#js-help-settings{ class: ('expanded' if expanded_by_default?) }
   .settings-header
     %h4
-      = _('Help page')
+      = _('Sign-in and Help page')
     %button.btn.gl-button.btn-default.js-settings-toggle{ type: 'button' }
       = expanded_by_default? ? _('Collapse') : _('Expand')
     %p
-      = _('Help page text and support page url.')
+      = _('Additional text for the sign-in and Help page.')
+      = link_to s_('Learn more.'), help_page_path('user/admin_area/settings/help_page.md'), target: '_blank', rel: 'noopener noreferrer'
   .settings-content
     = render 'help_page'
 

app/views/help/index.html.haml

@@ -38,7 +38,7 @@
       .card-header
         = _('Quick help')
       %ul.content-list
-        %li= link_to _('See our website for getting help'), support_url
+        %li= link_to _('See our website for help'), support_url
         %li
           %button.btn-blank.btn-link.js-trigger-search-bar{ type: 'button' }
             = _('Use the search bar on the top of this page')

doc/subscriptions/bronze_starter.md

@@ -16,7 +16,7 @@ The following features remain available to Bronze and Starter customers, even th
 the tiers are no longer mentioned in GitLab documentation:
 
 - [Activate GitLab EE with a license](../user/admin_area/license.md)
-- [Adding a help message to the login page](../user/admin_area/settings/help_page.md#adding-a-help-message-to-the-login-page)
+- [Add a help message to the sign-in page](../user/admin_area/settings/help_page.md#add-a-help-message-to-the-sign-in-page)
 - [Burndown and burnup charts](../user/project/milestones/burndown_and_burnup_charts.md),
   including [per-project charts](../user/project/milestones/index.md#project-burndown-charts) and
   [per-group charts](../user/project/milestones/index.md#group-burndown-charts)

doc/user/admin_area/settings/help_page.md

@@ -5,41 +5,58 @@ info: To determine the technical writer assigned to the Stage/Group associated w
 type: howto
 ---
 
-# Customizing the 'Help' and login page messages
+# Customize the Help and sign-in page messages
 
 In large organizations, it is useful to have information about who to contact or where
-to go for help. You can customize and display this information on the GitLab server's
-`/help` page and on the GitLab login page.
+to go for help. You can customize and display this information on the GitLab  `/help` page and on
+the GitLab sign-in page.
 
-## Adding a help message to the help page
+## Add a help message to the Help page
 
-You can add a help message, which is shown on the GitLab `/help` page (for example,
-<https://gitlab.com/help>) in a new section at the top of the `/help` page:
+You can add a help message, which is shown at the top of the GitLab `/help` page (for example,
+<https://gitlab.com/help>):
 
 1. On the top bar, select **Menu >** **{admin}** **Admin**.
 1. In the left sidebar, select **Settings > Preferences**, then expand **Help page**.
-1. Under **Help page text**, fill in the information you wish to display on `/help`.
-1. Save your changes. You can now see the message on `/help`.
+1. Under **Additional text to show on the Help page**, fill in the information you wish to display on `/help`.
+1. Select **Save changes**. You can now see the message on `/help`.
 
 NOTE:
 By default, `/help` is visible to unauthenticated users. However, if the
 [**Public** visibility level](visibility_and_access_controls.md#restricted-visibility-levels)
 is restricted, `/help` is visible only to signed-in users.
 
-## Adding a help message to the login page **(STARTER)**
+## Add a help message to the sign-in page **(STARTER)**
 
-You can add a help message, which is shown on the GitLab login page in a new section
-titled `Need Help?`, located below the login page message:
+You can add a help message, which is shown on the GitLab sign-in page. The message appears in a new
+section titled **Need Help?**, located below the sign-in page message:
 
 1. On the top bar, select **Menu >** **{admin}** **Admin**.
 1. In the left sidebar, select **Settings > Preferences**, then expand **Help page**.
-1. Under **Help text**, fill in the information you wish to display on the login page.
+1. Under **Additional text to show on the sign-in page**, fill in the information you wish to
+   display on the sign-in page.
+1. Select **Save changes**. You can now see the message on the sign-in page.
 
-   ![help message on login page](img/help_page_help_text_v12_3.png)
+## Hide marketing-related entries from the Help page
 
-1. Save your changes.
+GitLab marketing-related entries are occasionally shown on the Help page. To hide these entries:
 
-![help message on login page example](img/help_page_help_text_ex_v12_3.png)
+1. On the top bar, select **Menu >** **{admin}** **Admin**.
+1. In the left sidebar, select **Settings > Preferences**, then expand **Help page**.
+1. Select the **Hide marketing-related entries from the Help page** checkbox.
+1. Select **Save changes**.
+
+## Set a custom Support page URL
+
+You can specify a custom URL to which users are directed when they:
+
+- Select **Support** from the Help dropdown.
+- Select **See our website for help** on the Help page.
+
+1. On the top bar, select **Menu >** **{admin}** **Admin**.
+1. In the left sidebar, select **Settings > Preferences**, then expand **Help page**.
+1. Enter the URL in the **Support page URL** field.
+1. Select **Save changes**.
 
 <!-- ## Troubleshooting
 

ee/app/views/admin/application_settings/_help_text_setting.haml

 - form = local_assigns.fetch(:form)
 
 .form-group
-  = form.label :help_text, class: 'label-bold'
+  = form.label :help_text, _('Additional text to show on the sign-in page'), class: 'label-bold'
   = form.text_area :help_text, class: 'form-control gl-form-input', rows: 4
   .form-text.text-muted= _('Markdown enabled')

locale/gitlab.pot

@@ -2188,6 +2188,15 @@ msgstr ""
 msgid "Additional text"
 msgstr ""
 
+msgid "Additional text for the sign-in and Help page."
+msgstr ""
+
+msgid "Additional text to show on the Help page"
+msgstr ""
+
+msgid "Additional text to show on the sign-in page"
+msgstr ""
+
 msgid "Address"
 msgstr ""
 
@@ -3459,7 +3468,7 @@ msgstr ""
 msgid "Also unassign this user from related issues and merge requests"
 msgstr ""
 
-msgid "Alternate support URL for help page and help dropdown"
+msgid "Alternate support URL for Help page and Help dropdown"
 msgstr ""
 
 msgid "Alternatively, you can convert your account to a managed account by the %{group_name} group."
@@ -16183,12 +16192,6 @@ msgstr ""
 msgid "Help"
 msgstr ""
 
-msgid "Help page"
-msgstr ""
-
-msgid "Help page text and support page url."
-msgstr ""
-
 msgid "Helps prevent bots from brute-force attacks."
 msgstr ""
 
@@ -16248,7 +16251,7 @@ msgstr ""
 msgid "Hide list"
 msgstr ""
 
-msgid "Hide marketing-related entries from help"
+msgid "Hide marketing-related entries from the Help page."
 msgstr ""
 
 msgid "Hide payload"
@@ -29408,7 +29411,7 @@ msgstr ""
 msgid "See metrics"
 msgstr ""
 
-msgid "See our website for getting help"
+msgid "See our website for help"
 msgstr ""
 
 msgid "See the affected projects in the GitLab admin panel"
@@ -30330,6 +30333,9 @@ msgstr ""
 msgid "Sign up was successful! Please confirm your email to sign in."
 msgstr ""
 
+msgid "Sign-in and Help page"
+msgstr ""
+
 msgid "Sign-in count:"
 msgstr ""
 

spec/features/admin/admin_settings_spec.rb

@@ -571,8 +571,8 @@ RSpec.describe 'Admin updates settings' do
         new_documentation_url = 'https://docs.gitlab.com'
 
         page.within('.as-help-page') do
-          fill_in 'Help page text', with: 'Example text'
-          check 'Hide marketing-related entries from help'
+          fill_in 'Additional text to show on the Help page', with: 'Example text'
+          check 'Hide marketing-related entries from the Help page.'
           fill_in 'Support page URL', with: new_support_url
           fill_in 'Documentation pages URL', with: new_documentation_url
           click_button 'Save changes'

spec/features/help_pages_spec.rb

@@ -65,7 +65,7 @@ RSpec.describe 'Help Pages' do
     end
 
     it 'uses a custom support url' do
-      expect(page).to have_link "See our website for getting help", href: "http://example.com/help"
+      expect(page).to have_link "See our website for help", href: "http://example.com/help"
     end
   end
 end