Mirror
/
zulip
mirror of https://github.com/zulip/zulip.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Integration guide: Expand instructions on screenshots.

This commit is contained in:
Tim Abbott 2016-04-21 18:16:39 -07:00
parent 35b0af2852
commit 74ed9fabd0
1 changed files with 8 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
docs/integration-guide.md
View File

@ -145,7 +145,9 @@ steps:
setup the integration, including what URLs to use, etc. If there setup the integration, including what URLs to use, etc. If there
are any screens in the product involved, take a few screenshots with are any screens in the product involved, take a few screenshots with
the input fields filled out with sample values in order to make the the input fields filled out with sample values in order to make the
instructions really easy to follow. instructions really easy to follow. For the screenshots, use
something like `github-bot@example.com` for the email addresses and
an obviously fake API key like `abcdef123456790`.
* Finally, generate a message sent by the integration and take a * Finally, generate a message sent by the integration and take a
screenshot of the message to provide an example message in the screenshot of the message to provide an example message in the
@ -159,6 +161,11 @@ steps:
'--url=/api/v1/external/pingdom?stream=stream_name&api_key=api_key' '--url=/api/v1/external/pingdom?stream=stream_name&api_key=api_key'
``` ```
When generating the screenshot of a sample message, give your test
bot a nice name like "GitHub Bot", use the project's logo as the
bot's avatar, and take the screenshots showing the stream/topic bar
for the message, not just the message body.
When writing documentation for your integration, be sure to use the When writing documentation for your integration, be sure to use the
`{{ external_api_uri }}` template variable, so that your integration `{{ external_api_uri }}` template variable, so that your integration
documentation will provide the correct URL for whatever server it is documentation will provide the correct URL for whatever server it is