Cynthia Lin
a267c61cdd
integrations: Update docs for adding integration images.
2017-04-24 22:34:36 -07:00
Tomasz Kolek
5b17622589
docs: Move integrations.html to integrations/index.html.
...
Add omiting rule for all of integrations docs in test_templates.
2017-04-05 13:19:58 -07:00
Yago González
a5ecb5e5cf
docs: Fix minor link formatting.
2017-03-19 09:16:06 -07:00
Tim Abbott
cf4faf6598
docs: Clarify that non-webhook integrations need documentation too.
2017-02-07 18:24:35 -08:00
Feorlen
78b9b83650
Create new webhook walkthrough page from the integration guide.
...
Breaks out the Hello World example to create a new
webhook-walkthrough.md. Includes minor edits so the two docs
read well. Adds the new page, "Webhook walkthrough", to the TOC.
Fixes #3498
2017-02-07 18:22:31 -08:00
Tim Abbott
0f75c8d4ed
docs: Simplify integration guide discussion of writing docs.
...
You don't need to know about the div structure of /integrations
anymore, so we shouldn't get into it.
2017-01-29 11:53:09 -08:00
Tomasz Kolek
3b48f21f5a
Add improvements to integration-guide.md.
...
Fix some typos, add a few sentences that might clear it a little.
2017-01-29 11:49:13 -08:00
Tomasz Kolek
71e6eb68c0
Update integration-guide according to integrations redesign.
...
With numerous typo and grammar fixed by tabbott.
2017-01-26 12:27:38 -08:00
Jackson
013fab70ad
Fix grammatical and spelling errors in Zulip/docs.
2017-01-16 20:16:12 -08:00
Tim Abbott
15b718e2d1
Fix capitalization in 'Your bots'.
2017-01-16 18:00:10 -08:00
Yago González
814c24cfd6
docs: Reorganize steps in Documenting your integration.
2017-01-13 13:50:58 -08:00
Yago González
a2ebb066b4
docs: Fix formatting typo.
2017-01-04 10:12:07 -08:00
Rishi Gupta
4cf894fcb9
mypy: Update docs to recommend typing.Text instead of six.text_type.
2016-12-26 16:11:37 -08:00
Rishi Gupta
6d780d8dc2
mypy: Convert api/ and docs/ to use typing.Text.
2016-12-26 16:11:37 -08:00
Tim Abbott
24f0029111
integration-guide: Fix 'webhook' typo.
...
Fixes #2467 .
2016-11-29 19:08:21 -08:00
Tim Abbott
b035a6c606
docs: Change dev -> development everywhere.
2016-11-29 14:23:54 -08:00
Feorlen
d56272a162
docs: Explain how the HTML webhook documentation is used.
...
Part of #1998 .
2016-11-15 21:00:16 -08:00
Feorlen
e45c10884e
docs: Fix typo and whitespace.
2016-11-15 21:00:16 -08:00
Feorlen
d8afc306ee
docs: Clarify that HelloWorldHookTests is subclassing WebhookTestCase.
...
Part of #1998 .
2016-11-15 21:00:15 -08:00
Feorlen
ed61d3086d
docs: Describe what an API key is and how to get one.
...
Part of #1998 .
2016-11-15 20:59:43 -08:00
Feorlen
113b2b39fb
docs: Describe what a test fixture is.
...
Part of #1998 .
2016-11-15 20:59:39 -08:00
Feorlen
4725a7b7de
docs: Describe what a webhook is.
...
Part of #1998 .
2016-11-15 20:58:39 -08:00
Sumana Harihareswara
6323494f37
docs: Properly capitalize GitHub.
2016-10-17 19:31:50 -04:00
Tomasz Kolek
7df50cee34
docs: Fix paths in webhooks part of integration-guide.
...
We forgot to update the documentation when we rearranged the webhooks
tests to be split across several files.
[mostly rewritten by tabbott]
2016-10-04 20:09:58 -07:00
Tim Abbott
03bf8893e2
Remove legacy /api/v1/send_message endpoint.
...
This was the original way to send messages via the Zulip API in the
very early days of Zulip, but was replaced by the REST API back in
2013.
Fixes : #730 .
2016-09-27 14:51:54 -07:00
Sahil Dua
058587da77
Remove extra new lines at the ends of Zulip authoried files.
...
Fixes #1627 .
[tweaked by tabbott to avoid patching third-party modules, for now]
2016-09-26 21:05:24 -07:00
Christie Koehler
4c66bbc1ee
integration guide: Move Hello World walkthrough to end.
2016-08-04 15:59:49 -07:00
Christie Koehler
6cf6341a49
integration guide: Improve readability and navigation.
2016-08-04 15:59:48 -07:00
Christie Koehler
4cd28e5e1f
integration guide: Update Hello World walkthrough.
2016-08-04 15:59:28 -07:00
Tim Abbott
4a7e6e852f
integration guide: Update documentation instructions.
2016-08-04 12:04:12 -07:00
Tim Abbott
6ab09064ac
integration guide: Increase visibility level of hello world guide.
2016-08-04 11:55:19 -07:00
Tim Abbott
613781f034
integration guide: Swap created files above updated files.
2016-08-04 11:53:05 -07:00
Tim Abbott
0691832817
docs: Document new WEBHOOK_INTEGRATIONS API.
2016-08-04 11:52:28 -07:00
Tim Abbott
5f37485e7f
docs: Improve integration guide link to writing documentation.
2016-08-04 11:49:17 -07:00
Tomasz Kolek
0e33b8bd4d
Add integrations library.
...
Define Integration and WebhookIntegration classes.
Change webhook part of integration's guide.
Replace hardcoded webhook urls to generating
based on WEBHOOKS list.
2016-08-04 11:39:20 -07:00
Christie Koehler
31efecf03d
Add HelloWorld webhook integration + Walkthough.
...
Improves webhook integration docs and Hello World webhook. Includes
many suggested improvements from @timabbott and @tomaszkolek.
2016-07-29 21:38:40 -07:00
Sumana Harihareswara
db6c9702c2
Update links in README and integration guide.
2016-07-19 14:57:07 -07:00
Tim Abbott
89b5eaaa7d
docs: Improve several headings.
2016-06-26 09:54:19 -07:00
Sumana Harihareswara
337155f280
Remove rST files to replace with Markdown.
...
Currently (https://github.com/rtfd/recommonmark/issues/3 )
the recommonmark bridge (which allows Sphinx to read
Markdown) does not support tables, so the directory structure
doc is now a bulleted list instead of a set of tables.
2016-05-31 10:55:49 -07:00
Sumana Harihareswara
f65778f1e2
Improve sub-headings in documentation.
...
Signed-off-by: Sumana Harihareswara <sumanah@panix.com>
2016-05-31 09:05:38 -07:00
Tim Abbott
60722a8fce
Integration guide: Add a note about spelling integraiton names.
2016-05-11 21:19:15 -07:00
Tim Abbott
abacd9b2da
Integration guide: Document need to edit urls.py.
2016-04-26 11:50:19 -07:00
Tim Abbott
74ed9fabd0
Integration guide: Expand instructions on screenshots.
2016-04-21 18:17:26 -07:00
Tomasz Kolek
82f1cdb085
Add send_webhook_fixture_message command.
...
This tool simplifies the process of producing nice screenshots for
documenting webhook integrations.
Fixes #658 .
2016-04-20 10:45:27 -07:00
Tim Abbott
1b988de30a
Integration guide: clean up description of plugin integrations.
2016-04-19 16:21:33 -07:00
Tim Abbott
92f9a789b8
integration guide: Improve introduction.
2016-04-19 16:21:33 -07:00
Tim Abbott
be96cf809d
Move Zulip backend tests to zerver.tests.
2016-04-11 22:16:09 -07:00
Tim Abbott
342b4eb457
Add a detailed integration writing guide.
...
Fixes : #70 .
2016-04-01 09:56:59 -07:00