From 30e73104955388b25c8943e855b2d9735dafead2 Mon Sep 17 00:00:00 2001 From: Niloth P <20315308+Niloth-p@users.noreply.github.com> Date: Sun, 2 Mar 2025 11:01:06 +0530 Subject: [PATCH] integration-docs: Remove two outdated macros. - generate-integration-url.md has been long replaced by the generate-webhook-url-basic.md. - webhook-url.md was only being used inside the above macro. --- api_docs/incoming-webhooks-walkthrough.md | 2 +- docs/documentation/integrations.md | 3 --- .../include/generate-integration-url.md | 18 ------------------ .../zerver/integrations/include/webhook-url.md | 1 - 4 files changed, 1 insertion(+), 23 deletions(-) delete mode 100644 templates/zerver/integrations/include/generate-integration-url.md delete mode 100644 templates/zerver/integrations/include/webhook-url.md diff --git a/api_docs/incoming-webhooks-walkthrough.md b/api_docs/incoming-webhooks-walkthrough.md index 1953ed18e8..a6d0f17e29 100644 --- a/api_docs/incoming-webhooks-walkthrough.md +++ b/api_docs/incoming-webhooks-walkthrough.md @@ -444,7 +444,7 @@ Learn how Zulip integrations work with this simple Hello World example! 1. {!create-an-incoming-webhook.md!} -1. {!generate-integration-url.md!} +1. {!generate-webhook-url-basic.md!} 1. To trigger a notification using this example webhook, you can use `send_webhook_fixture_message` from a [Zulip development diff --git a/docs/documentation/integrations.md b/docs/documentation/integrations.md index f9f872eec3..cf2d8d78ae 100644 --- a/docs/documentation/integrations.md +++ b/docs/documentation/integrations.md @@ -132,9 +132,6 @@ Here are a few common macros used to document Zulip's integrations: webhooks. For an example rendering, see the last paragraph of **Step 2** in [the docs for Zulip's GitHub integration][github-integration]. -- `{!webhook-url.md!}` - Used internally by `{!generate-integration-url.md!}` - to generate the webhook URL. - - `{!webhook-url-with-bot-email.md!}` - Used in certain non-webhook integrations to generate URLs of the form: diff --git a/templates/zerver/integrations/include/generate-integration-url.md b/templates/zerver/integrations/include/generate-integration-url.md deleted file mode 100644 index ca808e77fb..0000000000 --- a/templates/zerver/integrations/include/generate-integration-url.md +++ /dev/null @@ -1,18 +0,0 @@ -[Generate the URL][generate-url] for your {{ integration_display_name }} -integration. - -{% if all_event_types is defined %} - -{!event-filtering-instruction.md!} - -{% endif %} - -The generated URL will look something like this: - -{!webhook-url.md!} - -*To manually construct the URL for an incoming webhook integration, -see [the webhook URLs specification][incoming-webhook-urls].* - -[generate-url]: /help/generate-integration-url -[incoming-webhook-urls]: /api/incoming-webhooks-overview#url-specification diff --git a/templates/zerver/integrations/include/webhook-url.md b/templates/zerver/integrations/include/webhook-url.md deleted file mode 100644 index 6fd1a028d6..0000000000 --- a/templates/zerver/integrations/include/webhook-url.md +++ /dev/null @@ -1 +0,0 @@ -`{{ api_url }}{{ integration_url }}?api_key=abcdefgh&stream=123`