From cd81b0766a3511b4eae9f2020c2f2999d359968d Mon Sep 17 00:00:00 2001 From: Rishi Gupta Date: Tue, 16 Oct 2018 20:00:52 -0700 Subject: [PATCH] api docs: Move references to integration-guide to integrations-overview. --- CONTRIBUTING.md | 2 +- docs/overview/directory-structure.md | 2 +- docs/overview/gsoc-ideas.md | 2 +- docs/subsystems/custom-apps.md | 2 +- docs/tutorials/writing-views.md | 1 - templates/zerver/api/writing-bots.md | 2 +- templates/zerver/hello.html | 2 +- .../zerver/help/getting-your-organization-started-with-zulip.md | 2 +- templates/zerver/help/zulip-glossary.md | 2 +- templates/zerver/integrations/index.html | 2 +- 10 files changed, 9 insertions(+), 10 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 59a293dce4..0aeacff210 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -31,7 +31,7 @@ needs doing: [desktop app](https://github.com/zulip/zulip-electron). * Building out our [Python API and bots](https://github.com/zulip/python-zulip-api) framework. -* [Writing an integration](https://zulipchat.com/api/integration-guide). +* [Writing an integration](https://zulipchat.com/api/integrations-overview). * Improving our [user](https://zulipchat.com/help/) or [developer](https://zulip.readthedocs.io/en/latest/) documentation. * [Reviewing code](https://zulip.readthedocs.io/en/latest/contributing/code-reviewing.html) diff --git a/docs/overview/directory-structure.md b/docs/overview/directory-structure.md index 9d36ef8748..61205e307c 100644 --- a/docs/overview/directory-structure.md +++ b/docs/overview/directory-structure.md @@ -26,7 +26,7 @@ paths will be familiar to Django developers. * `zerver/views/*.py` Most [Django views](https://docs.djangoproject.com/en/1.8/topics/http/views/). * `zerver/webhooks/` Webhook views and tests for [Zulip's incoming webhook integrations]( - https://zulipchat.com/api/integration-guide). + https://zulipchat.com/api/incoming-webhooks-overview). * `zerver/tornado/views.py` Tornado views. diff --git a/docs/overview/gsoc-ideas.md b/docs/overview/gsoc-ideas.md index edb5f36103..57b21dfec2 100644 --- a/docs/overview/gsoc-ideas.md +++ b/docs/overview/gsoc-ideas.md @@ -258,7 +258,7 @@ CSS](https://github.com/zulip/zulip/). providers, e.g. having built a prototype with [the Django Oauth toolkit](https://django-oauth-toolkit.readthedocs.io/en/latest/) would be great to demonstrate as part of an application. The - [Zulip integration writing guide](https://zulipchat.com/api/integration-guide) + [Zulip integration writing guide](../subsystems/integration-docs.html) and [integration documentation](https://chat.zulip.org/integrations/) are useful materials for learning about how things currently work, diff --git a/docs/subsystems/custom-apps.md b/docs/subsystems/custom-apps.md index f85f5695cd..9eac34d347 100644 --- a/docs/subsystems/custom-apps.md +++ b/docs/subsystems/custom-apps.md @@ -177,7 +177,7 @@ you basically have to solve these problems: Zulip actually supports a bunch of integrations out-of-the-box that perform as **World Readers**. -The [three different integration models](https://zulipchat.com/api/integration-guide#types-of-integrations) +The [three different integration models](https://zulipchat.com/api/integrations-overview#sending-content-into-zulip) basically differ in where they perform the main functions of a **World Reader**. diff --git a/docs/tutorials/writing-views.md b/docs/tutorials/writing-views.md index bdc138e561..2a64465538 100644 --- a/docs/tutorials/writing-views.md +++ b/docs/tutorials/writing-views.md @@ -4,7 +4,6 @@ This page documents how views work in Zulip. You may want to read the [new feature tutorial](../tutorials/new-feature-tutorial.html) -or the [integration guide](https://zulipchat.com/api/integration-guide), and treat this as a reference. If you have experience with Django, much of this will be familiar, but diff --git a/templates/zerver/api/writing-bots.md b/templates/zerver/api/writing-bots.md index 4a322c36b9..30250b3932 100644 --- a/templates/zerver/api/writing-bots.md +++ b/templates/zerver/api/writing-bots.md @@ -4,7 +4,7 @@ Zulip's API supports a few different ways of integrating with a third-party service. * **Incoming webhook integrations**, for when you just want notifications from - a tool to be sent into Zulip. See the [integrations guide](integration-guide). + a tool to be sent into Zulip. See the [integrations guide](integrations-overview). * **Interactive bots**, for when you want the tool to react to messages in Zulip. diff --git a/templates/zerver/hello.html b/templates/zerver/hello.html index 0994623e84..2b036c89ba 100644 --- a/templates/zerver/hello.html +++ b/templates/zerver/hello.html @@ -437,7 +437,7 @@
-

Or build your own integrations with Zulip’s powerful API.

+

Or build your own integrations with Zulip’s powerful API.

diff --git a/templates/zerver/help/getting-your-organization-started-with-zulip.md b/templates/zerver/help/getting-your-organization-started-with-zulip.md index 5cfcebf9bd..0463fa5e34 100644 --- a/templates/zerver/help/getting-your-organization-started-with-zulip.md +++ b/templates/zerver/help/getting-your-organization-started-with-zulip.md @@ -99,7 +99,7 @@ expert teaching other users how to use Zulip. * [Add custom profile fields](/help/add-custom-profile-fields) - [Automatically linkify](/help/add-a-custom-linkification-filter) issue numbers. -- [Write custom integrations](https://zulipchat.com/api/integration-guide) +- [Write custom integrations](/api/integrations-overview) for your team’s workflow. - If your users primarily speak a language other than English, [set a default language for your organization](/help/change-the-default-language-for-your-organization). diff --git a/templates/zerver/help/zulip-glossary.md b/templates/zerver/help/zulip-glossary.md index e6021b2093..082217c4c3 100644 --- a/templates/zerver/help/zulip-glossary.md +++ b/templates/zerver/help/zulip-glossary.md @@ -93,7 +93,7 @@ An **integration** is a tool that combines Zulip with another service or application. Zulip offers a variety of integrations for version control, issue tracker, CI system, monitoring tools, and other tools used for development. See Zulip's -[integration documentation](/api/integration-guide) for details on the +[integration documentation](/api/integrations-overview) for details on the various types of Zulip integrations. ### mention diff --git a/templates/zerver/integrations/index.html b/templates/zerver/integrations/index.html index 35107439d9..9bb886869b 100644 --- a/templates/zerver/integrations/index.html +++ b/templates/zerver/integrations/index.html @@ -103,7 +103,7 @@ {% endif %} {% endfor %} - +