From d76f728dda181a9ee1e9a5c42c4bf5fb9ba6aac6 Mon Sep 17 00:00:00 2001 From: Rishi Gupta Date: Tue, 16 Oct 2018 20:08:27 -0700 Subject: [PATCH] api docs: Rename webhook-walkthrough to incoming-webhooks-walkthrough. --- docs/subsystems/client.md | 2 +- templates/zerver/api/incoming-webhooks-overview.md | 2 +- ...{webhook-walkthrough.md => incoming-webhooks-walkthrough.md} | 0 templates/zerver/api/sidebar_index.md | 2 +- tools/linter_lib/custom_check.py | 2 +- zerver/templatetags/app_filters.py | 2 +- 6 files changed, 5 insertions(+), 5 deletions(-) rename templates/zerver/api/{webhook-walkthrough.md => incoming-webhooks-walkthrough.md} (100%) diff --git a/docs/subsystems/client.md b/docs/subsystems/client.md index ed6dfdc020..f6aa7492b6 100644 --- a/docs/subsystems/client.md +++ b/docs/subsystems/client.md @@ -35,4 +35,4 @@ object as `request.client`. In most integrations, `request.client` is then passed to `check_send_stream_message`, where it is used to keep track of which client sent the message (which in turn is used by analytics). For more -information, see [the incoming webhook walkthrough](https://zulipchat.com/api/webhook-walkthrough). +information, see [the incoming webhook walkthrough](https://zulipchat.com/api/incoming-webhooks-walkthrough). diff --git a/templates/zerver/api/incoming-webhooks-overview.md b/templates/zerver/api/incoming-webhooks-overview.md index 6f2bc04973..5b784b1202 100644 --- a/templates/zerver/api/incoming-webhooks-overview.md +++ b/templates/zerver/api/incoming-webhooks-overview.md @@ -48,7 +48,7 @@ including tests and documentation, if you use the right process. ## Hello world walkthrough -Check out the [detailed walkthrough](webhook-walkthrough) for step-by-step +Check out the [detailed walkthrough](incoming-webhooks-walkthrough) for step-by-step instructions. ## Checklist diff --git a/templates/zerver/api/webhook-walkthrough.md b/templates/zerver/api/incoming-webhooks-walkthrough.md similarity index 100% rename from templates/zerver/api/webhook-walkthrough.md rename to templates/zerver/api/incoming-webhooks-walkthrough.md diff --git a/templates/zerver/api/sidebar_index.md b/templates/zerver/api/sidebar_index.md index 205903461e..46b954920d 100644 --- a/templates/zerver/api/sidebar_index.md +++ b/templates/zerver/api/sidebar_index.md @@ -2,7 +2,7 @@ * [Overview](/api/integrations-overview) * [Incoming webhook integrations](/api/incoming-webhooks-overview) -* [Hello world walkthrough](/api/webhook-walkthrough) +* [Hello world walkthrough](/api/incoming-webhooks-walkthrough) * [Non-webhook integrations](/api/non-webhook-integrations) ## Interactive bots (beta) diff --git a/tools/linter_lib/custom_check.py b/tools/linter_lib/custom_check.py index b596536465..5139553baa 100644 --- a/tools/linter_lib/custom_check.py +++ b/tools/linter_lib/custom_check.py @@ -844,7 +844,7 @@ def build_custom_checkers(by_lang): # Has a very long configuration line "templates/zerver/integrations/perforce.md", # Has some example code that could perhaps be wrapped - "templates/zerver/api/webhook-walkthrough.md", + "templates/zerver/api/incoming-webhooks-walkthrough.md", # This macro has a long indented URL "templates/zerver/help/include/git-webhook-url-with-branches-indented.md", } diff --git a/zerver/templatetags/app_filters.py b/zerver/templatetags/app_filters.py index 7195a9866d..3cad1d07ea 100644 --- a/zerver/templatetags/app_filters.py +++ b/zerver/templatetags/app_filters.py @@ -67,7 +67,7 @@ md_macro_extension = None # type: Optional[Any] # they contain a macro, it is always used literally for documenting # the macro system. docs_without_macros = [ - "webhook-walkthrough.md", + "incoming-webhooks-walkthrough.md", ] # Much of the time, render_markdown_path is called with hashable