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

272 Commits

Author SHA1 Message Date
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
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
Rishi Gupta b8976ae4bd integrations: Improve wording in create-bot-construct-url.md. 2017-12-11 15:39:26 -06:00
AlloulDorian 39dc41f40b user docs: Add doc for video calls. 2017-12-07 16:57:50 -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 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
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
Eeshan Garg 1153288681 markdown: Add macro linking to our Bots Guide tutorials. 
This macro is for when we want to describe how to run a bot on
a running Zulip server in our bots' docs.
 2017-10-09 11:40:44 -07:00
Rishi Gupta fd0fc77f92 user docs: Use sentence case for titles of sections. 
Also changes "Main Index" to "Index", since "Main index" doesn't look great.
 2017-10-05 23:12:24 -07:00
Rishi Gupta 0e0eb2d9c8 user docs: Add top level sections to sidebar. 2017-10-05 23:12:24 -07:00
Rishi Gupta eedad34b3c user docs: Add an organization basics section. 
This section has the docs a new admin might look at during initial set up.

Does not add or remove articles, just moves stuff around on the
sidebar. Does remove the "Miscellaneous" section.
 2017-10-05 23:12:24 -07:00
Rishi Gupta 0474402c51 user docs: Organize message sending and reading docs. 
Collects all relevant docs into "Sending Messages" and "Reading Messages".

Doesn't add or remove any docs, just moves them around on the sidebar.
Duplicates "Message a stream by email" (it now appears in two sections)
Removes the "Editing Messages" section/header.
 2017-10-05 23:12:24 -07:00
Rishi Gupta 6cccb70922 user docs: Reorganize account basics section. 
This section should be the stuff we want users to see when they are first
setting up their account.

This commit only moves links on the sidebar around, no additions or
deletions.
 2017-10-05 23:12:24 -07:00
Rishi Gupta 074826485f user docs: Update wordings on left sidebar. 2017-10-05 23:12:24 -07:00
Tim Abbott 14b7add4c4 help: Reorganize the sections somewhat. 2017-10-03 11:19:07 -07:00
Cynthia Lin ea75772a01 user docs: Add index page for searching. 2017-10-03 11:13:36 -07:00
Eeshan Garg 37fbed0993 webhooks: Recommend creating "incoming webhook" bot. 
In all our webhooks' docs, we now recommend creating a bot with the
"Incoming webhook" bot type.
 2017-07-11 13:25:51 -04:00
Eeshan Garg 085ce20feb markdown: Recommend installing bindings to the server with bot. 
Instead of recommending our users to download and install our
bindings "to the <integration_name> server", we now recommend
installing our bindings "to the server where the
<integration_name> bot lives". Technically, the latter is more
accurate.
 2017-06-26 12:30:04 -04:00
Eeshan Garg 1d9ab996c7 markdown: Clarify stream name recommendations in create-stream. 
Now, we further clarify in the create-stream.md macro that even
if users follow our default stream name recommendation for a
given integration, said stream must still be explicitly created.
 2017-06-26 12:30:04 -04:00
Eeshan Garg 242162f9db markdown: Add macros for changing integration config files. 2017-06-26 12:30:04 -04:00
Eeshan Garg 0d817f0870 markdown: Add macro for appending stream name to integration URL. 2017-06-14 17:42:17 -07:00
Eeshan Garg aa25348ddc markdown: Recommend substituting bot email and API key in URL. 
We now recommend substituting the appropriate bot email and
API key in the webhook URL in the webhook-url-with-bot-email.md
macro.
 2017-06-14 17:42:14 -07:00
Eeshan Garg 8efb3aeee7 templates: Update .md macros to use recommended_stream_name. 
Previously, we used Integration.name as the recommended stream
in our macros. Now, we have a dedicated attribute set in the
Integration class (that WebhookIntegration and GithubIntegration
inherit from) for the recommended stream name in cases where
the stream name is different than the name of the integration
itself.
 2017-06-13 15:30:35 -07:00
Aditya Bansal 7f15cfea91 integrations: Add download python bindings macro. 
This will be used in various integration docs.
 2017-06-06 21:40:27 -07:00
Eeshan Garg 3c47efb1fc templates: Add macro for appending branches to webhook URLs. 
This macro is an alternative to git-webhook-url-with-branches.md,
which contains the full URL with a `branches` query parameter at
the end. This macro is for when we just want to specify that this
can be done but the URL to append to can be variable or is unique
to a particular integration (and thus, doesn't warrant its own
macro and a full URL example).
 2017-06-05 11:22:06 -07:00
Eeshan Garg 433686457a templates: Add Markdown macro for URLs with bot_email@api_key. 2017-06-05 11:22:06 -07:00
Eeshan Garg fab20ec6fd templates: Add macro for appending branch names to Git webhook URLs. 2017-06-05 11:20:48 -07:00
Eeshan Garg af88695c28 templates: Add macro for appending the topic to the webhook URL. 2017-06-01 22:16:10 -07:00
Eeshan Garg dd5ce955bd webhooks/delighted: Migrate docs to Markdown. 2017-05-28 18:44:00 -07:00
Eeshan Garg 14ce3a94db webhooks/codeship: Migrate docs to Markdown. 2017-05-28 18:44:00 -07:00
Eeshan Garg 3cb758d339 templates: Support parametric Markdown macros for webhooks docs. 2017-05-24 17:00:19 -07:00
Eeshan Garg 2e3081e93d webhooks: Add Markdown macros for repetitive documentation. 2017-05-22 18:19:14 -07:00
Abhijeet Kaur 8f88b045a4 Rename "Administration" to "Organization" in the settings UI. 
This better sets expectatations for the fact that in Zulip, the
Organization settings UI is available read-only to non-administrator
users.

Tweaked by tabbott to update some additional references.
 2017-04-07 17:32:56 -07:00
Tim Abbott 3b59e6c3cc subs: Rename /#subscriptions to /#streams. 
Fixes #3653.
 2017-03-08 16:57:58 -08:00
Tim Abbott b3c9e186f9 help: Clean up change-your-organization-settings. 2017-01-29 23:02:20 -08:00
synicalsyntax 969b6db7ed docs: Rename documentation URLs and titles to be the same. 2017-01-29 22:56:23 -08:00
Cynthia Lin 0e543c7bad docs: Create and use *Administrator only feature* macro. 2017-01-17 14:45:15 -08:00
Cynthia Lin 11f36df37c docs: Create *Save changes* macro. 2017-01-16 19:59:37 -08:00
Tim Abbott 56bc421a6f Rename 'Filter Streams' to 'Filter streams'. 2017-01-16 18:00:10 -08:00
Tim Abbott 284931967a Rename 'All Streams' to 'All streams'. 2017-01-16 18:00:10 -08:00
Tim Abbott dd8fb093c8 Rename 'Stream Settings' to 'Stream settings'. 2017-01-16 18:00:10 -08:00
Cynthia Lin 1b173ee99a docs: Create *Follow steps* macro. 2017-01-15 11:16:18 -08:00
synicalsyntax c9eaf67c78 docs: Update documentation styling guide with new guidelines. 2017-01-05 20:23:26 -08:00
synicalsyntax 9d09ab11a9 docs: Replace images with FontAwesome icons. 2017-01-05 16:43:00 -08:00
Tim Abbott bc4a9ff722 lint: Enforce no lines longer than 120 characters in help docs. 
This requires some somewhat messy changes to the all-streams macro.
 2017-01-05 14:54:04 -08:00
Cynthia Lin 083c331e2d docs: Create *Stream Settings* macro. 2017-01-05 13:40:45 -08:00
Cynthia Lin d49b119391 docs: Create *Stream Settings scroll* macro. 2017-01-05 13:40:45 -08:00
Cynthia Lin ae79bb9f01 docs: Create *Stream actions* macro. 2017-01-05 13:40:45 -08:00
Cynthia Lin eff16b9766 docs: Create *Message actions* macro. 2017-01-05 13:40:45 -08:00
Cynthia Lin 097fbdefe4 docs: Create *Filter Streams* macro. 2017-01-05 13:40:45 -08:00
Cynthia Lin 6ad98e83b9 docs: Create *Down Chevron* macro. 2017-01-05 13:40:45 -08:00
Cynthia Lin 7f9b1b6490 docs: Create *All Streams* macro. 2017-01-05 13:40:45 -08:00
Cynthia Lin 89e9d79bb6 docs: Modify *Subscriptions* macro. 
Modified to more resemble format of *Settings* and *Administration* macros.
 2017-01-05 13:40:45 -08:00
synicalsyntax e1c9d0f814 user docs: Modify *Settings* macro to use *Go to the* macro. 
Created a *Go to the* macro that can be used by both *Settings* and
*Administration* macro.
 2017-01-04 08:50:38 -08:00
synicalsyntax a36d39f774 user docs: Create *Administration* macro. 2017-01-04 08:50:38 -08:00
synicalsyntax ab9356ad44 user docs: Remove outdated *Settings* macro. 2017-01-04 08:50:38 -08:00
Cynthia Lin 742d19c1b0 user docs: Create *Settings* macro. 2017-01-03 16:15:51 -08:00
Cynthia Lin 1118d303dc user docs: Add the subscriptions macro. 2017-01-01 19:49:14 -08:00
Tim Abbott 687d0cbf9e docs: Add support for including markdown files in others. 
This uses a third-party dependency, python-markdown-include.

The example use for settings is intended primarily as a demonstration.
 2016-12-30 17:16:29 -08:00