Commit c8e87fc5 authored by Amy Qualls's avatar Amy Qualls

Revise documentation page, remove image

Before cross-linking to this page, I needed to clean up the
subheadings to bring them up to GitLab style standards. I rewrote
most of the page to get it up to our standards, and deleted an image
we really don't need.
parent 0cbec247
...@@ -4,29 +4,29 @@ module ServicesHelper ...@@ -4,29 +4,29 @@ module ServicesHelper
def service_event_description(event) def service_event_description(event)
case event case event
when "push", "push_events" when "push", "push_events"
s_("ProjectService|Event will be triggered by a push to the repository") s_("ProjectService|Event triggered when someone pushes to the repository.")
when "tag_push", "tag_push_events" when "tag_push", "tag_push_events"
s_("ProjectService|Event will be triggered when a new tag is pushed to the repository") s_("ProjectService|Event triggered when a new tag is pushed to the repository.")
when "note", "note_events" when "note", "note_events"
s_("ProjectService|Event will be triggered when someone adds a comment") s_("ProjectService|Event triggered when someone adds a comment.")
when "confidential_note", "confidential_note_events" when "confidential_note", "confidential_note_events"
s_("ProjectService|Event will be triggered when someone adds a comment on a confidential issue") s_("ProjectService|Event triggered when someone adds a comment on a confidential issue.")
when "issue", "issue_events" when "issue", "issue_events"
s_("ProjectService|Event will be triggered when an issue is created/updated/closed") s_("ProjectService|Event triggered when an issue is created, updated, or closed.")
when "confidential_issue", "confidential_issue_events" when "confidential_issue", "confidential_issue_events"
s_("ProjectService|Event will be triggered when a confidential issue is created/updated/closed") s_("ProjectService|Event triggered when a confidential issue is created, updated, or closed.")
when "merge_request", "merge_request_events" when "merge_request", "merge_request_events"
s_("ProjectService|Event will be triggered when a merge request is created/updated/merged") s_("ProjectService|Event triggered when a merge request is created, updated, or merged.")
when "pipeline", "pipeline_events" when "pipeline", "pipeline_events"
s_("ProjectService|Event will be triggered when a pipeline status changes") s_("ProjectService|Event triggered when a pipeline status changes.")
when "wiki_page", "wiki_page_events" when "wiki_page", "wiki_page_events"
s_("ProjectService|Event will be triggered when a wiki page is created/updated") s_("ProjectService|Event triggered when a wiki page is created or updated.")
when "commit", "commit_events" when "commit", "commit_events"
s_("ProjectService|Event will be triggered when a commit is created/updated") s_("ProjectService|Event triggered when a commit is created or updated.")
when "deployment" when "deployment"
s_("ProjectService|Event will be triggered when a deployment starts or finishes") s_("ProjectService|Event triggered when a deployment starts or finishes.")
when "alert" when "alert"
s_("ProjectService|Event will be triggered when a new, unique alert is recorded") s_("ProjectService|Event triggered when a new, unique alert is recorded.")
end end
end end
......
...@@ -2,7 +2,7 @@ ...@@ -2,7 +2,7 @@
class MicrosoftTeamsService < ChatNotificationService class MicrosoftTeamsService < ChatNotificationService
def title def title
'Microsoft Teams Notification' 'Microsoft Teams notifications'
end end
def description def description
...@@ -14,13 +14,7 @@ class MicrosoftTeamsService < ChatNotificationService ...@@ -14,13 +14,7 @@ class MicrosoftTeamsService < ChatNotificationService
end end
def help def help
'This service sends notifications about projects events to Microsoft Teams channels.<br /> '<p>Use this service to send notifications about events in GitLab projects to your Microsoft Teams channels. <a href="https://docs.gitlab.com/ee/user/project/integrations/microsoft_teams.html">How do I configure this integration?</a></p>'
To set up this service:
<ol>
<li><a href="https://docs.microsoft.com/en-us/microsoftteams/platform/concepts/connectors/connectors-using#setting-up-a-custom-incoming-webhook">Setup a custom Incoming Webhook using Office 365 Connectors For Microsoft Teams</a>.</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 webhook_placeholder def webhook_placeholder
...@@ -40,8 +34,8 @@ class MicrosoftTeamsService < ChatNotificationService ...@@ -40,8 +34,8 @@ class MicrosoftTeamsService < ChatNotificationService
def default_fields def default_fields
[ [
{ type: 'text', name: 'webhook', placeholder: "e.g. #{webhook_placeholder}" }, { type: 'text', name: 'webhook', placeholder: "#{webhook_placeholder}" },
{ type: 'checkbox', name: 'notify_only_broken_pipelines' }, { type: 'checkbox', name: 'notify_only_broken_pipelines', help: 'If selected, successful pipelines do not trigger a notification event.' },
{ type: 'select', name: 'branches_to_be_notified', choices: branch_choices } { type: 'select', name: 'branches_to_be_notified', choices: branch_choices }
] ]
end end
......
...@@ -6,49 +6,55 @@ info: To determine the technical writer assigned to the Stage/Group associated w ...@@ -6,49 +6,55 @@ info: To determine the technical writer assigned to the Stage/Group associated w
# Microsoft Teams service **(FREE)** # Microsoft Teams service **(FREE)**
## On Microsoft Teams You can integrate Microsoft Teams with GitLab, and display notifications about GitLab projects
in Microsoft Teams. To integrate the services, you must:
To enable Microsoft Teams integration you must create an incoming webhook integration on Microsoft 1. [Configure Microsoft Teams](#configure-microsoft-teams) to enable a webhook
Teams by following the steps below: to listen for changes.
1. [Configure your GitLab project](#configure-your-gitlab-project) to push notifications
to the Microsoft Teams webhook.
1. Search for "incoming webhook" on the search bar in Microsoft Teams and select the ## Configure Microsoft Teams
**Incoming Webhook** item.
To configure Microsoft Teams to listen for notifications from GitLab:
1. In Microsoft Teams, search for "incoming webhook" in the search bar, and select the
**Incoming Webhook** item:
![Select Incoming Webhook](img/microsoft_teams_select_incoming_webhook.png) ![Select Incoming Webhook](img/microsoft_teams_select_incoming_webhook.png)
1. Click the **Add to a team** button. 1. Select **Add to a team**.
1. Select the team and channel you want to add the integration to. 1. Select the team and channel you want to add the integration to.
1. Add a name for the webhook. The name is displayed next to every message that 1. Add a name for the webhook. The name is displayed next to every message that
comes in through the webhook. comes in through the webhook.
1. Copy the webhook URL for the next steps. 1. Copy the webhook URL, as you need it to configure GitLab.
Learn more about ## Configure your GitLab project
[setting up an incoming webhook on Microsoft Teams](https://docs.microsoft.com/en-us/microsoftteams/platform/webhooks-and-connectors/how-to/connectors-using#setting-up-a-custom-incoming-webhook).
After you configure Microsoft Teams to receive notifications, you must configure
## On GitLab GitLab to send the notifications:
After you set up Microsoft Teams, it's time to set up GitLab. 1. Sign in to GitLab as a user with [Administrator](../../permissions.md) and go
to your project's page.
Navigate to the [Integrations page](overview.md#accessing-integrations) 1. Go to **Settings > Integrations** and select **Microsoft Teams Notification**.
and select the **Microsoft Teams Notification** service to configure it. 1. Select **Active** to enable the integration.
There, you see a checkbox with the following events that can be triggered: 1. Select the check box next to each **Trigger** to enable:
- Push
- Push - Issue
- Issue - Confidential issue
- Confidential issue - Merge request
- Merge request - Note
- Note - Confidential note
- Tag push - Tag push
- Pipeline - Pipeline - If you enable this trigger, you can also select **Notify only broken pipelines** to be notified only about failed pipelines.
- Wiki page - Wiki page
1. In **Webhook**, paste the URL you copied when you
At the end fill in your Microsoft Teams details: [configured Microsoft Teams](#configure-microsoft-teams).
1. (Optional) If you enabled the pipeline trigger, you can select the
| Field | Description | **Notify only broken pipelines** check box to push notifications only when pipelines break.
| ----- | ----------- | 1. Select the branches you want to send notifications for.
| **Webhook** | The incoming webhook URL which you have to set up on Microsoft Teams. | 1. Click **Save changes**.
| **Notify only broken pipelines** | If you choose to enable the **Pipeline** event and you want to be only notified about failed pipelines. |
## Resources
After you are all done, click **Save changes** for the changes to take effect.
- [Setting up an incoming webhook on Microsoft Teams](https://docs.microsoft.com/en-us/microsoftteams/platform/webhooks-and-connectors/how-to/connectors-using#setting-up-a-custom-incoming-webhook).
![Microsoft Teams configuration](img/microsoft_teams_configuration.png)
...@@ -23984,40 +23984,40 @@ msgstr "" ...@@ -23984,40 +23984,40 @@ msgstr ""
msgid "ProjectService|Enter new password" msgid "ProjectService|Enter new password"
msgstr "" msgstr ""
msgid "ProjectService|Event will be triggered by a push to the repository" msgid "ProjectService|Event triggered when a commit is created or updated."
msgstr "" msgstr ""
msgid "ProjectService|Event will be triggered when a commit is created/updated" msgid "ProjectService|Event triggered when a confidential issue is created, updated, or closed."
msgstr "" msgstr ""
msgid "ProjectService|Event will be triggered when a confidential issue is created/updated/closed" msgid "ProjectService|Event triggered when a deployment starts or finishes."
msgstr "" msgstr ""
msgid "ProjectService|Event will be triggered when a deployment starts or finishes" msgid "ProjectService|Event triggered when a merge request is created, updated, or merged."
msgstr "" msgstr ""
msgid "ProjectService|Event will be triggered when a merge request is created/updated/merged" msgid "ProjectService|Event triggered when a new tag is pushed to the repository."
msgstr "" msgstr ""
msgid "ProjectService|Event will be triggered when a new tag is pushed to the repository" msgid "ProjectService|Event triggered when a new, unique alert is recorded."
msgstr "" msgstr ""
msgid "ProjectService|Event will be triggered when a new, unique alert is recorded" msgid "ProjectService|Event triggered when a pipeline status changes."
msgstr "" msgstr ""
msgid "ProjectService|Event will be triggered when a pipeline status changes" msgid "ProjectService|Event triggered when a wiki page is created or updated."
msgstr "" msgstr ""
msgid "ProjectService|Event will be triggered when a wiki page is created/updated" msgid "ProjectService|Event triggered when an issue is created, updated, or closed."
msgstr "" msgstr ""
msgid "ProjectService|Event will be triggered when an issue is created/updated/closed" msgid "ProjectService|Event triggered when someone adds a comment on a confidential issue."
msgstr "" msgstr ""
msgid "ProjectService|Event will be triggered when someone adds a comment" msgid "ProjectService|Event triggered when someone adds a comment."
msgstr "" msgstr ""
msgid "ProjectService|Event will be triggered when someone adds a comment on a confidential issue" msgid "ProjectService|Event triggered when someone pushes to the repository."
msgstr "" msgstr ""
msgid "ProjectService|Issue URL" msgid "ProjectService|Issue URL"
......
...@@ -17,7 +17,7 @@ RSpec.describe ServiceEventEntity do ...@@ -17,7 +17,7 @@ RSpec.describe ServiceEventEntity do
let(:event) { 'push' } let(:event) { 'push' }
it 'exposes correct attributes' do it 'exposes correct attributes' do
expect(subject[:description]).to eq('Event will be triggered by a push to the repository') expect(subject[:description]).to eq('Event triggered when someone pushes to the repository.')
expect(subject[:name]).to eq('push_events') expect(subject[:name]).to eq('push_events')
expect(subject[:title]).to eq('push') expect(subject[:title]).to eq('push')
expect(subject[:value]).to be(true) expect(subject[:value]).to be(true)
...@@ -29,7 +29,7 @@ RSpec.describe ServiceEventEntity do ...@@ -29,7 +29,7 @@ RSpec.describe ServiceEventEntity do
let(:event) { 'note' } let(:event) { 'note' }
it 'exposes correct attributes' do it 'exposes correct attributes' do
expect(subject[:description]).to eq('Event will be triggered when someone adds a comment') expect(subject[:description]).to eq('Event triggered when someone adds a comment.')
expect(subject[:name]).to eq('note_events') expect(subject[:name]).to eq('note_events')
expect(subject[:title]).to eq('note') expect(subject[:title]).to eq('note')
expect(subject[:value]).to eq(false) expect(subject[:value]).to eq(false)
......
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