Commit Graph

860 Commits

Author SHA1 Message Date
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
Lyla Fischer 9f80322a35 user docs: Update custom-linkification doc. 2018-07-29 20:32:46 -04:00
Lyla Fischer 225aaba2fb user docs: Update configure-authentication-methods. 2018-07-29 20:32:46 -04:00
Lyla Fischer c6938a42d6 user docs: Update add-custom-emoji. 2018-07-29 20:32:46 -04:00
Rhea Parekh 104b2342d9 docs: Update import-from-gitter doc.
The changes here are primarily to better document how to get a Gitter
API token.
2018-07-28 15:43:12 -07:00
Shubham Padia e276006d8c help: Replace dead link to function support wiki in KaTex.
Fixes #10091.
`https://github.com/Khan/KaTeX/wiki/Function-Support-in-KaTeX` has
been moved from the wiki to the docs at
https://khan.github.io/KaTeX/docs/supported.html in
https://github.com/Khan/KaTeX/pull/1484.
2018-07-28 08:33:59 -07: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
Sujeet Kausallya Gholap b5cae68f24 docs: Fix typo: premise -> premises. 2018-07-27 00:11:09 -07:00
Rishi Gupta 8b2cafa111 user docs: Explain streams are similar to channels in stream-permissions. 2018-07-26 21:49:26 -04: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
Harshit Bansal cf5b2b4815 emoji: Change emoticon mapping for `:)`, `(:` and `:(`.
See discussion on CZO:
https://chat.zulip.org/#narrow/stream/101-design/subject/emoji.20picker/near/617811
2018-07-26 11:17:03 -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 5e2ee5f4fc user docs: Note users can only import into new orgs in import-from-*. 2018-07-24 19:24:06 -07:00
Rishi Gupta 3f0257e758 user docs: Ask for subdomain in import-from-* when importing to zulipchat. 2018-07-24 19:24:06 -07:00
Rishi Gupta 528b2bc48d user docs: Add reference to gitter in import/export doc. 2018-07-24 18:55:08 -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
Rishi Gupta c010a704de user docs: Add import into zulipchat.com section to gitter import guide. 2018-07-24 15:59:02 -07:00
Rishi Gupta 5581586c5c user docs: Fix wording in import-data-from-gitter. 2018-07-24 15:59:01 -07:00
Rishi Gupta 1b27f2cf58 user docs: Add import into zulipchat.com section to slack import guide. 2018-07-24 15:58:56 -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 73862e89ae gitter import: Add documentation. 2018-07-23 08:46:19 -07:00
Lyla Fischer ccba727919 user docs: Update mute-a-topic.md. 2018-07-20 10:10:17 -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 5a588353c1 user docs: Fix some wording in desktop notifications doc. 2018-07-20 07:24:49 +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 5ab373f714 user docs: Update article on configuring message editing and deletion. 2018-07-19 22:30:51 +05:30
Lyla Fischer efe22d339a user docs: Update disable-message-edit-history. 2018-07-19 22:30:51 +05:30
Lyla Fischer ad5f7a912e user docs: Update deactivate-or-reactivate-a-user. 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 c301148e5a user docs: Update join-zulip-chat-badge. 2018-07-19 22:20:53 +05:30
Lyla Fischer 9149ac1cf4 user docs: Update default language doc. 2018-07-18 20:21:37 +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
Lyla Fischer 371e058972 user docs: Trim the language and usage of save-changes.md. 2018-07-11 10:04:49 +05:30
Jack Zhang 456c8fed83 user-docs: Remove save-changes macro from configure-mobile-notifications.md.
The instruction to click a 'Save changes' button is incorrect, the
account settings UI automatically saves changes.
2018-07-02 10:40:11 -07:00
Jack Zhang 69fd8f2896 user-docs: Remove save-changes macro from configure-email-notifications.md.
The instruction to click a 'Save changes' button is incorrect, the
account settings UI automatically saves changes.
2018-07-02 10:40:11 -07:00
Jack Zhang 66a37558d4 user-docs: Remove save-changes macro from configure-email-digest-notifications.md.
The instruction to click a 'Save changes' button is incorrect, the
notifications settings UI automatically saves changes.
2018-07-02 10:40:11 -07:00
Jack Zhang 22cc3f9d74 user-docs: Remove save-changes macro from change-a-users-name.md.
The instruction to click a 'Save changes' button is incorrect, the
account settings UI automatically saves changes.
2018-07-02 10:40:11 -07: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
Rhea Parekh 2f88ca7446 slack import: Import skype and phone data of users. 2018-07-01 07:05:40 -07:00
Lyla Fischer d71bc75a2e user docs: Add troubleshooting to desktop notifications docs. 2018-06-27 12:22:38 -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 add80f86f5 user docs: Update configure-desktop-notifications. 2018-06-22 10:08:08 -07:00
Lyla Fischer 8630e3deff user docs: Update desktop notifications article. 2018-06-22 09:00:28 -04:00
Rishi Gupta f52765be5b user docs: Update create-your-organization-profile. 2018-06-21 12:47:19 -07:00
Rishi Gupta 9a5f1492d4 user docs: Fix link to display-emoji-as-text. 2018-06-21 11:51:39 -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 e417e2b62a user docs: Edit change-your-language. 2018-06-19 16:43:42 -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
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
Rhea Parekh b47bc0e082 docs: Remove customprofilefield from caveats in slack import doc.
This was added in #9035
2018-06-02 09:01:55 -07:00
Rhea Parekh f8e53511ea slack import: Add support for bold-italics formatting.
Fixes #8927
2018-06-02 09:01:55 -07:00
Anupam Dagar 9674a139bf hotkeys: Change * to Ctr+s for starring a message.
Fixes: #9613.
2018-06-01 09:53:15 -07:00
Lyla Fischer 7fba0f1505 user docs: Update logging-in.md. 2018-06-01 01:39:45 -04:00
Lyla Fischer 2807189d87 user docs: Update join-a-zulip-organization. 2018-06-01 01:37:30 -04:00
Rhea Parekh ae71aa6084 docs: Add macro for import docs "logging in" section.
Fixes #9550.
2018-05-31 08:46:52 -07:00
Tim Abbott 2aa8f214d4 glossary: Fix confusing discussion of integrations.
We now have more integration types, anyway.
2018-05-30 18:22:31 -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
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
Robert Hönig fe6b46dfa6 docs: Consistently use Botserver instead of botserver or bot server. 2018-05-29 07:27:33 -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
Tim Abbott 23c4a25041 help: Fix a misplaced period. 2018-05-21 14:47:11 -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
Rishi Gupta a422165662 help: Make minor edit to change-the-time-format. 2018-05-17 12:07:37 -04:00
Lyla Fischer c29fc8f0c3 user docs: Update logging-out doc. 2018-05-16 16:17:39 -04:00
Lyla Fischer 98c50f7041 user docs: Update time-format docs. 2018-05-16 16:17:39 -04:00
Lyla Fischer a1c26dcc71 user docs: Update avatar 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 bc403fc4c4 i18n: Tag missing strings for translation. 2018-05-15 09:06:56 -07:00
Yago González f0fa550001 docs: Rename rest_endpoints with dashes. 2018-05-15 09:06:56 -07:00
Rishi Gupta 01a7ed952d user docs: Update a few articles in account basics. 2018-05-08 17:30:08 -07:00
Tim Abbott ee697f9090 docs: Document the topic-link feature of our realm filters.
This isn't the best writeup, but having this here will help ensure we
do document this in a future edit pass on this document.
2018-05-07 20:30:48 -07:00
Aastha Gupta 19806a0283 keyboard UI: Add Ctrl + k hotkey.
Fixes #8216
This commit binds the Ctrl + k to go to the search bar.
2018-05-06 19:19:00 -07:00
Lyla Fischer aee02e2695 user docs: Add styling for keyboard_tip admonition. 2018-05-03 18:33:35 -07:00
Yashashvi Dave 7bbe44d7a0 org settings: Remove "Delete streams" administrative tab from settings.
Fixes #9227
2018-04-30 17:47:34 +05:30
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 9c04db1c66 slack import: Clarify what --import-into-nonempty does. 2018-04-25 22:49:12 -07:00
Lyla Fischer 0f3cb14aae user docs: Use {settings_tab} macro for more organization settings. 2018-04-25 14:39:30 -07:00
Lyla Fischer dbc573584b user docs: Use the {settings_tab} macro for four organization settings. 2018-04-25 14:39:30 -07:00
Lyla Fischer b2be1a67f8 help docs: Add {settings_tab} for the first three org settings. 2018-04-25 14:39:30 -07:00
Lyla Fischer 68f68bf56d help docs: Use {settings_tab} macro for some user settings. 2018-04-25 14:39:30 -07:00
Lyla Fischer a4ea71ec0f help docs: Use {settings_tab|notifications} macro. 2018-04-25 14:39:30 -07:00
Lyla Fischer d40f246599 help docs: Use {settings_tab|display-settings}. 2018-04-25 13:51:29 -07:00
Lyla Fischer b24659b005 bugdown: Add {settings|my-setting} macro.
Tweaked by tabbott to add a test and fix a super subtle issue with the
relative_settings_link variable having been set once the first time a
/help article was rendered.
2018-04-25 13:41:24 -07:00
Tim Abbott 7ef23a0139 slack import: Document how to send password resets to all users.
This is likely to be an important follow-up step after one finishes
the Slack import.
2018-04-20 10:56:06 -07:00
Tim Abbott 2cc3fb7564 slack import: Fix documentation on path to run manage.py. 2018-04-19 10:32:58 -07:00
Tim Abbott bad04c761f docs: Recommend upgrading when doing Slack import. 2018-04-18 12:28:52 -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
Tim Abbott c3df378ca1 slack import: Document that this is a new feature in 1.8. 2018-04-08 07:11:07 -07:00
Rhea Parekh 2baa9bc16e Import: Add subdomain in the import script.
Also remove user input of subdomain in the slack data
conversion script.
2018-04-06 09:12:56 -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
Rishi Gupta a29b1c1569 help: Update change-your-name. 2018-04-05 14:46:32 -07:00
Rishi Gupta f4737e77b0 help: Update view-an-image-at-full-size. 2018-04-05 14:46:32 -07:00
Rishi Gupta efecad2355 help: Update view-and-edit-your-message-drafts. 2018-04-05 14:46:32 -07:00
Tim Abbott 57ca19392e help: Make API context available to sidebars.
I am not a fan of this API (where we need to pass context into
`render_markdown_path` directly), but it seems more robust to pass
this in directly.
2018-04-05 12:22:41 -07:00
Tim Abbott f1ece37455 help: Fix context not being passed properly to rendering.
This contributed to settings_html, subscriptions_html and friends not
being rendered properly in the /help/ views.
2018-04-05 11:43:48 -07:00
Rishi Gupta 5740af27d6 help: Update import-data-from-slack. 2018-04-05 08:49:40 -07:00
Tim Abbott ecec489e7e docs: Further update the Slack import instructions.
* Removes the confusing notes about supporting only the Slack standard
  plan.
* Removes the confusing notes about importing users from a
  different organization.
* Clarifies a few sections, improves formatting, etc.
2018-04-04 10:38:29 -07:00
Rhea Parekh 48e219e880 docs: Update import data from slack doc. 2018-04-04 10:18:59 -07:00
Anurag Sharma 1227857de6 hotkeys: Replace C with x for composing PM.
Pressing the 'x' key can now be used to compose a PM.
Pressing the 'C' key displays a modal that shows a deprecation notice.

Fixes #6548.
2018-04-01 16:13:05 -07:00
Rishi Gupta 96845147c9 help: Fix a few errors in edit-or-delete-a-message.md.
Still some errors (e.g. "Hover over a message to replace the message's
timestamp with its message actions" is no longer correct), and a lot of
other improvements to be made, but just doing a quick fix of a few things I
noticed.
2018-03-30 10:55:23 -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 e7005cfd0e help: Replace signin with login in zulip-on-android.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
Vishnu Ks 8da2820024 help: Replace signin with login in signing-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
amanagr 4d2c6efa09 help: Correct broken link and clarify email gateway integration.
This helps make it clear that this feature isn't supported on all
Zulip installations.
2018-03-05 09:26:10 -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
Tim Abbott ff197b209f help: Advertise custom linkification filters better.
Closes #5931, by merging the result of the discussion there.
2018-03-01 21:08:03 -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
Weronika Grzybowska 1f52eea0e4 user docs: Document auto-numbering of ordered lists.
Fixes #8246
2018-03-01 12:05:31 -08:00
Abhigyan Khaund a75f0aa594 hotkeys: Add "p" to narrow to next unread PM thread.
This works simimlar to the "n" key for next topics.

This commit does a few things:

    * It wires up the hotkey to an existing function
      that could change narrows.
    * It adds documentation.
    * It adds logic to make sure the compose box does
      not open.

@showell helped a bit with the wording of comments here.

Fixes #4874
2018-02-27 07:20:31 -05: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
Priscilla 6badac5d33 docs: Add v shortcut to the lightbox article. 2018-02-09 18:02:24 -08:00
Rhea Parekh 721a241901 slack importer: Update doc about slack user's skype and phone data. 2018-02-09 12:17:10 -08:00
Rhea Parekh 699021e7d8 slack importer: Update Documentation with slack's legacy token method. 2018-02-09 12:17:10 -08:00
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
Roman Godov b875fe07eb settings: Added setting to turn on and off realm name in email subject.
Users having only account in one realm will not be distracted by realm
name in subject lines of every email.  Users who have multiple
accounts in realms can turn this setting on and receive a
corresponding realm name in email's subject.

Tweaked by tabbott to rebase and address a few small issues.

Fixes #5489.
2018-02-05 18:01:54 -08:00
Tim Abbott 64cb05be67 import: Update the documentation slightly. 2018-02-05 14:53:07 -08:00
Rhea Parekh 78e0a2613f slack importer: Add documentation for Zulip default stream. 2018-02-05 14:46:39 -08:00
Balaji2198 f49d9d016f hotkeys: Add '>' as a hotkey for quote and reply to message.
Tweaked by tabbott to fix a few minor issues.

Fixes #8146.
2018-02-02 17:37:53 -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
rht 6b4f392ee9 Slack importer: Make it transparent to user which parts aren't mapped 1-to-1. 2018-01-23 10:36:14 -05:00
Cynthia Lin d449fcb309 user docs: Dynamically replace keyboard shortcuts for Mac OS. 2018-01-22 19:41:17 -05: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
Robert Hönig 93f47fa700 outgoing webhooks: Rename "Base URL" to "Endpoint URL".
Based on user feedback. "Endpoint URL" gives a clearer
idea of the field's purpose.
2018-01-16 08:11:51 -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
Cynthia Lin c31e148ea8 user docs: Add links back to homepage to the bottom of the sidebars. 2017-12-31 08:08:25 -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
Eeshan Garg 3a90a6be5e markdown: Add macro for successful send message JSON response.
The JSON response for when an API call to send a message is
successful is the same for both private and stream messages, so
these macros may be used again.
2017-12-29 17:03:36 -05:00
Rhea Parekh 01fa8416b1 Slack importer: Updating the documentation to the new method.
The already existing import-users-and-channels-from-slack.md file is
updated here to follow the new method.
2017-12-27 07:50:53 -05:00
civilnewsnetwork 0ce8b69fd6 Renamed 'Register' to 'Sign up' including translations 2017-12-18 10:02:15 -05:00
Rishi Gupta b8976ae4bd integrations: Improve wording in create-bot-construct-url.md. 2017-12-11 15:39:26 -06:00
Rishi Gupta f323d59ec0 org settings: Remove double negative from open realm setting.
The current wording is tricky to wrap one's head around.
2017-12-10 23:15:00 -08:00
AlloulDorian 39dc41f40b user docs: Add doc for video calls. 2017-12-07 16:57:50 -08:00
Cynthia Lin b7fb86b9ea user docs: Modify sidebar and index page styling. 2017-12-07 14:40:17 -08:00
Rishi Gupta 191f8f1b39 left sidebar: Change Home to All messages.
We made this change because users often unnecessarily click "Home"
first in their use of Zulip, because it seems appealing.  While "All
messages" isn't quite precise (it doesn't include muted streams), it
does describe relatively simply the interleaved view that this
represents.

This commit leaves everything as "home" in the code, and only changes
user-visible strings and docs. Changing the code will be a big project;
there are hundreds of relevant occurrences in variable names, etc.

Further, we'll probably want to convert those various variable names
in different ways.

Tweaked by tabbott to extend the commit message and update a few comments.
2017-11-28 15:42:58 -08:00
Eeshan Garg 880fd5497a markdown: Add indented versions of multi-line Markdown macros.
This is part of our efforts to change our integrations/webhooks
docs to follow the same sort of numbered-list format as our /help
docs. In order to indicate that paragraphs separated by newlines
are part of the same numbered-list point, every paragraph must be
indented 4 spaces.
2017-11-25 17:01:11 -08:00
derAnfaenger 73915a9631 docs: Move integration docs to /api. 2017-11-17 11:58:54 -08:00
derAnfaenger 6a72fcff9c docs: Fix outdated bots guide link. 2017-11-16 13:58:07 -08:00
Tim Abbott 638eb7a8e4 docs: Update links to ReadTheDocs to always use https.
This is better security practice.

We also add a lint rule to enforce this for the future.
2017-11-16 10:59:24 -08:00
Tim Abbott 054952a44a docs: Update links from codebase to point to ReadTheDocs. 2017-11-16 10:53:49 -08:00
Tim Abbott 07c2b205a4 docs: Update absolute links to point to new URLs.
This should get test-documentation and test-help-documentation passing
again after we moved everything around in the last commit.

There are a lot more absolute links (generally in code comments) to
update, but they are lower-priority and can be done in a follow-up
pass.
2017-11-16 10:08:22 -08:00
Brock Whittaker d2e55fa5c8 /api/ & /help/: Change index to <h1>.
The Index should be presented as an <h1> section and to the far left.
2017-11-08 13:01:33 -08:00
Brock Whittaker 228b0c4290 /help/: Add a slide class for sidebars that should have slide mechanism.
This adds a slide class that specifies that the JS actions for sliding
up and down sections is the desired behavior, along with a bit of CSS
to help display correctly in the case of not being a sliding section.
2017-11-08 13:01:33 -08:00
sagar-kalra c2f1f54190 help: Fix indentation of code blocks in desktop install guide.
Apparently, one can fix these by indenting 4 spaces beyond what would
have been sufficient to stay inside the bulleted lists.

Fixes #7075.
2017-11-07 15:48:34 -08:00
Greg Price eb55a3a1ba template context: Give better names to the URLs for the API.
The "subdomain" label is redundant, to the extent it's even
accurate -- this is really just the URL we want to display,
which may or may not involve a subdomain.  Similarly "external".

The former `external_api_path_subdomain` was never a path -- it's a
host, followed by a path, which together form a scheme-relative URL.
I'm not quite convinced that value is actually the right thing in
2 of the 3 places we use it, but fixing that can start by giving an
accurate name to the thing we have.
2017-10-30 18:29:29 -07:00
Greg Price aeb69dfd61 template context: Eliminate now-constant variable `api_site_required`. 2017-10-30 18:29:29 -07:00
Rishi Gupta b7a9068724 mobile: Update docs and portico URLs to point to new Android app. 2017-10-28 15:27:29 -07:00
Tim Abbott d8a873a571 filter: Improve group-pm-with descriptions.
This makes it a bit clearer what this actually does.
2017-10-24 13:19:24 -07:00
Alexis La Porte e7f932aa87 docs: Fix a typo in text of user doc for allow image/link previews.
Fixes #7144
2017-10-24 09:48:45 -07:00
akashnimare 70367deec3 apps: Add a direct link to installation section in desktop guide.
Fixes #6595.
2017-10-18 14:23:47 -07:00
Tim Abbott 8afe9835f6 lint: Ban two spaces after comma in prose. 2017-10-18 10:12:41 -07:00
Rishi Gupta c13d2cb00a user docs: Update create-a-stream to point to the org guide on streams.
Also cleans up the intro a bit.
2017-10-17 22:13:29 -07:00