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

310 Commits

Author SHA1 Message Date
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 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
Rishi Gupta 7956c57448 user docs: Add import-from-hipchat. 2018-10-09 15:23:07 -07:00
Lyla Fischer 3c51328763 user docs: Remove icon-vector for font-awesome. 2018-10-09 14:16:16 -07:00
Rishi Gupta 8c0bfb925d integration docs: Change location of bot_types.png. 
Fixes broken test in 53a2f71.
 2018-10-01 12:42:29 -07:00
Rishi Gupta 0d1907fb71 user docs: Add test-mobile-notifications. 2018-09-28 12:09:33 -07:00
Shubham Dhama 8c6424a4bd user docs: Split and update add-a-bot-or-integration.md. 2018-09-25 20:48:12 -07:00
Rishi Gupta f2b4357d67 user docs: Remove link to #status-messages from left sidebar. 2018-09-18 14:48:17 -07:00
Rishi Gupta 669c2fd752 user docs: Update verify-your-message-was-successfully-sent. 2018-09-18 14:47:33 -07:00
Eeshan Garg 1a3a791e0b rest-endpoints.md: Remove duplicate heading. 2018-09-17 13:28:30 -04:00
Rishi Gupta 976b5603ce user docs: Update enable-enter-to-send. 2018-09-16 18:03:10 -07:00
Rishi Gupta f56a76b53d user docs: Update manage-your-uploaded-files. 
Eventually this should probably just be a document on deleting files.
 2018-09-16 18:03:10 -07:00
Rishi Gupta 5b839a90ab user docs: Update upload-and-share-files. 2018-09-16 18:03:09 -07:00
Rishi Gupta 5fcd96b8a1 user docs: Update add-emoji. 2018-09-16 18:03:09 -07:00
Rishi Gupta 0eba0dfdc8 user docs: Remove send-a-message-in-a-different-language. 
A valiant effort, but there are too many operating systems to do this
well.
 2018-09-16 18:01:18 -07:00
Rishi Gupta e46d3705de user docs: Remove several "send a message" docs. 
These are now subsumed by compose-and-reply. Probably we'll want to write a
"PMs and Group PMs" doc at some point so that we have something if people
search for whether Zulip has Group PMs.
 2018-09-16 15:04:05 -07:00
Rishi Gupta 7f2e428541 user docs: Add macro for opening the compose box. 2018-09-16 15:04:05 -07:00
Rishi Gupta 02be6c1530 user docs: Add compose-and-reply. 2018-09-16 14:54:42 -07:00
Rishi Gupta 957b4af81f user docs: Remove the-zulip-browser-window. 
This is one of the earliest user docs we wrote (Jan 2017), and no longer
fits with our current docs strategy.
 2018-09-16 10:33:39 -07:00
Rishi Gupta 91c58987bf user docs: Update change-your-settings. 2018-09-16 10:26:40 -07:00
Rishi Gupta 404f4e3560 user docs: Update emoji-reactions. 2018-09-16 10:13:43 -07:00
Rishi Gupta cd57a8ede4 user docs: Update share-a-message-or-conversation. 2018-09-16 10:13:43 -07:00
Rishi Gupta 4c7bafd886 user docs: Remove the down-chevron macro. 2018-09-16 08:36:41 -07:00
Rishi Gupta 655820c13d user docs: Update the message-actions macro. 2018-09-16 08:36:41 -07:00
Rishi Gupta da759d60f8 user docs: Add the message-actions-menu macro. 2018-09-16 08:36:41 -07:00
Rishi Gupta 7f1e159a45 user docs: Remove a few articles from Reading messages. 
This content would be most useful in some sort of guide, perhaps an article
like "navigation and unread counts".
 2018-09-16 08:24:28 -07:00
Rishi Gupta bad4a2e8ca user docs: Update invite-a-friend-to-zulip. 2018-09-16 08:24:28 -07:00
Rishi Gupta b9f227edec user docs: Remove settings.md macro. 2018-09-16 00:32:57 -07:00
Rishi Gupta 2a7e5f1ce8 user docs: Remove unused macros. 2018-09-16 00:31:01 -07:00
Rishi Gupta 29abb80c96 user docs: Remove view your stream subscriptions from the sidebar. 2018-09-15 23:57:22 -07:00
Rishi Gupta c8a9ab121d user docs: Update the stream-actions macro. 2018-09-15 23:57:22 -07:00
Rishi Gupta 0b77feaf93 user docs: Remove doc for digest emails. 
This hasn't been on in production for months.
 2018-09-15 18:18:02 -07:00
Rishi Gupta 84f24d2aa6 user docs: Update add-an-alert-word. 2018-09-15 18:18:02 -07:00
Rishi Gupta 253aa95d4c user docs: Update change-your-organization-settings. 2018-09-14 22:07:46 -07:00
Rishi Gupta 087a50bb88 user docs: Update go-to-stream-via-all-streams. 
Got a support request for someone following these instructions who missed
that step, so putting it on its own line. It's relatively easy to miss since
it's the only instruction that's not in bold.
 2018-09-14 22:07:46 -07:00
Rishi Gupta 7e2f686240 user docs: Add moderating open organizations. 2018-09-14 22:07:46 -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
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
Rishi Gupta e31fa7edfe integration docs: Note that the stream name has to be URL-encoded. 2018-08-26 22:58:16 -07:00
Rishi Gupta e9e2721aa2 integration docs: Simplify create a bot instructions. 2018-08-26 22:58:16 -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
Rishi Gupta 36d495736a user docs: Rename display-emoji-as-text. 2018-08-20 19:24:36 -07:00
Rishi Gupta 9a759060cd user docs: Remove outdated app guides. 2018-08-20 18:52:04 -07:00
Rishi Gupta 0f44d380ca user docs: Update save-changes.md. 2018-08-20 17:11:53 -07:00
Lyla Fischer 172cde6af6 user docs: Add restrict-bot-creation. 2018-08-20 15:50:16 -07:00
Lyla Fischer c183c5059e user docs: Update change-the-privacy-of-a-stream. 2018-08-20 15:02:39 -07:00
Lyla Fischer 6fc214929c user docs: Update delete-a-stream. 2018-08-20 15:02:39 -07:00
Rishi Gupta 5bc3dd4a57 user docs: Update notification docs. 2018-08-19 06:34:03 -07:00
Yago González aa5185fdf8 api docs: Document POST /typing. 2018-08-17 12:57:40 -07:00
Rishi Gupta e25ac1dd6c user docs: Add custom profile field docs. 2018-08-17 11:32:05 -07:00
Lyla Fischer c86dc45bf9 user docs: Update change-the-topic-of-a-message. 2018-08-15 16:24:57 -07:00
Lyla Fischer 9ba0aaefa2 user docs: Add community-topic-edits. 2018-08-15 16:24:57 -07:00
Rishi Gupta 4a3aaf5075 user docs: Remove high contrast mode from index. 2018-08-15 14:55:06 -07:00
Lyla Fischer 0c0b9d7de6 user docs: Update language in admin-only. 2018-08-15 12:10:26 -07:00
Tim Abbott a8d0fdce64 API: Reorganize message section of endpoints index a bit. 2018-08-08 09:43:01 -07:00
Rishi Gupta 71fb8d6195 user docs: Rename require-topics.md. 2018-07-29 23:55:33 -04:00
Lyla Fischer de8014a031 user docs: Update restrict-create-new-streams. 2018-07-29 22:46:48 -04:00
Lyla Fischer ba791b7071 user docs: Remove add-a-link-preview since it is a server admin doc. 2018-07-29 20:32:46 -04:00
Rishi Gupta 1710a9070a user docs: Add export-your-organization. 2018-07-27 10:52:27 -07:00
Rishi Gupta 5e7fd3a3cf docs: Move server import and export from /help to readthedocs. 2018-07-27 10:37:50 -07:00
Abhigyan Khaund 40540d4312 user docs: Add "Using a custom certificate". 2018-07-26 16:32:45 -07:00
Abhigyan Khaund 82770a636f user docs: Add connect through a proxy. 2018-07-26 16:32:45 -07:00
Tim Abbott 879aa130ad api docs: Move "Get stream ID" to end of the streams endpoint section. 
This seemed overally emphasized in the previous order.
 2018-07-26 15:42:58 -07:00
Yago González cb24756edc api docs: Merge docs for sending stream and private messages. 2018-07-26 10:24:01 -07:00
Rishi Gupta 9d55152b1b user docs: Rename import-data-from-gitter. 2018-07-24 18:55:07 -07:00
Rishi Gupta d9f61f2b94 user docs: Rename import-data-from-slack. 2018-07-24 18:45:56 -07:00
Rhea Parekh 73862e89ae gitter import: Add documentation. 2018-07-23 08:46:19 -07:00
Lyla Fischer e07bf51fc9 user docs: Update the message-actions template. 2018-07-20 10:10:17 -07:00
Lyla Fischer 010dbcc49f user docs: Trim language in mute-a-stream. 2018-07-20 07:59:29 +05:30
Lyla Fischer f3b0b8edc8 user docs: Remove the admin.md macro. 2018-07-19 22:30:51 +05:30
Rishi Gupta b6d1b956f2 user docs: Rename restrict-editing-of-old-messages-and-topics. 2018-07-19 22:30:51 +05:30
Rishi Gupta b514cf66a1 user docs: Remove only-allow-admins-to-invite-new-users. 
The information here was recently added to
manage-who-can-join-and-invite.md.
 2018-07-19 22:25:58 +05:30
Rishi Gupta 72c0b57aa3 user docs: Remove allow-anyone-to-join-without-an-invitation. 
The information here was recently added to manage-who-can-join-and-invite.

Arguably this is one we should save, since it is a distinctive feature not
offered by all of our competitors, and it gets some additional visibility by
being in the left sidebar. The model of having multiple things in the
sidebar pointing to the same article is getting messy though, and as our
feature count increases the cost of having stuff in the left sidebar is
increasing as well.
 2018-07-19 22:25:58 +05:30
Rishi Gupta eab1142200 user docs: Remove restrict-user-email-addresses-to-certain-domains. 
The information from this doc was recently added to
manage-who-can-join-and-invite.md.
 2018-07-19 22:25:58 +05:30
Rishi Gupta ce1875533e user docs: Add manage-who-can-join-and-invite.md. 
As we add more and more features, we'll want to consolidate articles into
feature bundles.
 2018-07-19 22:25:58 +05:30
Lyla Fischer 371e058972 user docs: Trim the language and usage of save-changes.md. 2018-07-11 10:04:49 +05:30
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
Lyla Fischer d98c2e02b4 user docs: Remove admin-only stream management from member docs. 2018-06-27 11:52:41 -07:00
Yago González 8e50564717 api docs: Document the /users/me/<stream_id>/topics endpoint. 2018-06-23 12:42:11 +02:00
Rishi Gupta f52765be5b user docs: Update create-your-organization-profile. 2018-06-21 12:47:19 -07:00
Lyla Fischer c9455b732e user docs: Update high-contrast-mode.md. 2018-06-21 11:27:07 -07:00
Lyla Fischer e606ae0c47 user docs: Add display-emoji-as-text. 2018-06-21 11:27:07 -07:00
Rishi Gupta bccf2ca67b integrations: Update Matrix and IRC docs. 2018-06-20 19:07:18 -07:00
Eeshan Garg 00c5afb491 integrations: Point IRC and Matrix docs to the same macro. 
Both the integrations use our new Matrix integration (with only one
additional paragraph for the IRC docs), so docs for both should point
to the same underlying Markdown macro for configuring a Matrix bridge.

This is a follow-up to #9491.
 2018-06-20 10:50:54 -04:00
Lyla Fischer d43ccdde7f user docs: Document admin-only posting in stream-permissions.md. 2018-06-19 17:40:16 -07:00
Lyla Fischer bded247cb6 user docs: Edit enable-night-mode. 2018-06-19 17:06:26 -07:00
Lyla Fischer afb60a6fe9 user docs: Document deactivation of account and org. 2018-06-19 16:33:12 -07:00
Lyla Fischer d6a32de3ce user docs: Update and rename view-an-image-at-full-size.md. 2018-06-19 15:53:41 -07:00
Eeshan Garg d74ddcac95 integrations/matrix: Update docs to conform to style guide. 
This is a follow-up to #9491.
 2018-06-16 08:52:49 -07:00
Rhea Parekh ae71aa6084 docs: Add macro for import docs "logging in" section. 
Fixes #9550.
 2018-05-31 08:46:52 -07:00
Rhea Parekh 25ac6e812f Matrix: Create 'install-matrix' macro. 
'install-matrix' is used twice, in 'integrations/irc.md'
and 'integrations/matrix.md'. Hence we create a macro for
it.
 2018-05-30 10:47:02 -07:00
Lyla Fischer b446bf3cae user docs: Add doc for stream privacy settings. 2018-05-26 10:04:46 -07:00
Tim Abbott 1cdcf607a3 docs: Document the Zulip GDPR compliance story. 2018-05-25 15:06:02 -07:00
Tim Abbott c67833f888 help: Add proper documentation of Zulip import/export process. 
Based on an original version written by Rishi, but this has been
basically rewritten by tabbott.

We also clean up one confusing part of our Slack docs.
 2018-05-25 12:19:34 -07:00
Lyla Fischer 98c50f7041 user docs: Update time-format docs. 2018-05-16 16:17:39 -04:00
Eeshan Garg c68627a834 config-file-macro: Specify full path to integration scripts. 2018-05-15 18:02:56 -04:00
Eeshan Garg f29b9f14fd integrations: Update docs for git and codebase. 
Doing both as once due to the common dependency on
change-zulip-config-file-indented.md.
 2018-05-15 18:02:56 -04:00
Yago González f0fa550001 docs: Rename rest_endpoints with dashes. 2018-05-15 09:06:56 -07:00
Tim Abbott 6cca334271 api: Document the /register API with a lot more detail. 2018-04-27 17:01:41 -07:00
Tim Abbott 9fc1458924 api: Improve documentation for real-time-events API. 2018-04-27 16:36:54 -07:00
Tim Abbott 89704df167 /api: Move list of REST endpoints to a template. 2018-04-16 15:50:53 -07:00
Lyla Fischer 390eeaab5b help: Remove follow-steps doc macro. 2018-04-11 16:44:08 -07:00
Lyla Fischer 00255ad7c0 help: Remove the go-to-the macro. 2018-04-11 16:44:08 -07:00
Eeshan Garg 42fb91de33 macros: Update link to installation instructions for API bindings. 
This changed a while ago when we restructured our API docs.
 2018-04-05 14:48:37 -07:00
Tim Abbott 500fa9d2c1 webhooks: Improve explanation of setting specific topics. 2018-03-18 10:53:45 -07:00
Eeshan Garg 8fbd8c68f4 webhooks: Update macros to specify custom topics and default PMs. 
These changes are the result of migrating to
check_send_webhook_message.
 2018-03-18 10:53:45 -07:00
amanagr 301a28e58e docs: Add user guide for `Zulip in a Terminal`. 
Text tweaked by tabbott.

Fixes #3361.
 2018-03-15 15:13:05 -07:00
Lyla Fischer 7ce139a798 user docs: Remove view-messages-containing-files-or-links. 2018-03-12 20:07:17 -07:00
Lyla Fischer a94325de53 user docs: Move private message information to view-your-pms-and-group-pms. 2018-03-12 20:06:12 -07:00
Lyla Fischer ffa629bee5 user docs: Merge view-messages-from-a-stream and view-messages-from-a-topic. 2018-03-12 20:06:04 -07:00
Lyla Fischer e53f334fd6 user docs: Merge add and remove someone from a stream. 2018-03-12 18:14:17 -07:00
Lyla Fischer 835ac3dd85 user docs: Split label for change-the-privacy-of-a-stream. 2018-03-12 18:14:17 -07:00
Lyla Fischer 7912a118bf user docs: Add 'or archive' to label of delete-a-stream. 2018-03-12 18:14:17 -07:00
Lyla Fischer 502264f208 user docs: Merge user restrictions on email address and name. 2018-03-12 18:14:17 -07:00
Lyla Fischer e396897a06 user docs: Merge docs for organization name, avatar, and description. 2018-03-12 16:53:59 -07:00
Lyla Fischer 9b30fc9bf1 user docs: Add reference to notify-everyone-on-a-stream to notifications. 2018-03-12 16:53:54 -07:00
Lyla Fischer d85a5562fb user docs: Marge audible-notifications into desktop-notifications. 2018-03-12 16:53:45 -07:00
Vishnu Ks e5fb0961f5 help: Rename signing-out.md to logging-out.md. 2018-03-09 13:31:36 -08:00
Vishnu Ks ff3a8f27c7 help: Rename signing-in.md to logging-in.md. 2018-03-09 13:31:36 -08:00
Lyla Fischer 96c5bf5dcc user docs: Move make-an-announcement to notify-everyone-on-a-stream. 2018-03-06 17:11:20 -08:00
Lyla Fischer 05e18ef60b user docs: Merge two private message docs and mention shortcut. 2018-03-06 17:11:20 -08:00
Marco Burstein bdb86f1b5e emoji: Add support for translating emoticons. 
Add `translate_emoticons` to `prop_types` and `expected_keys`.
Furthermore, create a emoji-translating Markdown inline pattern.

Also use a JavaScript version of `translate_emoticons` and then use
this function during Markdown previews and as a preprocessor. This
is only needed for previews, because usually emoticon translation
happens on the backend after sending.

Add tests for emoticon translation, a settings UI, and a /help/ page
as well.

Tweaked by tabbott to fix various test failurse as well as how this
handles whitespace, requiring emoticons to not have adjacent
characters.

Fixes #1768.
 2018-03-04 15:37:24 -08:00
Lyla Fischer 2692ffd408 user docs: Split sidebar link for change-the-privacy-of-a-stream. 2018-03-01 15:11:05 -08:00
Lyla Fischer 63841f4567 user docs: Add 'See all images in a narrow' to sidebar. 2018-03-01 15:11:05 -08:00
Lyla Fischer 1bd56d416e user docs: Reword sidebar link for mute-a-topic and mute-a-stream. 2018-03-01 15:11:05 -08:00
Eeshan Garg 6ddc0b75ac webhook_md_macros: Stop using transition words. 
Transition words make it harder to reuse macros in different
contexts and can lead to unintended errors. Thanks to Rishi
Gupta for suggesting this!
 2018-02-24 06:21:02 -05:00
Eeshan Garg 0d39b05cf6 webhooks/beanstalk: Update text and remove screenshots. 
This commit:

* Removes the unnecessary screenshot.
* Reorders the instructions and combines them in to 4 steps.
* Improves the contents of the webhook-url-with-bot-email-indented.md
  macro and makes it more consistent with create-bot-construct-url.md.
* Sets the recommended stream name to "commits", since that's what
  the webhook function for Beanstalk expects in
  zerver/webhooks/beanstalk/view.py. This allows us to use the
  create-stream.md macro.
 2018-02-24 06:21:02 -05:00
Eeshan Garg e94efe5497 markdown macros: Add create-a-bot-indented macro. 2018-02-24 06:21:02 -05:00
Rishi Gupta 9449556eff integrations: Add missing instruction to create-a-bot docs macros. 2018-02-13 21:47:39 -03:30
Eeshan Garg 929724e5e7 api docs: Add page for common error payloads. 
We now have a separate page for common error payloads, for example,
the payload for when the client's API key is invalid. All error
payloads that are presented on this page will be tested similarly
to our other non-error sample fixtures.
 2018-02-08 17:58:41 -08:00
Eeshan Garg ab700fb662 markdown: Add a macro with instructions for creating a bot. 2018-02-08 16:22:55 -08:00
Eeshan Garg d46753c26d markdown: Remove macro for successful API JSON response. 
Now that we have a Markdown extension-based test framework for
generating and testing code examples on our /api pages, we don't
need this macro anymore!
 2018-01-31 07:30:54 -05:00
Jerry Zhang 15ac79cb51 user docs: Add user guide for enabling night mode. 
Advertisement for the feature tweaked by tabbott.

Fixes #7405.
 2018-01-24 15:16:28 -08:00
Brock Whittaker 6b03e25382 help: Add "Add a link preview" documentation. 
This is a server setting so I created the section "Server settings" in the help sidebar for this to go under, and rewrote the copy and retook the images that were originally done by @Privisus due to some issues.
 2018-01-19 06:15:30 -05:00
Rhea Parekh dd51f348e5 Slack importer: Update documentation. 2018-01-08 08:05:50 -05:00
Jerry Zhang 535e6bd218 user docs: Add user guide for configure authentication methods. 
Fixes #3357.
 2017-12-31 08:09:47 -05:00
Eeshan Garg 229cdfce90 markdown: Add a macro for invalid API key JSON response. 
The JSON response for when an invalid API key is used to initiate
an API call seems to be identical in every case, so this macro
can be reused all the time.
 2017-12-29 17:03:36 -05:00