paulmataruso/zulip
1
0
Fork 0
mirror of https://github.com/zulip/zulip.git synced 2025-11-02 04:53:36 +00:00
Code Issues Packages Projects Releases Wiki Activity

integ-docs: Update the sample site URLs and bot emails.

Browse Source 
To use the appropriate context properties.

This commit does not touch the integration docs that do not use the
new integration doc format, as this update will be included in their
format update sweep.
This commit is contained in:
Niloth P
2025-05-26 05:22:35 +05:30
committed by Tim Abbott
parent ae98bfe73e
commit 59839be9d6
4 changed files with 7 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
templates/zerver/integrations/capistrano.md
View File

@@ -20,8 +20,8 @@ Get Zulip notifications for your Capistrano deploys!
desc "Post a message to Zulip after deploy"
task :humbug do
run_locally "echo 'I just deployed to #{stage}! :tada:' | zulip-send \
--user capistrano-bot@example.com --api-key a0b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5 \
--site={{ api_url }} \
--user capistrano-bot@{{ display_host }} --api-key a0b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5 \
--site={{ zulip_url }} \
--stream commits --subject deployments || true"
end
end

4
templates/zerver/integrations/hubot.md
View File

@@ -18,8 +18,8 @@ Use Hubot to execute scripts and commands within Zulip!
information of the bot you created, by running:
```
export HUBOT_ZULIP_SITE="{{ api_url }}"
export HUBOT_ZULIP_BOT="hubot-bot@example.com"
export HUBOT_ZULIP_SITE="{{ zulip_url }}"
export HUBOT_ZULIP_BOT="hubot-bot@{{ zulip_url }}"
export HUBOT_ZULIP_API_KEY="<your_key>"
```

2
templates/zerver/integrations/include/change-zulip-config-file.md
View File

@@ -3,7 +3,7 @@ following lines to specify the email address and API key for your
{{ integration_display_name }} bot:
```
ZULIP_USER = "{{ integration_name }}-bot@example.com"
ZULIP_USER = "{{ integration_name }}-bot@{{ display_host }}"
ZULIP_API_KEY = "0123456789abcdef0123456789abcdef"
ZULIP_SITE = "{{ zulip_url }}"
```

4
zerver/webhooks/helloworld/doc.md
View File

@@ -23,13 +23,13 @@ integration](/api/incoming-webhooks-walkthrough).
(zulip-server) vagrant@vagrant:/srv/zulip$
./manage.py send_webhook_fixture_message \
> --fixture=zerver/tests/fixtures/helloworld/hello.json \
> '--url=http://localhost:9991/api/v1/external/helloworld?api_key=abcdefgh&stream=channel%20name;'
> '--url=http://localhost:9991/api{{ integration_url }}?api_key=abcdefgh&stream=channel%20name;'
```
Or, use curl:
```
curl -X POST -H "Content-Type: application/json" -d '{ "featured_title":"Marilyn Monroe", "featured_url":"https://en.wikipedia.org/wiki/Marilyn_Monroe" }' http://localhost:9991/api/v1/external/helloworld\?api_key=abcdefgh&stream=channel%20name;
curl -X POST -H "Content-Type: application/json" -d '{ "featured_title":"Marilyn Monroe", "featured_url":"https://en.wikipedia.org/wiki/Marilyn_Monroe" }' http://localhost:9991/api{{ integration_url }}?api_key=abcdefgh&stream=channel%20name;
```
{end_tabs}