Merge branch 'eread/refactor-webex-integration-settings-text' into 'master'

Refactor Webex Teams integration settings text

See merge request gitlab-org/gitlab!60565

app/models/project_services/webex_teams_service.rb

 # frozen_string_literal: true
 
 class WebexTeamsService < ChatNotificationService
+  include ActionView::Helpers::UrlHelper
+
   def title
-    'Webex Teams'
+    s_("WebexTeamsService|Webex Teams")
   end
 
   def description
-    'Receive event notifications in Webex Teams'
+    s_("WebexTeamsService|Send notifications about project events to Webex Teams.")
   end
 
   def self.to_param
@@ -14,13 +16,8 @@ class WebexTeamsService < ChatNotificationService
   end
 
   def help
-    'This service sends notifications about projects events to a Webex Teams conversation.<br />
-    To set up this service:
-    <ol>
-      <li><a href="https://apphub.webex.com/teams/applications/incoming-webhooks-cisco-systems">Set up an incoming webhook for your conversation</a>. All notifications will come to this conversation.</li>
-      <li>Paste the <strong>Webhook URL</strong> into the field below.</li>
-      <li>Select events below to enable notifications.</li>
-    </ol>'
+    docs_link = link_to _('Learn more.'), Rails.application.routes.url_helpers.help_page_url('user/project/integrations/webex_teams'), target: '_blank', rel: 'noopener noreferrer'
+    s_("WebexTeamsService|Send notifications about project events to a Webex Teams conversation. %{docs_link}") % { docs_link: docs_link.html_safe }
   end
 
   def event_field(event)
@@ -36,7 +33,7 @@ class WebexTeamsService < ChatNotificationService
 
   def default_fields
     [
-      { type: 'text', name: 'webhook', placeholder: "e.g. https://api.ciscospark.com/v1/webhooks/incoming/…", required: true },
+      { type: 'text', name: 'webhook', placeholder: "https://api.ciscospark.com/v1/webhooks/incoming/...", required: true },
       { type: 'checkbox', name: 'notify_only_broken_pipelines' },
       { type: 'select', name: 'branches_to_be_notified', choices: branch_choices }
     ]

changelogs/unreleased/eread-refactor-webex-integration-settings-text.yml

+---
+title: Refactor Webex Teams integration settings text
+merge_request: 60565
+author:
+type: other

doc/user/project/integrations/webex_teams.md

@@ -6,25 +6,32 @@ info: To determine the technical writer assigned to the Stage/Group associated w
 
 # Webex Teams service **(FREE)**
 
-You can configure GitLab to send notifications to a Webex Teams space.
+You can configure GitLab to send notifications to a Webex Teams space:
+
+1. Create a webhook for the space.
+1. Add the webhook to GitLab.
 
 ## Create a webhook for the space
 
 1. Go to the [Incoming Webhooks app page](https://apphub.webex.com/messaging/applications/incoming-webhooks-cisco-systems-38054).
-1. Click **Connect** and log in to Webex Teams, if required.
+1. Select **Connect** and log in to Webex Teams, if required.
 1. Enter a name for the webhook and select the space to receive the notifications.
-1. Click **ADD**.
+1. Select **ADD**.
 1. Copy the **Webhook URL**.
 
 ## Configure settings in GitLab
 
-Once you have a webhook URL for your Webex Teams space, you can configure GitLab to send notifications.
+Once you have a webhook URL for your Webex Teams space, you can configure GitLab to send
+notifications:
 
-1. Navigate to **Project > Settings > Integrations**.
+1. Navigate to:
+   - **Settings > Integrations** in a project to enable the integration at the project level.
+   - **Settings > Integrations** in a group to enable the integration at the group level.
+   - **Settings > Integrations** in the Admin Area (**{admin}**) to enable an instance-level integration.
 1. Select the **Webex Teams** integration.
 1. Ensure that the **Active** toggle is enabled.
 1. Select the checkboxes corresponding to the GitLab events you want to receive in Webex Teams.
 1. Paste the **Webhook** URL for the Webex Teams space.
 1. Configure the remaining options and then click **Test settings and save changes**.
 
-The Webex Teams space now begins to receive all applicable GitLab events.
+The Webex Teams space begins to receive all applicable GitLab events.

lib/api/helpers/services_helpers.rb

@@ -765,7 +765,7 @@ module API
               required: true,
               name: :webhook,
               type: String,
-              desc: 'The Webex Teams webhook. e.g. https://api.ciscospark.com/v1/webhooks/incoming/…'
+              desc: 'The Webex Teams webhook. For example, https://api.ciscospark.com/v1/webhooks/incoming/...'
             },
             chat_notification_events
           ].flatten

locale/gitlab.pot

@@ -35808,6 +35808,15 @@ msgstr ""
 msgid "WebIDE|You need permission to edit files directly in this project. Go to your fork to make changes and submit a merge request."
 msgstr ""
 
+msgid "WebexTeamsService|Send notifications about project events to Webex Teams."
+msgstr ""
+
+msgid "WebexTeamsService|Send notifications about project events to a Webex Teams conversation. %{docs_link}"
+msgstr ""
+
+msgid "WebexTeamsService|Webex Teams"
+msgstr ""
+
 msgid "Webhook"
 msgstr ""