integrations: Restructure documentation pages.

Restructures the integration documentation pages to use a style
that's more similar to the help center documentation, with an
instruction block for setting up the integration, and sections
for additional configuration information and related documentation
links.

Updates the doc pages for the airbrake, azuredevops and gitlab
integrations as examples of the updated style.

Also updates the URL specification section of the incoming webhook
overview in the API documentation so that the documented URL
parameters can be linked to directly in the integration doc pages.

Co-authored-by: Alya Abbott <alya@zulip.com>
This commit is contained in:
Lauryn Menard
2024-03-19 17:03:01 +01:00
committed by Tim Abbott
parent 329eda74a9
commit 8bb8240c27
9 changed files with 108 additions and 42 deletions

View File

@@ -1,30 +1,43 @@
Get Azure Devops notifications in Zulip!
# Zulip Azure DevOps integration
Get Azure DevOps notifications in Zulip!
{start_tabs}
1. {!create-stream.md!}
1. {!create-an-incoming-webhook.md!}
1. {!generate-integration-url.md!}
1. {!generate-webhook-url-basic.md!}
{!git-webhook-url-with-branches.md!}
1. Go to your project on Azure DevOps, click on the **Project
settings** in the bottom left corner and select **Service
hooks**. Click on **Create subscription**, select
**Web hooks**, and click **Next**.
1. Go to your project on Azure DevOps and click on the **Project
settings** in the bottom left corner. Select **Service
hooks**. Click on **Create subscription**. Select **Web hooks** and
then **Next**.
1. Select the [events](#filtering-incoming-events) you would like to receive
notifications for, and click **Next**.
1. Select the events you would like to receive notifications for and
then click **Next**. This integration supports the following
events:
* Code pushed
* Pull request created
* Pull request updated
* Pull request merge attempted
1. Set **URL** to the URL constructed above. Ensure that **Resource
1. Set **URL** to the URL you generated. Ensure that **Resource
details to send** and **Detailed messages to send** are set to
**All**. Click **Finish**.
{end_tabs}
{!congrats.md!}
![](/static/images/integrations/azuredevops/001.png)
{% if all_event_types is defined %}
{!event-filtering-additional-feature.md!}
{% endif %}
### Configuration options
{!git-branches-additional-feature.md!}
### Related documentation
{!webhooks-url-specification.md!}