Merge branch 'russell/improve-email-settings-text' into 'master'

Improve email settings text

See merge request gitlab-org/gitlab!62867

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

@@ -8,20 +8,20 @@
         = f.label :email_author_in_body, class: 'form-check-label' do
           = _('Include author name in notification email body')
         .form-text.text-muted
-          = _('Some email servers do not support overriding the email sender name. Enable this option to include the name of the author of the issue, merge request or comment in the email body instead.')
+          = _("Include the name of the author of the issue, merge request or comment in the email body. By default, GitLab overrides the email sender's name. Some email servers don't support that option.")
     .form-group
       .form-check
         = f.check_box :html_emails_enabled, class: 'form-check-input'
         = f.label :html_emails_enabled, class: 'form-check-label' do
-          = _('Enable HTML emails')
+          = _('Enable multipart emails')
         .form-text.text-muted
-          = _('By default GitLab sends emails in HTML and plain text formats so mail clients can choose what format to use. Disable this option if you only want to send emails in plain text format.')
+          = _('Send email in multipart format (HTML and plain text). Uncheck to send email messages in plain text only.')
     .form-group
       = f.label :commit_email_hostname, _('Custom hostname (for private commit emails)'), class: 'label-bold'
       = f.text_field :commit_email_hostname, class: 'form-control gl-form-input'
       .form-text.text-muted
         - commit_email_hostname_docs_link = link_to _('Learn more'), help_page_path('user/admin_area/settings/email.md', anchor: 'custom-hostname-for-private-commit-emails'), target: '_blank'
-        = _("This setting will update the hostname that is used to generate private commit emails. %{learn_more}").html_safe % { learn_more: commit_email_hostname_docs_link }
+        = _("Hostname used in private commit emails. %{learn_more}").html_safe % { learn_more: commit_email_hostname_docs_link }
 
     = render_if_exists 'admin/application_settings/email_additional_text_setting', form: f
 
@@ -31,6 +31,6 @@
         = f.label :in_product_marketing_emails_enabled, class: 'form-check-label' do
           = _('Enable in-product marketing emails')
         .form-text.text-muted
-          = _('By default, GitLab sends emails to help guide users through the onboarding process.')
+          = _('Send emails to help guide new users through the onboarding process.')
 
   = f.submit _('Save changes'), class: "gl-button btn btn-confirm", data: { qa_selector: 'save_changes_button' }

doc/user/admin_area/settings/email.md

@@ -13,27 +13,40 @@ You can customize some of the content in emails sent from your GitLab instance.
 
 The logo in the header of some emails can be customized, see the [logo customization section](../appearance.md#navigation-bar).
 
-## Custom additional text **(PREMIUM SELF)**
+## Include author name in email notification email body **(PREMIUM SELF)**
 
-> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/5031) in [GitLab Premium](https://about.gitlab.com/pricing/) 10.7.
+By default, GitLab overrides the email address in notification emails with the email address
+of the issue, merge request, or comment author. Enable this setting to include the author's email
+address in the body of the email instead.
 
-The additional text appears at the bottom of any email and can be used for
-legal/auditing/compliance reasons.
+To include the author's email address in the email body:
 
 1. On the top bar, select **Menu >** **{admin}** **Admin**.
 1. On the left sidebar, select **Settings > Preferences** (`/admin/application_settings/preferences`).
 1. Expand **Email**.
-1. Enter your text in the **Additional text** field.
-1. Click **Save**.
+1. Select the **Include author name in email notification email body** checkbox.
+1. Select **Save changes**.
+
+## Enable multipart email **(PREMIUM SELF)**
+
+GitLab can send email in multipart format (HTML and plain text) or plain text only.
+
+To enable multipart email:
+
+1. On the top bar, select **Menu >** **{admin}** **Admin**.
+1. On the left sidebar, select **Settings > Preferences** (`/admin/application_settings/preferences`).
+1. Expand **Email**.
+1. Select **Enable multipart email**.
+1. Select **Save changes**.
 
-## Custom hostname for private commit emails
+## Custom hostname for private commit emails **(PREMIUM SELF)**
 
 > [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/22560) in GitLab 11.5.
 
 This configuration option sets the email hostname for [private commit emails](../../profile/index.md#use-an-automatically-generated-private-commit-email).
  By default it is set to `users.noreply.YOUR_CONFIGURED_HOSTNAME`.
 
-In order to change this option:
+To change the hostname used in private commit emails:
 
 1. On the top bar, select **Menu >** **{admin}** **Admin**.
 1. On the left sidebar, select **Settings > Preferences** (`/admin/application_settings/preferences`).
@@ -42,10 +55,23 @@ In order to change this option:
 1. Select **Save changes**.
 
 NOTE:
-After the hostname gets configured, every private commit email using the previous hostname is not
+After the hostname is configured, every private commit email using the previous hostname is not
 recognized by GitLab. This can directly conflict with certain [Push rules](../../../push_rules/push_rules.md) such as
 `Check whether author is a GitLab user` and `Check whether committer is the current authenticated user`.
 
+## Custom additional text **(PREMIUM SELF)**
+
+You can add additional text at the bottom of any email that GitLab sends. This additional text
+can be used for legal, auditing, or compliance reasons, for example.
+
+To add additional text to emails:
+
+1. On the top bar, select **Menu >** **{admin}** **Admin**.
+1. On the left sidebar, select **Settings > Preferences** (`/admin/application_settings/preferences`).
+1. Expand **Email**.
+1. Enter your text in the **Additional text** field.
+1. Select **Save changes**.
+
 <!-- ## Troubleshooting
 
 Include any troubleshooting steps that you can foresee. If you know beforehand what issues

ee/app/views/admin/application_settings/_email_additional_text_setting.html.haml

@@ -6,4 +6,4 @@
   = form.label :email_additional_text, _('Additional text'), class: 'label-bold'
   = form.text_area :email_additional_text, class: 'form-control gl-form-input', maxlength: Gitlab::CurrentSettings.email_additional_text_character_limit, rows: 4, data: { qa_selector: 'additional_text_textarea_field' }
   .form-text.text-muted
-    = _('Add additional text to appear in all email communications. %{character_limit} character limit') % { character_limit: number_with_delimiter(Gitlab::CurrentSettings.email_additional_text_character_limit) }
+    = _('Text added to the body of all email messages. %{character_limit} character limit') % { character_limit: number_with_delimiter(Gitlab::CurrentSettings.email_additional_text_character_limit) }

locale/gitlab.pot

@@ -1957,9 +1957,6 @@ msgstr ""
 msgid "Add a to do"
 msgstr ""
 
-msgid "Add additional text to appear in all email communications. %{character_limit} character limit"
-msgstr ""
-
 msgid "Add an SSH key"
 msgstr ""
 
@@ -5732,12 +5729,6 @@ msgstr ""
 msgid "By authenticating with an account tied to an Enterprise e-mail address, it is understood that this account is an Enterprise User. "
 msgstr ""
 
-msgid "By default GitLab sends emails in HTML and plain text formats so mail clients can choose what format to use. Disable this option if you only want to send emails in plain text format."
-msgstr ""
-
-msgid "By default, GitLab sends emails to help guide users through the onboarding process."
-msgstr ""
-
 msgid "By default, all projects and groups will use the global notifications setting."
 msgstr ""
 
@@ -12070,9 +12061,6 @@ msgstr ""
 msgid "Enable Gitpod?"
 msgstr ""
 
-msgid "Enable HTML emails"
-msgstr ""
-
 msgid "Enable Incident Management inbound alert limit"
 msgstr ""
 
@@ -12172,6 +12160,9 @@ msgstr ""
 msgid "Enable maintenance mode"
 msgstr ""
 
+msgid "Enable multipart emails"
+msgstr ""
+
 msgid "Enable or disable the Pseudonymizer data collection."
 msgstr ""
 
@@ -16274,6 +16265,9 @@ msgstr ""
 msgid "Hostname"
 msgstr ""
 
+msgid "Hostname used in private commit emails. %{learn_more}"
+msgstr ""
+
 msgid "Hour (UTC)"
 msgstr ""
 
@@ -17342,6 +17336,9 @@ msgstr ""
 msgid "Include new features from all tiers."
 msgstr ""
 
+msgid "Include the name of the author of the issue, merge request or comment in the email body. By default, GitLab overrides the email sender's name. Some email servers don't support that option."
+msgstr ""
+
 msgid "Include the username in the URL if required: %{code_open}https://username@gitlab.company.com/group/project.git%{code_close}."
 msgstr ""
 
@@ -29582,9 +29579,15 @@ msgstr ""
 msgid "Send email"
 msgstr ""
 
+msgid "Send email in multipart format (HTML and plain text). Uncheck to send email messages in plain text only."
+msgstr ""
+
 msgid "Send email notification"
 msgstr ""
 
+msgid "Send emails to help guide new users through the onboarding process."
+msgstr ""
+
 msgid "Send message"
 msgstr ""
 
@@ -30432,9 +30435,6 @@ msgstr ""
 msgid "Some common domains are not allowed. %{read_more_link}."
 msgstr ""
 
-msgid "Some email servers do not support overriding the email sender name. Enable this option to include the name of the author of the issue, merge request or comment in the email body instead."
-msgstr ""
-
 msgid "Some of the designs you tried uploading did not change:"
 msgstr ""
 
@@ -32372,6 +32372,9 @@ msgstr ""
 msgid "Tests"
 msgstr ""
 
+msgid "Text added to the body of all email messages. %{character_limit} character limit"
+msgstr ""
+
 msgid "Text style"
 msgstr ""
 
@@ -33717,9 +33720,6 @@ msgstr ""
 msgid "This setting requires a %{link_to_restart} to take effect."
 msgstr ""
 
-msgid "This setting will update the hostname that is used to generate private commit emails. %{learn_more}"
-msgstr ""
-
 msgid "This subscription is for"
 msgstr ""