From 8eaac945b22b7fe7862b8bdd8438c1969cbacd49 Mon Sep 17 00:00:00 2001 From: Lauryn Menard Date: Tue, 28 Feb 2023 16:24:17 +0100 Subject: [PATCH] integrations-docs: Fix indentation issues in existing documentation. Fixes some integrations documentation so that code blocks and images are rendered in the correct HTML list elements. --- templates/zerver/integrations/hubot.md | 18 ++++++++-------- templates/zerver/integrations/irc.md | 30 +++++++++++++++----------- zerver/webhooks/dropbox/doc.md | 2 +- zerver/webhooks/wekan/doc.md | 2 +- 4 files changed, 28 insertions(+), 24 deletions(-) diff --git a/templates/zerver/integrations/hubot.md b/templates/zerver/integrations/hubot.md index d27350d8b7..e01c501aed 100644 --- a/templates/zerver/integrations/hubot.md +++ b/templates/zerver/integrations/hubot.md @@ -14,18 +14,18 @@ 1. To run Hubot locally, first, set the following environment variables by running: -``` -export HUBOT_ZULIP_SITE="{{ api_url }}" -export HUBOT_ZULIP_BOT="hubot-bot@example.com" -export HUBOT_ZULIP_API_KEY="your_key" -``` + ``` + export HUBOT_ZULIP_SITE="{{ api_url }}" + export HUBOT_ZULIP_BOT="hubot-bot@example.com" + export HUBOT_ZULIP_API_KEY="your_key" + ``` -Then, run: + Then, run: -`bin/hubot --adapter zulip --name "myhubot"` + `bin/hubot --adapter zulip --name "myhubot"` -The `--name` parameter must match the name you gave the bot on -the settings page. + The `--name` parameter must match the name you gave the bot on + the settings page. Hubot will automatically listen for commands on all public streams. You can also invite Hubot to private streams. diff --git a/templates/zerver/integrations/irc.md b/templates/zerver/integrations/irc.md index 9af3b91d80..65f5247a6f 100644 --- a/templates/zerver/integrations/irc.md +++ b/templates/zerver/integrations/irc.md @@ -17,14 +17,16 @@ Mirror an IRC channel in Zulip! at the end of the output of the previous step. 1. Go to the directory containing the bridge script if you haven't already done so - ``` - cd zulip/integrations/bridge_with_irc - ``` + + ``` + cd zulip/integrations/bridge_with_irc + ``` 1. Install the bridge dependencies in your virtualenv, by running: - ``` - pip install -r requirements.txt - ``` + + ``` + pip install -r requirements.txt + ``` ### Configure the bridge @@ -34,17 +36,19 @@ Mirror an IRC channel in Zulip! 1. [Subscribe the bot](/help/add-or-remove-users-from-a-stream) to the Zulip stream that will contain the mirror. -1. Inside the virtualenv you created above, run - ``` - python irc-mirror.py --irc-server=IRC_SERVER --channel= --nick-prefix= \ - --stream= [--topic=] \ - --site= --user= \ - --api-key= - ``` +1. Inside the virtualenv you created above, run: + + ``` + python irc-mirror.py --irc-server=IRC_SERVER --channel= --nick-prefix= \ + --stream= [--topic=] \ + --site= --user= \ + --api-key= + ``` `--topic` is a Zulip topic, is optionally specified, defaults to "IRC". Example command: + ``` ./irc-mirror.py --irc-server=irc.freenode.net --channel='#python-mypy' --nick-prefix=irc_mirror \ --stream='test here' --topic='#mypy' \ diff --git a/zerver/webhooks/dropbox/doc.md b/zerver/webhooks/dropbox/doc.md index 3a27c6c416..708529c643 100644 --- a/zerver/webhooks/dropbox/doc.md +++ b/zerver/webhooks/dropbox/doc.md @@ -13,7 +13,7 @@ Get Dropbox notifications in Zulip! 1. Go to the **Oauth 2** section, at the bottom of which you'll find a **Generate** button. Click on it to activate the app for your account. -![](/static/images/integrations/dropbox/oauth2_generate.png) + ![](/static/images/integrations/dropbox/oauth2_generate.png) 1. Set **Webhook URIs** to the URL constructed above and click **Add**. The status of the webhook should say **Enabled**. diff --git a/zerver/webhooks/wekan/doc.md b/zerver/webhooks/wekan/doc.md index 1cde4524ab..56660d425d 100644 --- a/zerver/webhooks/wekan/doc.md +++ b/zerver/webhooks/wekan/doc.md @@ -4,7 +4,7 @@ Get Wekan notifications in Zulip! 1. {!create-bot-construct-url.md!} - {!git-webhook-url-with-branches.md!} + {!git-webhook-url-with-branches.md!} 1. Go to Wekan and click on the **Settings** icon. Select **Outgoing Webhooks**.