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

303 Commits

Author SHA1 Message Date
Eeshan Garg ac86074869 api_docs: Suggest using call_endpoint for undocumented endpoints. 2019-01-22 07:37:56 -08:00
Adarsh Patel 5050b595a0 api docs: Fix showing correct link to install Python bindings. 
We just make the Python tab the default first tab, which is clearer anyway.

Fixes #9575.
 2019-01-16 10:05:25 -08:00
Anders Kaseorg 2ad1a27b28 create-production-venv: Remove Python 2 support. 
We still create a Python 2 virtualenv for thumbor but that’s
separate (/srv/zulip-thumbor-venv from
scripts/lib/create-thumbor-venv).

Signed-off-by: Anders Kaseorg <andersk@mit.edu>
 2019-01-09 17:32:05 -08:00
Eeshan Garg 9c589ac7d9 api docs: Stop mentioning "dev servers" in JS code examples. 
Since the Zulip API runs on both developement and production
servers, it is misleading to mention "dev servers" when discussing
zuliprc files.

Also, note that it is better to manually edit all of our JS
examples than to implement macro-like functionality that we use
for our Python examples. For our current purposes, it would be
too much work to build a full-blown testing framework for our
JS code examples just so that we can fix a minor wording issue.

Fixes #10672.
 2019-01-07 09:14:25 -08:00
Joshua Pan ad1df0ebeb settings: Add support for customizing the top-left logo. 
This adds a new realm_logo field, which is a horizontal-format logo to
be displayed in the top-left corner of the webapp, and any other
places where we might want a wide-format branding of the organization.

Tweaked significantly by tabbott to rebase, fix styling, etc.

Fixing the styling of this feature's loading indicator caused me to
notice the loading indicator for the realm_icon feature was also ugly,
so I fixed that too.

Fixes #7995.
 2018-12-18 12:44:52 -08:00
Tim Abbott 3003517430 docs: Move mypy documentation from contributing to testing. 
The testing section is more appropriate, since it's fundamentally part
of our CI system.

While we're at it, fix the fact that we were linking to GitHub, not
ReadTheDocs, in the run-mypy output.
 2018-12-16 21:52:53 -08:00
Roger Souza 69da22d998 api docs: Document the custom emoji upload endpoint. 
Tweaked by tabbott to fix some English phrasing and make the file
pointer thing require less Python knowledge.

Fixes: #10746.
 2018-12-14 14:19:28 -08:00
Steve Howell ced4d81856 Sweep tests for expected_subject -> expected_topic. 
This is all in the webhooks tests, including some
docs for how to write those tests.
 2018-11-12 15:47:11 -08:00
Roman Godov aa3682f9fc api: Add GET /user_groups documentation. 
This documents our GET endpoint for interacting with Zulip's user
groups feature.

Fixes #10298.
 2018-11-08 22:19:30 -08:00
Tim Abbott 8c8cb725bf api: Clarify slack-format outgoing webhook docs. 
The previous discussion was confused about the fact that Slack sends
the outgoing webhook requests, not receives them.
 2018-11-08 22:13:15 -08:00
Eeshan Garg 5c8b774628 outgoing-webhooks.md: Document example endpoint responses. 2018-11-08 22:07:56 -08:00
Eeshan Garg c6dd801525 docs: Fix a couple of broken links. 
For the PHP link, I just found an equivalent link that detailed
some well-known PHP security vulnerabilities.

As for the now defunct RequestBin, another instance is hosted
by another domain, so we can recommend using that for now.
 2018-11-06 12:54:36 -08:00
Rishi Gupta 1c264dedc5 api docs: Change Shakespeare quote. 
The previous quote doesn't come off well if you don't know the reference
(which the majority of our users will not).
 2018-10-22 15:44:36 -07:00
Rishi Gupta c37384f63d api docs: Update writing-bots. 
Removes the intro material since there are better places for it.
 2018-10-20 13:31:19 -07:00
Rishi Gupta 6b8de50c50 api docs: Update running-bots. 
This page still has some work needed, but will probably require coordination
with the product work as well.
 2018-10-20 13:31:19 -07:00
Rishi Gupta 796a1a6582 api docs: Update non-webhook-integrations.md. 
Addresses comments on a8e1225.
 2018-10-20 13:31:19 -07:00
Eeshan Garg b31bbbe649 api_docs: Use tabbed_sections extension in new API docs. 2018-10-17 15:32:35 -07:00
Eeshan Garg 5275d49f05 api_docs: Properly escape arguments passed to curl. 
Fixes #8484.
 2018-10-17 15:32:35 -07:00
Rishi Gupta d76f728dda api docs: Rename webhook-walkthrough to incoming-webhooks-walkthrough. 2018-10-16 21:07:00 -07:00
Rishi Gupta 6a352ab249 api docs: Add script and plugin integrations to integrations-overview. 2018-10-16 21:07:00 -07:00
Rishi Gupta df20f1a47f api docs: Rename integration-guide.md to non-webhook-integrations.md. 2018-10-16 21:07:00 -07:00
Rishi Gupta cd81b0766a api docs: Move references to integration-guide to integrations-overview. 2018-10-16 21:06:59 -07:00
Rishi Gupta a8e1225a6b api docs: Update integration-guide. 2018-10-16 21:06:59 -07:00
Rishi Gupta c3eb922559 api docs: Move general advice to incoming webhooks guide. 
One of the bullets does reference APIs, which aren't relevant to incoming
webhooks, but decided to leave it as is.
 2018-10-16 21:06:59 -07:00
Rishi Gupta decc5352aa api docs: Update webhook-walkthrough. 2018-10-16 21:06:59 -07:00
Rishi Gupta 47cddf4acf api docs: Update incoming-webhooks-overview.md. 2018-10-16 21:06:59 -07:00
Rishi Gupta 4abce1783f api docs: Restructure integrations section and add an overview. 2018-10-16 21:06:59 -07:00
Tim Abbott 6487d956fe api docs: Fix typo in URL for bulk-mark-as-read. 2018-10-16 13:03:59 -07:00
Yago González 029d815be7 api docs: Document the /dev_fetch_api_key endpoint. 2018-10-16 12:47:12 -07:00
Yago González 3eeec94d03 api docs: Document the POST /users/me/subscriptions/properties endpoint. 2018-10-16 12:38:27 -07:00
Yago González 3d2b3f8fa4 api docs: Document the POST /messages/flags endpoint. 2018-10-16 12:19:24 -07:00
Yago González 7a4103eee6 api docs: Document POST /mark_(all|stream|topic)_as_read. 2018-10-16 12:12:05 -07:00
Tim Abbott 5272ac8c39 api docs: Fix a broken linkification filters link. 2018-10-16 12:03:38 -07:00
Tim Abbott d13bd6e8d3 linkifiers: Rename articles to current feature name. 
These were previously called "linkification filters", but we now want
to consistently refer to them as "linkifiers" in the UI and API docs.
 2018-10-16 12:01:17 -07:00
Yago González 3bdc8f9946 api: Document the GET /realm/emoji endpoint. 2018-10-16 11:51:48 -07:00
Yago González 7a7b507e86 api docs: Document DELETE /realm/filters/<filter_id>. 2018-10-16 11:51:48 -07:00
Yago González a7c48acc8e api docs: Document GET /realm/filters. 2018-10-16 11:51:48 -07:00
Steve Howell 395d74c08a api docs: Clean up outgoing webhooks section. 
I rewrote the section explaining what the
endpoint sends back to the server.  This fixes
a few typos, emphasizes the normal case, and
starts to favor "content" as the key for
content.
 2018-10-11 16:12:07 -07:00
Tim Abbott 83bcea3917 api: Fix docs to point to /latest/ for integration docs. 
Pointing to /stable/ doesn't work, since that article doesn't exist in
the 1.8.0 release series.
 2018-10-10 12:19:14 -07:00
Rishi Gupta bf22eefede api docs: Move integration-docs-guide to docs/. 2018-10-09 20:28:44 -07:00
Callum Fraser 383f1633e6 api: Add limit of total messages available per request of 5000. 
Tweaked by tabbott to use a declared constant rather than just use
5000 in multiple places; this also means we can change the count
without updating translations.

Fixes #10446.
 2018-10-09 15:43:21 -07:00
Tim Abbott a943e55863 docs: Move LDAP documentation out of plug-and-play section. 
Also update the links to this section.
 2018-09-27 13:38:14 -07:00
Rishi Gupta 7f16d27015 api docs: Update api-keys. 2018-09-25 21:02:58 -07:00
Rishi Gupta 78f8fac106 api docs: Make minor copyediting changes. 2018-09-25 20:48:12 -07:00
Eeshan Garg 0817905480 api docs: Use Markdown extension for tabbed sections. 2018-09-18 13:49:34 -07:00
Yago González ea10f5eb2c api docs: Document GET /users/<email>/presence. 
Tweaked by tabbott to describe more clearly what this is for.
 2018-08-31 15:15:54 -07:00
Yago González 78f85ef960 api docs: Document the GET /messages/<message_id>/history endpoint. 2018-08-28 17:33:02 -07:00
Yago González 5c6f381f32 api docs: Document the DELETE /messages/<message_id> endpoint. 2018-08-28 17:26:49 -07:00
Yago González 9575f1b51f api docs: Document the GET /messages/<message_id> endpoint. 2018-08-28 17:22:28 -07:00
Yago González ab164ba740 api docs: Document the GET /messages endpoint. 2018-08-28 17:17:46 -07:00
Yago González c36cf95dc8 api docs: Document GET /server_settings. 2018-08-27 17:45:50 -07:00
Tim Abbott 0af7a12197 api: Fix typos in doc on constructing narrows. 2018-08-27 17:37:37 -07:00
Lyla Fischer 1efcdfdb5c templates: Merge Help and API doc main into documentation_main. 
With minor fixes by eeshangarg.
 2018-08-27 20:19:24 -02:30
Yago González 54464feda7 api docs: Document the PATCH /users/me/subscriptions/muted_topics endpoint. 2018-08-26 23:10:21 -07:00
Yago González e7c7b19507 api docs: Document POST /realm/filters. 2018-08-22 17:42:14 -07:00
Yago González fcf1e3cd88 api docs: Add guide for creating narrows. 
Dramatically edited by tabbott to simplify the discussion and
duplication of content in our main search documentation.
 2018-08-22 17:16:27 -07:00
Yago González aa5185fdf8 api docs: Document POST /typing. 2018-08-17 12:57:40 -07:00
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