Commit Graph

3101 Commits

Author SHA1 Message Date
Tim Abbott 1cdcf607a3 docs: Document the Zulip GDPR compliance story. 2018-05-25 15:06:02 -07: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 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 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
Shubham Padia db69231e70 portico: Fix scrollbar appears for `not long` domain name.
Fixes #9516.
Scrollbar appeared in the subdomain input box while registering an
org. This is a hacky solution to the problem and doesn't work for
long domain names. A proper fix for the same should be provided in
the future.
2018-05-23 14:03:10 -07:00
Vishnu Ks 8369e2b15e registration: Allow users to import settings from other realm.
This should significantly improve the user experience for creating
additional accounts on zulipchat.com.

Currently, disabled in production pending some work on visual styling.
2018-05-23 10:30:00 -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 23c4a25041 help: Fix a misplaced period. 2018-05-21 14:47:11 -07:00
Max Nussenbaum 0ff2051982 portico: Add tour section to homepage.
This adds a tour of Zulip to the bottom of the homepage.

In order to get the carousel nave, we use Bootstrap 2 from a CDN on
this page; this isn't ideal in the medium term, but upgrading
Bootstrap across the project is too much work for now.
2018-05-20 15:04:23 -07:00
Nikhil Kumar Mishra fa9d79e203 stats: Add 1 day actives and total users to number of users chart. 2018-05-20 10:56:16 -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
Tim Abbott 847fc69c79 api: Fix a badly line-wrapped link.
Caught by test-help-documentation.
2018-05-18 16:31:36 -07:00
Tim Abbott dd7507c88a docs: Add a page on deploying bots in production. 2018-05-18 16:13:17 -07:00
Rishi Gupta af758755bd stats: Rename target_realm_name to target_name in stats.html. 2018-05-18 15:12:36 -07:00
Rishi Gupta a422165662 help: Make minor edit to change-the-time-format. 2018-05-17 12:07:37 -04:00
Shubham Padia 00cd622604 compose: Fix extra space below compose error text.
Fixes #9433.
Extra bottom margin was observed when using `compose_error` which
was caused by paragraphs in bootstrap having a bottom margin of 10px.
The paragraph tag has been replaced by a span tag.
2018-05-16 15:05:36 -07:00
Shubham Padia 9ad292cf2a right-sidebar: Add keyboard instructions shortcut in bottom-right corner.
Fixes #9182. Adds a link to the keyboard shortcuts popup at the
bottom-right corner of the right sidebar. A tooltip saying
`Keyboard Shortcuts(?)` has been added to the icon. The icon is
positioned using `position: fixed`.
2018-05-16 13:32:42 -07: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
Eeshan Garg 3a68f998a7 integration-docs-guide: Add a more detailed writing style guide.
Most of the recommendations in this guide were written by Rishi
Gupta (rishig), with a few contributions from Eeshan Garg.
2018-05-15 10:06:08 -04:00
Eeshan Garg fa28ccb952 integration-docs-guide: Trim text documenting Markdown macros.
We were devoting too much space/text to documenting our Markdown
macro. It is much more concise to just have a description and a
link to an example doc for each major macro.
2018-05-14 20:14:08 -02:30
Tim Abbott 1f837340d1 api: Fix confusing documentation about services for botserver.
This fixes several super-confusing things in these docs.  Bot services
aren't a user-facing concept, and also, you need the URL before
creating the bot users.
2018-05-14 09:21:45 -07:00
Tim Abbott 485d5b6335 api: Fix incorrectly coded bullet for zulip_botserver config. 2018-05-14 09:21:45 -07:00
Joshua Pan e591668d60 bot-docs: Rewrite last section of "Running bots". 2018-05-14 04:27:36 -07:00
Joshua Pan 3952f94157 minor: Add missing period to bot-docs. 2018-05-14 04:27:36 -07:00
Joshua Pan 128aa8b7ee bot-docs: Remove hint on "Running bots" doc.
We already explain testing bot output in
"Writing bots" doc, and the placement of
the hint itself doesn't make sense.
2018-05-14 04:27:36 -07:00
Joshua Pan 0b112cf5e9 bot-docs: Streamline introduction to 'Running a bot'. 2018-05-14 04:27:36 -07:00
Joshua Pan 2b06e1cec7 bot-docs: Renumber list to use all 1's. 2018-05-14 04:27:36 -07:00
Aditya Bansal a00f3b5843 docs: Update for change from typing.Text to str. 2018-05-14 05:23:36 +05:30
Yago González 610f48dcbc docs: Explain how to configure the Python bindings.
The Python bindings (which are used for bots, amongst other things) can
be configured either with a .zuliprc file or with environment variables
in the host machine.

This new page in the user docs explains how to set the bindings up using
both techniques, and is a good reference on the setup required by Zulip
bots.
2018-05-13 15:09:23 -07:00
Yago González c6eee1c9da docs: Rename rest_error_handling with dashes. 2018-05-13 15:02:48 -07:00
Yago González 7ae51a4ec6 docs: Update API key-related screenshots. 2018-05-13 15:02:48 -07:00
Max Nussenbaum bf27ed2b1b portico: Swap annual and monthly pricing on plans page.
This swaps the annual and monthly pricing on the plans page
(with the .67 cents properly aligned).
2018-05-12 15:29:28 -07:00
Max Nussenbaum c9bcb2ef92 portico: Add link to Why Zulip on landing page.
This adds a link to the Why Zulip page to the landing page,
at the end of the "Organized" column.
2018-05-12 15:29:28 -07:00
Tim Abbott d18b193b5b why-zulip: Fix a buggy/broken link.
This was accidentally introduced in
fc6833e46a.
2018-05-10 14:43:06 -07:00
Max Nussenbaum fc6833e46a portico: Add quote to Why Zulip page.
Adds a quote from Grahame Grieve to the Why Zulip page.

With tweaks by tabbott to make the linter pass.
2018-05-10 14:17:21 -07:00
Max Nussenbaum caf6870a54 portico: Break up long paragraphs on Why Zulip.
This breaks long paragraphs on the Why Zulip page into multiple
smaller paragraphs to improve readability.
2018-05-10 07:34:34 -07:00
Rishi Gupta 01a7ed952d user docs: Update a few articles in account basics. 2018-05-08 17:30:08 -07:00
Tim Abbott d4d268529e templates: Clean up formatting of FAQ content.
This adds some paragraph splits and curly quotes.
2018-05-08 09:46:50 -07:00
Max Nussenbaum 3c6cccbfd6 portico: Add link to API on home.
Adds a link to the API on the integrations section of the
homepage.
2018-05-08 09:32:54 -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
Max Nussenbaum bb639b3752 portico: Use smart apostrophe in header
This changes the landing page header to use a curly apostrophe
instead of a straight one.
2018-05-07 14:39:20 -07:00