Mirror
/
zulip
mirror of https://github.com/zulip/zulip.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
28,007 Commits 28 Branches 143 Tags 623 MiB
Commit Graph

196 Commits

Author SHA1 Message Date
Rishi Gupta e7374a0852 api docs: Link to our zapier and ifttt /integrations pages. 2018-08-10 10:37:49 -07:00
Yago González 90e3b8d808 api docs: Remove unnecessary argument entry. 2018-08-08 09:29:27 -07:00
Yago González 8d0cf3ebe5 api docs: Migrate POST /user_uploads to OpenAPI. 2018-08-08 09:29:27 -07:00
Yago González 119b3c0bc4 api docs: Migrate DELETE /users/me/subscriptions to OpenAPI. 2018-08-08 09:29:27 -07:00
Yago González 14c9277095 api docs: Migrate POST /users to OpenAPI. 2018-08-08 09:29:27 -07:00
Yago González 2b8bb2ffc6 api docs: Migrate DELETE /events to OpenAPI. 2018-08-02 15:54:41 -07:00
Yago González 5f3268cc48 api docs: Migrate GET /events to OpenAPI. 2018-08-02 15:54:41 -07:00
Yago González c28db51da2 api docs: Improve phrasing for /events. 2018-08-02 15:54:41 -07:00
Yago González 5631645d9f api docs: Migrate /register to OpenAPI. 2018-08-02 15:54:41 -07:00
Yago González 40a21f6077 api docs: Migrate GET /users to OpenAPI. 2018-07-26 15:34:31 -07:00
Yago González 7c50f6cdd4 api docs: Migrate POST /messages/render to OpenAPI. 2018-07-26 15:34:31 -07:00
Yago González 57c2d8c72a api docs: Migrate GET /get_stream_id to OpenAPI. 2018-07-26 15:34:31 -07:00
Yago González 679319a735 api docs: Migrate GET /streams to OpenAPI. 2018-07-26 15:34:31 -07:00
Yago González 7ddc6e8d10 api docs: Migrate POST /messages to OpenAPI. 2018-07-26 10:24:01 -07:00
Yago González cb24756edc api docs: Merge docs for sending stream and private messages. 2018-07-26 10:24:01 -07:00
Lyla Fischer d50faa4d81 user docs: Add reference to support email in docs footer. 2018-07-24 11:10:23 -07:00
Rhea Parekh b6ce93e029 outgoing webhooks: Fix sample values for slack outgoing webhooks. 
This switches us to use the correct timestamp, service_id and token
formats.  The 'service_id' should be the ID of the bot user. The token
should be a sample token generated from 'random_api_key()'.
 2018-07-23 08:07:56 -07:00
Eeshan Garg 37e7cb4b96 outgoing-webhooks.md: Use HTML tables to document payload fields. 2018-07-14 09:44:54 +05:30
Eeshan Garg 2e78a56796 outgoing-webhooks.md: Add example payloads/fixtures. 2018-07-14 09:44:54 +05:30
Cynthia Lin ab9f167053 help: Refactor help page CSS to eliminate padding on content containers. 
This is essential for using simplebar, since simplebar doesn't account
for parent <div> paddings, which might cause scrollbars to be mispositioned
if not considered.
 2018-07-13 18:03:32 +05:30
Eeshan Garg d60037c91b deploying_bots.md: Fix a couple of minor formatting issues. 2018-07-10 10:01:16 +05:30
Eeshan Garg 026493f791 api_docs: Split integration-guide.md into separate docs. 
This commit carves out the overview for incoming webhooks and
moves it to its own file. This is a much better way to structure
these docs.

This is a quick follow-up to Tim Abbott's comment on #9592.
 2018-07-09 14:59:17 -02:30
Anders Kaseorg b618c644a3 HTML validation: Quote <my-bot> and <api_key> placeholders in api docs. 
They were being sent to the browser as non-renderable HTML tags.

Signed-off-by: Anders Kaseorg <andersk@mit.edu>
 2018-07-09 10:00:56 +05:30
Anders Kaseorg 3806c092c6 HTML validation: Fix problems with tag nesting. 
Signed-off-by: Anders Kaseorg <andersk@mit.edu>
 2018-07-09 10:00:56 +05:30
Yago González fa2daf0044 api docs: Migrate POST /users/me/subscriptions to OpenAPI. 2018-07-03 20:15:34 +02:00
Yago González bba8b88707 api docs: Explain clearly how to create new streams. 
Tweaked significantly by tabbott to cover this more clearly.
 2018-07-01 08:41:37 -07:00
Yago González 9a2036b52a api docs: Make the Home page more straightforward. 
Fixes #9854.
 2018-07-01 04:33:04 -07:00
Rishi Gupta 89a59422cc api docs: Fix link to IFTTT. 
Old link is 404'ing.
 2018-06-29 22:40:16 -07:00
Yago González 8e50564717 api docs: Document the /users/me/<stream_id>/topics endpoint. 2018-06-23 12:42:11 +02:00
Lyla Fischer 3ccae20566 docs: Remove the footer, which directed people to help with docs. 2018-06-12 13:42:30 -04:00
Eeshan Garg 0a43e5e257 Replace all user-facing references to "invite-only" with "private". 
Fixes #9611.
 2018-06-12 13:37:45 -04:00
Robert Hönig 620b473cc8 botserver: Rename zulip-bot-server to zulip-botserver. 2018-06-04 08:39:25 -07:00
Robert Hönig f0284c84d6 bot docs: Update botserverrc examples. 
THe botserverrc sections now include
a token for each bot.
 2018-06-04 08:39:25 -07:00
Tim Abbott 0e354a4a23 api: Document BAD_EVENT_QUEUE_ID errors more completely. 2018-06-01 12:41:50 -07:00
Tim Abbott ba835e3511 api: Fix response fixtures for create-user. 2018-06-01 12:36:12 -07:00
Tim Abbott 9cbf6ad03b api: Fix response fixtures for delete_queue. 
These were malformed.
 2018-06-01 12:34:51 -07:00
Yago González f68fedd808 api docs: Make minor phrasing improvement. 2018-06-01 12:03:31 -07:00
Eeshan Garg f5bfa4e793 css: Fix code block formatting issues in our Markdown docs. 2018-06-01 09:19:42 -07:00
Eeshan Garg 4f98a45507 docs: Rename "webhooks" to "incoming webhooks". 
I only renamed references that I thought were absolutely necessary
and only if the resulting sentence structure wasn't awkward.

If the renaming resulted in awkward structure, I replaced the term
"webhook" with "integration" (but only in some very obvious cases).

Fixes #9500.
 2018-05-30 18:21:13 -07:00
Robert Hönig fe6b46dfa6 docs: Consistently use Botserver instead of botserver or bot server. 2018-05-29 07:27:33 -07:00
Robert Hönig 04d68d2570 code: Rename flaskbotrc to botserverrc. 2018-05-29 10:19:17 +02:00
Yago González c25855f703 api docs: Fix broken link. 2018-05-28 10:39:25 -07:00
Yago González f84c9b919b api docs: Read parameters and response fixtures from OpenAPI files. 2018-05-26 22:49:55 +02:00
Yago González d87f0ccb4e api docs: Show Yes/No in the "Required" field of the args table. 2018-05-25 23:31:30 +02:00
Tim Abbott 34354ca62b docs: Split zulip_botserver discussion of deploying bots. 
Now we have explicit documentation for the processing of deploying a
single bot, which can be cleaner and simpler.
 2018-05-25 11:01:57 -07:00
Robert Hönig 53891a9bed bots: Don't name section headers in flaskbotrc. 
The Botserver uses section headers in the flaskbotrc to
determine which bot to run. Silently setting the section
headers to a bot's username is confusing and makes it
harder for Botserver users to figure out how to get the
Botserver to run the bots they want. This commit empties
all flaskbotrc section headers and thus makes the assignment
of bots explicit and mandatory.
 2018-05-25 10:33:40 -07:00
Robert Hönig bdf79f271d Implement and document new Botserver setup routine. 
Previously, the Botserver determined which bot to run for an
outgoing webhook by dispatching on a different URL endpoint
for each bot. Now, instead, the Botserver determines which bot
to run by the section header of the bot in the flaskbotrc.
This commit makes the frontend provide the new flaskbotrc
and updates the setup steps for the Botserver in the docs.
 2018-05-25 10:33:40 -07:00
vaibhav cc0d0b55f1 docs: Add documentation for outgoing webhooks. 
Rewritten by some combination of @rheaparekh and @timabbott to more
clearly discuss what's actually important to users.
 2018-05-25 10:30:53 -07:00
Eeshan Garg 3ed20589f2 webhooks: Add generic exception for unexpected webhook events. 
UnexpectedWebhookEventType is a generic exception that we may
now raise when we encounter a webhook event that is new or one
that we simply aren't aware of.
 2018-05-22 08:30:19 -07:00
Tim Abbott 9de80990ea api: Update links for new /deploying-bots page. 
Also caught by test-help-documentation.
 2018-05-18 16:31:52 -07:00