Commit 458fccbc authored by Marcin Sedlak-Jakubowski's avatar Marcin Sedlak-Jakubowski Committed by Dylan Griffith

Review and revise Unify Circuit settings-related UI text

parent 0e3a3aa5
...@@ -15,13 +15,8 @@ module Integrations ...@@ -15,13 +15,8 @@ module Integrations
end end
def help def help
'This service sends notifications about projects events to a Unify Circuit conversation.<br /> docs_link = ActionController::Base.helpers.link_to _('How do I set up this service?'), Rails.application.routes.url_helpers.help_page_url('user/project/integrations/unify_circuit'), target: '_blank', rel: 'noopener noreferrer'
To set up this service: s_('Integrations|Send notifications about project events to a Unify Circuit conversation. %{docs_link}').html_safe % { docs_link: docs_link.html_safe }
<ol>
<li><a href="https://www.circuit.com/unifyportalfaqdetail?articleId=164448" target="_blank" rel="noopener noreferrer">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>'
end end
def event_field(event) def event_field(event)
...@@ -37,7 +32,7 @@ module Integrations ...@@ -37,7 +32,7 @@ module Integrations
def default_fields def default_fields
[ [
{ type: 'text', name: 'webhook', placeholder: "e.g. https://circuit.com/rest/v2/webhooks/incoming/…", required: true }, { type: 'text', name: 'webhook', placeholder: "https://yourcircuit.com/rest/v2/webhooks/incoming/…", required: true },
{ type: 'checkbox', name: 'notify_only_broken_pipelines' }, { type: 'checkbox', name: 'notify_only_broken_pipelines' },
{ type: 'select', name: 'branches_to_be_notified', choices: branch_choices } { type: 'select', name: 'branches_to_be_notified', choices: branch_choices }
] ]
......
...@@ -59,7 +59,7 @@ Click on the service links to see further configuration instructions and details ...@@ -59,7 +59,7 @@ Click on the service links to see further configuration instructions and details
| [Slack application](gitlab_slack_application.md) | Use Slack's official GitLab application. | **{dotted-circle}** No | | [Slack application](gitlab_slack_application.md) | Use Slack's official GitLab application. | **{dotted-circle}** No |
| [Slack notifications](slack.md) | Send notifications about project events to Slack. | **{dotted-circle}** No | | [Slack notifications](slack.md) | Send notifications about project events to Slack. | **{dotted-circle}** No |
| [Slack slash commands](slack_slash_commands.md) | Enable slash commands in workspace. | **{dotted-circle}** No | | [Slack slash commands](slack_slash_commands.md) | Enable slash commands in workspace. | **{dotted-circle}** No |
| [Unify Circuit](unify_circuit.md) | Receive events notifications. | **{dotted-circle}** No | | [Unify Circuit](unify_circuit.md) | Send notifications about project events to Unify Circuit. | **{dotted-circle}** No |
| [Webex Teams](webex_teams.md) | Receive events notifications. | **{dotted-circle}** No | | [Webex Teams](webex_teams.md) | Receive events notifications. | **{dotted-circle}** No |
| [YouTrack](youtrack.md) | Use YouTrack as the issue tracker. | **{dotted-circle}** No | | [YouTrack](youtrack.md) | Use YouTrack as the issue tracker. | **{dotted-circle}** No |
| [ZenTao](zentao.md) | Use ZenTao as the issue tracker. | **{dotted-circle}** No | | [ZenTao](zentao.md) | Use ZenTao as the issue tracker. | **{dotted-circle}** No |
......
...@@ -6,29 +6,22 @@ info: To determine the technical writer assigned to the Stage/Group associated w ...@@ -6,29 +6,22 @@ info: To determine the technical writer assigned to the Stage/Group associated w
# Unify Circuit service **(FREE)** # Unify Circuit service **(FREE)**
The Unify Circuit service sends notifications from GitLab to the conversation for which the webhook was created. The Unify Circuit service sends notifications from GitLab to a Circuit conversation.
## On Unify Circuit ## Set up Unify Circuit service
1. Open the conversation in which you want to see the notifications. In Unify Circuit, [add a webhook](https://www.circuit.com/unifyportalfaqdetail?articleId=164448) and
1. From the conversation menu, select **Configure Webhooks**. copy its URL.
1. Click **ADD WEBHOOK** and fill in the name of the bot to post the messages. Optionally
define an avatar.
1. Click **SAVE** and copy the **Webhook URL** of your webhook.
For more information, see the [Unify Circuit documentation for configuring incoming webhooks](https://www.circuit.com/unifyportalfaqdetail?articleId=164448). In GitLab:
## On GitLab 1. Go to the [Integrations page](overview.md#accessing-integrations) in your project's settings.
1. Select **Unify Circuit**.
When you have the **Webhook URL** for your Unify Circuit conversation webhook, you can set up the GitLab service. 1. Turn on the **Active** toggle.
1. Select the checkboxes corresponding to the GitLab events you want to receive in Unify Circuit.
1. Navigate to the [Integrations page](overview.md#accessing-integrations) in your project's settings, i.e. **Project > Settings > Integrations**.
1. Select the **Unify Circuit** integration to configure it.
1. Ensure that the **Active** toggle is enabled.
1. Check the checkboxes corresponding to the GitLab events you want to receive in Unify Circuit.
1. Paste the **Webhook URL** that you copied from the Unify Circuit configuration step. 1. Paste the **Webhook URL** that you copied from the Unify Circuit configuration step.
1. Configure the remaining options and click `Save changes`. 1. Select the **Notify only broken pipelines** checkbox to notify only on failures.
1. In the **Branches to be notified** dropdown, select which types of branches to send notifications for.
Your Unify Circuit conversation now starts receiving GitLab event notifications as configured. 1. Select `Save changes` or optionally select **Test settings**.
![Unify Circuit configuration](img/unify_circuit_configuration.png) Your Unify Circuit conversation now starts receiving GitLab event notifications.
...@@ -18241,6 +18241,9 @@ msgstr "" ...@@ -18241,6 +18241,9 @@ msgstr ""
msgid "Integrations|Send notifications about project events to Unify Circuit." msgid "Integrations|Send notifications about project events to Unify Circuit."
msgstr "" msgstr ""
msgid "Integrations|Send notifications about project events to a Unify Circuit conversation. %{docs_link}"
msgstr ""
msgid "Integrations|Sign in to add namespaces" msgid "Integrations|Sign in to add namespaces"
msgstr "" msgstr ""
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment