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

1553 Commits

Author SHA1 Message Date
Tim Abbott 26982ff55f puppet: Remove pageduty_nagios.pl. 
This hasn't been used in like 4 years, and clutters the repo.
 2017-10-05 18:46:09 -07:00
derAnfaenger 2cdde8b168 linter: Add rule against verbose $(document).ready() calls. 2017-10-05 10:11:34 -07:00
derAnfaenger 6b99022a02 linter: Add rule against using inline event handlers. 2017-10-05 10:08:40 -07:00
derAnfaenger c01981a65f linter: Extend no-space-before-bracket linting rule. 2017-10-05 10:05:27 -07:00
derAnfaenger c957d1857e code style guide: Update and remove outdated rules. 
These are all enforced by our linters, and thus a source of clutter in
this code style guide.
 2017-10-05 10:05:17 -07:00
Tim Abbott ab71c42ab8 docs: Update confusing changelog entry. 
The original text meant to say "lost", not "last", but also was a bit
confusing anyway.
 2017-10-05 09:32:02 -07:00
Joshua Pan a38d275aeb docs: Capitalize Zulip in changelog.md. 2017-10-05 09:24:09 -07:00
Tim Abbott de51eb9e7f docs: Update changelog and roadmap through present. 2017-10-04 22:39:49 -07:00
rht ac01b0c559 docs: Add type annotation. 
Discovered while running the 2to3 type annotation.
 2017-10-04 16:31:27 -07:00
Vishnu Ks 119157b205 docs: Update email testing section to include EmailLogBackEnd. 
Rewritten by tabbott for extra clarity.
 2017-10-04 14:44:58 -07:00
Tim Abbott 8d4f084623 code-style: Remove discussion of absolute_import. 
It's no longer accurate on Python 3.
 2017-10-04 14:09:05 -07:00
Tim Abbott b7974fc9f8 docs: Delete useless/wrong content from JavaScript code style. 
One of these isn't true (not requiring braces) and the rest are
already handled by our linters.
 2017-10-04 13:59:38 -07:00
Tim Abbott a001b8aef3 docs: Remove unnecessary CSS section from code style. 
This is already handled by our linter, so no need to repeat it here.
 2017-10-04 13:58:50 -07:00
Tim Abbott 4230871503 docs: Update code style guide for Python. 2017-10-04 13:53:06 -07:00
neiljp (Neil Pilgrim) dbc8415fa5 docs: typos in code-style.md; zephyr -> zerver. 2017-10-04 13:52:31 -07:00
Tim Abbott 4eafec12ac docs: Rewrite the intro to writing bots. 2017-10-04 12:22:02 -07:00
Tim Abbott 26dd1ab6a7 docs: Simplify the guide for running bots. 2017-10-04 12:11:27 -07:00
derAnfaenger 7a43ab00a2 running bots guide: Clarify bot's directory statement. 2017-10-04 11:49:22 -07:00
derAnfaenger 543500bab5 bots guides: Refactor layout. 
This flattens the layout, shifts passages and unitizes headings to
use gerunds for the running and writing bots guides.
 2017-10-04 11:49:22 -07:00
derAnfaenger b6106ca7ac running bots guide: Add cross-references to writing bots guide. 2017-10-04 11:49:21 -07:00
derAnfaenger 8449ea300b running bots guide: Shorten installation section. 2017-10-04 11:49:21 -07:00
derAnfaenger 6b879a2b04 docs: Split bots guide into running and writing guides. 2017-10-04 11:49:20 -07:00
Vishnu Ks 2267f09813 docs: Change place to ask help from mailing list to chat.zulip.org. 2017-10-04 08:20:29 -07:00
Tim Abbott 1b637658df docs: Add a section documenting the chat.zulip.org traffic level. 2017-10-03 15:41:46 -07:00
Tim Abbott c447e7530b docs: Update realms documentation for REALMS_HAVE_SUBDOMAINS removal. 2017-10-02 16:32:10 -07:00
Eeshan Garg 502e93a5d2 docs: Recommend check_send_stream_message for stream messages. 
This commit updates various places where check_send_message had
been previously recommended to recommend check_send_stream_message
for sending messages to a public stream.
 2017-10-02 15:27:26 -07:00
Tim Abbott 50eb94f7ee docs: Remove broken link to shell tips. 
In theory, we could replace it, but it's not clear that's necessary.
 2017-10-01 23:27:29 -07:00
Priscilla 7c0431a60f docs: Correct the instructions for re-running provision. 
We apparently missed this when renaming provision.py to simply
provision.
 2017-10-01 15:51:32 -07:00
rht e0f7b6f8ef docs: Remove the yarn.lock stutter. 
Maybe someday someone will spot this err. However, the documentation is
clear in conveying its content even with the extra yarn.lock.
 2017-09-30 09:16:46 -07:00
Alena Volkova e216801be8 docs: Fix a typo in version-control.md. 2017-09-29 18:04:07 -07:00
Greg Price 7e8bbda171 docs/logging: Update for the revised log format. 
This accumulates several changes in recent commits: decimal point
rather than comma, compact log level, and logger names, the latter
abbreviated `zr` in the case of `zulip.request`.
 2017-09-28 18:26:39 -07:00
Alena Volkova bcb9c76457 docs: Clarify who can collaborate in area label teams. 
Collaboration in area label teams is only available to members of the
Zulip organization on GitHub. For non-members the related links are
not working, which can be confusing.  Address this by explaining the
links won't work and also that anyone can join.
 2017-09-28 17:26:07 -07:00
Greg Price 85f7764ed4 docs/settings: Small tweaks for clarity. 2017-09-28 17:01:50 -07:00
Robert Hönig db5ed277d1 bots guide: Update outdated `run.py` to `zulip-run-bot`. 2017-09-28 11:10:09 -07:00
Robert Hönig a7d3355fd6 bots guide: Remove need to subscribe bots to streams. 
Since 7878c70, bots don't need to to be subscribed to a
stream to be notified on @-mentions.
 2017-09-28 11:10:09 -07:00
Greg Price 7b8f725707 APNs: Accept 1.6-format payloads in bouncer. 
This is just enough of a quick fix to work with a stock Zulip 1.6
server.  We should really also make this robust to arbitrary input
from the remote Zulip server, even though it'll be a little tedious.
 2017-09-28 10:01:16 -07:00
Tim Abbott 2317b63068 docs: Document narrowing reporting. 2017-09-27 19:47:45 -07:00
Tim Abbott 0744961afe docs: Add more comprehensive documentation on error reporting. 
Fixes #2232.
 2017-09-27 19:47:08 -07:00
rht 8aa8991caa docs: Remove import print_function. 2017-09-27 18:06:47 -07:00
Eeshan Garg bb34ba37b5 tools: Rename build_pygments_data.py -> build_pygments_data. 
Dropping the file extension (.py) conforms to our naming
convention for such scripts.
 2017-09-26 16:00:41 -07:00
Greg Price a9aa31ac96 docs: Fix lint in typing-indicators. 2017-09-26 13:57:03 -07:00
Steve Howell d6fb17c424 docs: Add typing-indicators.md. 2017-09-26 13:42:14 -07:00
Tim Abbott 3964a6e9a3 docs: Document the new transactional email logs. 2017-09-25 15:37:09 -07:00
Tim Abbott 14ef682a4e docs: Update emoji tooling documentation. 
This is a start and fixes the most glaring problems from not updating
this documentation; I'd like Harshit to do a helpful pass on updating
this to cover some of the more subtle details about how our emoji
picker works, emoji aliases, etc.
 2017-09-25 14:24:52 -07:00
rht 9bd3f772b7 Move Dockerfile to Dockerfile-dev. 
Based on zulip#450, with commits restructured by Rein Zustand.
 2017-09-25 12:32:33 -07:00
Tim Abbott a2243378ea settings: Set REALMS_HAVE_SUBDOMAINS by default. 
This change means that almost every Zulip server out there will now be
using subdomains for every realm.  There are a few complications noted
in the release notes.
 2017-09-25 06:52:32 -07:00
Kiran Shahdadpuri 3776e73db4 docs: Improve analytics onboarding documentation. 
Tweaked by tabbott to reorganize the text a bit.
 2017-09-25 06:23:30 -07:00
Eeshan Garg 390a1fec92 zulip_bots: Generate static files during provisioning. 
This commit implements support for copying over static files
for all bots in the zulip_bots package to
static/generated/bots/ during provisioning. This directory
isn't tracked by Git. This allows us to have access to files
stored in an arbitrary zulip_bots package directory somewhere
on the system. For now, logo.* and doc.md files are copied over.

This commit should act as a starting point for extending our
macro-based Markdown framework to our bots/API packages'
documentation and eventually rendering these static files
alongside our webhooks' documentation.
 2017-09-22 15:14:42 -07:00
Tim Abbott 3708f5708a upgrade: Include zulip::static_asset_compiler by default. 
Since we've found that it's fairly frequent that we want to recommend
to developers that they upgrade to a version of Zulip from Git, it
makes sense to include that by default.
 2017-09-22 11:38:20 -07:00
Tim Abbott 4da9e77096 docs: Expand documentation of provisioning. 
Fixes #2668.
 2017-09-22 11:23:17 -07:00
Tim Abbott b1f4c7308e docs: Fix a broken link in new documentation. 2017-09-22 11:23:17 -07:00
Tim Abbott 876fd95486 docs: Document how our dependencies are managed. 
Fixes #5481.
 2017-09-22 11:09:58 -07:00
Vishnu Ks 5db810b5d7 docs: Fix example code in mock section. 2017-09-19 16:56:56 -07:00
Vishnu Ks 14498d1407 docs: Use real method name instead of foo in mock section. 2017-09-19 16:56:56 -07:00
Vishnu Ks f4c69bb126 tools: Create tool for inlining email CSS during provision. 2017-09-16 07:17:48 -07:00
vbNETonIce 264dcb4e2d docs: Fix path to restart-server script. 2017-09-16 02:22:30 -07:00
zeneli 17d35af334 docs: Fix filename for new application view URL. 2017-09-16 00:38:32 -07:00
Robert Hönig fb39e884c8 docs: bots guide: Add section for writing tests. 2017-09-15 08:59:21 -07:00
Robert Hönig e01dede172 docs: bots guide: Make API subsection of developer tutorial. 2017-09-15 08:55:35 -07:00
Rishi Gupta 4a383544af hotspots: Rename and update click_to_reply. 2017-09-15 04:14:52 -07:00
Rishi Gupta 836a2c502e hotspots.js: Clean up icon positioning code. 
Also will allow more fine-grained positioning.
 2017-09-15 04:14:52 -07:00
Vishnu Ks fc59647a4a Vagrantfile: Provide a way to remove proxy from vagrant. 
Fixes #5292
 2017-09-15 03:55:32 -07:00
Robert Hönig 0941e27003 docs: Add docopt.org to shell understanding tips. 2017-09-15 01:40:59 -07:00
Eeshan Garg 0721fc851a meetings: Switch integrations meeting to Fridays 9 am (PST). 2017-09-14 10:18:15 -07:00
Supermanu 184bfe7cfd docs: Expand the french translation style guide. 
As the french word organisation is used, the related line is excluded
from the linter spell check.
 2017-09-14 08:35:51 -07:00
Vishnu Ks 9c70da1a78 docs: Remove misleading fullstop from vagrant plugin command. 2017-09-14 06:01:11 -07:00
Robert Hönig 29d512a4a8 docs: Move `zulip_bots` installation steps to new section. 2017-09-14 04:48:53 -07:00
Robert Hönig bc4627e61a docs: Add reference to zulip-bot-output script. 2017-09-14 04:48:10 -07:00
Robert Hönig 6bfbbaa0ce docs: Clarify zulip_bots repository install. 2017-09-14 04:48:10 -07:00
Robert Hönig 221afb1492 docs: Describe memcache flush with a 'normal permission' command. 2017-09-12 08:27:58 -07:00
Robert Hönig 52a55a37ad docs: Remove legacy Python2/3 compatibility code. 2017-09-12 06:35:29 -07:00
Robert Hönig 211fbdf59b docs: Add additional reason why mocking is useful. 2017-09-12 06:35:29 -07:00
rht 720d5d3bf4 Update roadmap.md. 2017-09-12 03:01:43 -07:00
Kir Chou 0b9bd6a510 Recommend virtualbox version should be a fixed version (fixes #6448) 2017-09-10 00:38:14 -07:00
Kir Chou 7c1802c8b1 docs: Change the start directory after `vagrant ssh` from ~ to /srv/zulip . 2017-09-10 16:35:11 +09:00
Robert Hönig e65ad533d0 docs: Add guide for mocking in tests. 2017-09-08 13:18:28 -07:00
Robert Hönig 25742c1199 Capitalize s in Terms of service. 
A few strings used `Terms of service`
instead of `Terms of Service`. This change
makes the latter form consistent over the repo.
 2017-09-06 09:49:19 -07:00
Robert Hönig 6120841876 docs: Update bots_guide.md. 
This include various small changes to adapt
this document to the latest repo changes.
 2017-09-06 09:48:04 -07:00
Tim Abbott 7f46056932 docs: Update documentation on push notifications. 2017-08-30 10:47:57 -07:00
Tim Abbott 6ef55145f5 travis: Merge the static-analysis build into backend. 
[Tweaked by gnprice to leave the use of --linecoverage-report
unmodified for now.]
 2017-08-29 15:42:01 -07:00
Tim Abbott e996579045 bots: Clean up supervisord documentation. 2017-08-29 09:56:56 -07:00
Robert Hönig 0c905e2f3c bots-guide.md: Describe Zulip Botserver setup with supervisord. 2017-08-29 09:56:56 -07:00
Supermanu 3be14833f0 docs: Add a french translation style guide. 2017-08-29 09:40:03 -07:00
Robert Hönig 5f220359bd bots-guide.md: Refactor Zulip Botserver guide. 
Tweaked by tabbott to give greater priority to the explanation of what
it is.
 2017-08-28 17:34:54 -07:00
Sarah e280a5f8e8 docs: Update new feature tutorial. 
Update new feature tutorial to describe recent changes
to the backend and front end processes based on
refactoring.
 2017-08-27 11:37:43 -07:00
rht 437b2a3146 Update "MacOS" text to "macOS" 2017-08-26 09:00:42 -07:00
Tim Abbott 69059dcac8 tests: Clean up subscribing from webhook tests. 2017-08-24 21:37:57 -07:00
Tim Abbott 1c9521a8d6 docs: Fix buggy relative documentation link. 2017-08-24 19:59:59 -07:00
Robert Hönig 18a080cd6c Don't handle json payload key errors inside webhooks. 
Fixes first part of #6213.
 2017-08-24 11:33:14 -07:00
Tim Abbott 30e1aada42 docs: Stop documenting how to create multiple organizations. 
This documentation wasn't super helpful, since users will want
REALMS_HAVE_SUBDOMAINS.
 2017-08-23 20:07:17 -07:00
Tim Abbott a6ab3269d2 docs: Clean up headings on new existing server instructions. 2017-08-23 15:11:23 -07:00
Tim Abbott a397e92fb3 docs: Fix problematic line-wrapping. 2017-08-23 15:10:35 -07:00
Hobson Lane a647f7bf9f docs: Add tips on installing on an existing server. 2017-08-23 14:53:14 -07:00
Vaida Plankyte 5549a9fc78 docs: Move template section from translating.md to html-templates. 
Fixes #1649.
 2017-08-23 13:43:29 -07:00
Umair Khan 8171b0ea25 i18n: Add unescape documentation. 2017-08-23 00:23:16 -07:00
Robert Hönig 1e4283aabf docs: Update bots-guide.md to reflect current APIs. 
Tweaked by tabbott to do some line-wrapping and small edits.
 2017-08-22 23:46:20 -07:00
Tim Abbott 8dff14430e tools: Remove old python 3 compatibility checker. 
Now that we've migrated over to Python 3, this tool is no longer required.

Fixes #6217.
 2017-08-22 14:58:59 -07:00
Robert Hönig 84a7350de6 docs: Clarify webhook-specific guides. 2017-08-22 10:38:48 -07:00
rht 80f4ba7a76 requirements: Replace py3_dev.txt with dev_lock.txt. 2017-08-22 10:10:57 -07:00
David Taylor 0ffc758129 Add 'category' to WebhookIntegration definition 2017-08-21 14:58:38 -07:00
Greg Price 78b41f375d py3: Revise and update shebang discussion in docs/shell-tips. 
This keeps the examples in line with our actual codebase.

Also while I'm here revise it to explain the actual motivation for our
use of `env`, and to correct some subtle details -- it's actually the
kernel that interprets the shebang (as visible in e.g. a `strace` log),
not the shell, and when the program is executed as `./my_program.py`
the exact name including `./` is passed to the interpreter.
 2017-08-16 17:54:43 -07:00
Greg Price a099e698e2 py3: Switch almost all shebang lines to use `python3`. 
This causes `upgrade-zulip-from-git`, as well as a no-option run of
`tools/build-release-tarball`, to produce a Zulip install running
Python 3, rather than Python 2.  In particular this means that the
virtualenv we create, in which all application code runs, is Python 3.

One shebang line, on `zulip-ec2-configure-interfaces`, explicitly
keeps Python 2, and at least one external ops script, `wal-e`, also
still runs on Python 2.  See discussion on the respective previous
commits that made those explicit.  There may also be some other
third-party scripts we use, outside of this source tree and running
outside our virtualenv, that still run on Python 2.
 2017-08-16 17:54:43 -07:00
Tim Abbott 4ce079b689 docs: Clean up release notes for the Zulip 1.7 release. 
Now that we have the expensive migrations running automatically early
in the process, we can drop them to more of a footnote.
 2017-08-16 13:28:05 -07:00
Tim Abbott d43f5ceeec database: Add database index for wildcard mentions. 2017-08-16 13:28:04 -07:00
Tim Abbott 8bb812c8a9 database: Add database index for alert words. 2017-08-16 12:39:01 -07:00
Robert Hönig a22f524fe1 Remove Zulip API licensing information. 2017-08-16 07:03:39 -07:00
Greg Price cd897b7a99 docs/prod*: Simplify core install instructions a bit by cutting /root/zulip . 
This works fine in my testing -- I followed it on a fresh `trusty` VM,
after just getting SSL certs with our LetsEncrypt instructions, and
the install completed successfully.

And in the source tree, the only evidence I can find of a potential
remaining dependency on the `/root/zulip` path is the Nagios config in
`puppet/zulip_ops/`.  That's actually already broken, in that it
depends on `/root/zulip/api/`, so we'll have to sort that out;
and in any case, it doesn't matter to most people installing Zulip.

Add a mention that the install script will move the just-unpacked
directory out from under you.  While we're here, add a few words about
where the deployed code is laid out.

Text of those last words tweaked by tabbott.
 2017-08-15 17:46:42 -07:00
Greg Price 71fa4dfa5d docs/prod*: Give clearer instructions for rolling back a deploy. 
Also cut an obsolete mention of /root/zulip .
 2017-08-15 17:41:07 -07:00
Greg Price e469578a55 py3: Fix up (almost) all script invocations to rely on shebangs. 
This follows up on 207cf6302 from last year to clean up cases that
have apparently popped up since then.  Invoking the scripts directly
makes a cleaner command line in any case, and moreover is essential
to how we control running a Zulip install as either Python 2 or 3
(soon, how we always ensure it runs as Python 3.)

One exception: we're currently forcing `provision` in dev to run
Python 3, while still running both Python 2 and Python 3 jobs in CI.
We use a non-shebang invocation to do the forcing of Python 3.
 2017-08-15 17:30:31 -07:00
Tim Abbott 4e7c56fff6 docs: Fix a buggy link to realm-admin-docs. 2017-08-15 17:23:18 -07:00
Tim Abbott 415d511469 docs: Mention a few highlights from settings.py. 2017-08-15 17:21:40 -07:00
Tim Abbott 330493707a docs: Improve install guide outgoing links. 2017-08-15 17:21:40 -07:00
Tim Abbott 771afd093c docs: Restructure install guide troubleshooting section. 2017-08-15 17:21:40 -07:00
Tim Abbott 634532b414 docs: Remove discussion of community organizations. 
This significantly simplifies the page, and they don't exist anymore
anyway.
 2017-08-15 17:21:40 -07:00
Tim Abbott 7582d0920d docs: Improve clarity of production install documentation for emails. 
Based on #6094, this extracts email configuration as its own step.
 2017-08-15 17:21:40 -07:00
Tim Abbott 4725afe99a settings: Move NOREPLY_EMAIL_ADDRESS to DEFAULT_SETTINGS. 
Since we're auto-detecting the value anyway, there's no reason it
can't be moved to DEFAULT_SETTINGS.

This lets us remove some clutter from the installation documentation.
 2017-08-15 17:21:40 -07:00
Tim Abbott 80a5ecf3c8 docs: Improve readability of the prod-email instructions. 2017-08-15 17:21:40 -07:00
Tim Abbott 2bfe93f290 docs: Move subscribe instructions to end of install instructions. 2017-08-15 16:53:55 -07:00
Tim Abbott 4525843681 docs: Clarify documentation on verifying push notifications. 
This is based on discussion in #6100.
 2017-08-15 11:25:30 -07:00
Tim Abbott 0cd287b3f5 mypy: Add documentation for requirements/mypy.txt. 2017-08-15 07:24:42 -07:00
Aaron Tse 363872bf46 docs: Correct incorrect description in event-systems.md. 2017-08-15 07:24:32 -07:00
Steve Howell 658ac782a2 Add page_params.unread_msgs.count. 
This field is convenient for bankruptcy checks.  Clients could
calculate it from page_params.unread_msgs before this change, but
it would kind of a painful calculation.

To add count, we had to simplify the mypy annotations, which weren't
really accurate before.
 2017-08-14 12:38:09 -07:00
Greg Price 6e9f8b90dc provision: Remove the last reference to `install-mypy`, and delete it. 
This script has been redundant for some time now.
 2017-08-10 18:00:19 -07:00
rht 761c11276f docs: Remove a redundant step in dev setup. 
`mypy` is already installed in the previous step at Python 3 virtualenv
setup step.
 2017-08-10 17:50:28 -07:00
Jack Zhang 9461f2f799 docs: Update /integrations links to new pushState routes. 
Update Email, Beanstalk, Hubot, JIRA, and Trello integrations
links.

The Hubot integrations section (/integrations#hubot-integrations)
was removed  in an earlier redesign of /integrations. This commit
replaces the link with the hubot-scripts organization on
Github, which displays the comprehensive list of all integrations
available via Hubot.

Fixes #5875.
 2017-08-10 10:21:53 -07:00
Steve Howell f9bd610a60 docs: Make it explicit that chat.zulip.org is a Zulip server. 
It should be kind of obvious, but people tend to skim over
URLs.
 2017-08-09 19:33:57 -07:00
Greg Price 98cef0ab48 py3: Augment all mentions of system Python packages to include Python 3. 
In some of these contexts, we may still be *using* the Python 2
version, but at least this should eliminate running into
`ImportError`s one by one in scripts that run outside a virtualenv,
as we update their shebangs to refer to Python 3.

Several Python libraries we use don't come in Python 3 versions on
trusty: gevent, boto, twisted, django, django-tagging, whisper.
The latter two don't come in Python 3 versions even on xenial.
So some work required before we can actually switch the code that
relies on those libraries to run as Python 3 -- probably the best
solution will be to backport them all in our apt repo.  (All but
`whisper` are packaged in zesty; `whisper` upstream just grew Python 3
support this year.)
 2017-08-09 14:07:05 -07:00
Steve Howell 2f775c3e0b node tests: Extract zrequire helper. 
We are phasing out the following in tests:

    add_dependencies - this is just kind of a clunky UI
    require - normal JS requires cause test leaks

In order to plug require leaks, we are effectively doing what
we always have done inside of add_dependencies, which is to
keep track of which modules we have done `require` on, and
these get cleared between tests.

Now we just use `zrequire` every time we want to pull in real
code to our global namespace.
 2017-08-09 12:32:09 -07:00
Vaida Plankyte b6da398e17 docs: Add bug report guidelines. 2017-08-09 11:38:46 -07:00
Greg Price d3a69da829 py3: Fix or remove (almost) all references to Python 2 venv in docs. 
I think soon we'll put the Python 3 venv at `/srv/zulip-venv` and
make `/srv/zulip-py3-venv` just an alias to that (then remove the
alias too), but for now the old name is helpful for spotting places
that need an update.

The `/srv/zulip-venv` name still appears in codepaths used by Travis
tests.
 2017-08-08 15:48:12 -07:00
rht b0e4233d3f Dev environment setup: default to Python 3. 
From the line in tools/provision it should trickle to the rest of the
scripts. This works since almost all the python scripts have been linted
to be generic.

Proof that the setup is python3 only: with this commit, within the
vagrant container env, /srv/zulip-venv is no longer present and
`./tools/run-dev.py` runs just fine.

[gnprice: Added `rm -f` and warning message, and made small edits.]
 2017-08-08 15:28:11 -07:00
Jack Zhang 4ba5b2f364 docs: Create hotspots subsystem documentation. 2017-08-05 18:32:37 -07:00
Pweaver (Paul Weaver) 1afaa67c7c deps: Change npm to yarn for reliablity, security, and speed. 2017-08-05 12:29:06 -07:00
Greg Price cc30226af0 deliver_email: When disabled, sleep forever rather than exit. 
This makes supervisor see the service as cheerfully running
and let it alone, rather than constantly retry starting it.
Because the crash/restart loop means repeatedly spending a
couple of seconds loading Django and the app, separated by
brief periods while supervisor notices the crash and acts
on it, it was actually consuming about 30-50% CPU on the
zulipchat.com staging server.
 2017-08-03 16:28:19 -07:00
Greg Price 2cc0689bcf api migration: Update the prod "Secure, maintain, and upgrade" doc. 2017-08-03 12:23:29 -07:00
Greg Price 8f73129d6a api migration: Update docs/directory-structure. 2017-08-03 12:23:29 -07:00
Greg Price fb9ffcd35a api: Update docs/integration-guide. 2017-07-31 21:25:13 -07:00
Tim Abbott 780dbe72d5 docs: Clean up new markdown test docs. 
Thanks for Joshua Pan for the review!
 2017-07-31 09:47:47 -07:00
Tim Abbott c638ea8d11 docs: Fix spelling of Travis CI. 2017-07-31 09:36:22 -07:00
Tim Abbott 1ffb791d0b docs: Further document the recommended Travis CI workflow. 2017-07-31 09:35:32 -07:00
Vaida Plankyte 9859264d56 docs: Emphasise Travis CI setup in dev env setup docs. 
Fixes #5266.
 2017-07-31 09:35:29 -07:00
Tim Abbott 0161671981 markdown: Document the new features of our markdown testing system. 
This and the preceeding commits is significant progress towards
completing #1857.
 2017-07-28 18:31:46 -07:00
Tim Abbott 4b7c23f133 markdown: Rename bugdown-data.json to a more reasonable name. 2017-07-28 17:54:01 -07:00
Tim Abbott 4f4d28477d markdown: Rename markdown.contains_bugdown. 
This name was confusing, since "bugdown" doesn't exactly suggest
"backend markdown processor" to people.
 2017-07-28 17:51:33 -07:00
Tim Abbott f834ae14bc docs: Update management command documentation. 2017-07-28 16:12:10 -07:00
Tim Abbott 470d0a481c docs: Update changelog through today. 2017-07-27 21:57:41 -07:00
Greg Price 98b1678d5d docs: Document how to make settings changes take effect. 
The page at https://zulip.org/server.html reminds me that we didn't
have clear documentation of this point where we discuss configuring
the server.
 2017-07-27 21:44:58 -07:00
Greg Price 76b62620d9 docs: Add a "production" overview page. 
This pulls together what's covered in detail in several
longer pages, and gives us a page that can serve as a good
drop-in replacement for https://zulip.org/server.html .

Also tweak a couple of related bits for clarity and orthography.
 2017-07-27 21:44:58 -07:00
Tim Abbott 7abcc1b274 docs: Add a brief document explaining management commands. 
Fixes #1330.
 2017-07-27 18:00:53 -07:00
Vaida Plankyte 282eb5585e docs: Add section explaining GitHub/Google auth for dev env. 2017-07-27 17:35:14 -07:00
Steve Howell e6e3bbb780 Add a "mentions" section to unread message ids. 2017-07-27 16:14:26 -07:00
Jason Michalski 4f0110e081 Add unread_msgs to the initial state data. 
We are adding a new list of unread message ids grouped by
conversation to the queue registration result. This will allow
clients to show accurate unread badges without needing to load an
unbound number of historic messages.

Jason started this commit, and then Steve Howell finished it.

We only identify conversations using stream_id/user_id info;
we may need a subsequent version that includes things like
stream names and user emails/names for API clients that don't
have data structures to map ids -> attributes.
 2017-07-27 16:14:25 -07:00
Steve Howell b588bc47fc Create zerver_usermessage_unread_message_id index. 
This creates a partial index on UserMessage that lets us
find unread messages for particular user id.
 2017-07-26 22:28:19 -07:00
Greg Price 9f62b402b5 install docs: Fix some small grammar and orthography issues. 
After editing this file for the previous commit, I couldn't unsee
"low-traffic the".  So I fixed that, saw more issues, and then just
went through the page for everything that was similarly trivial to fix.
 2017-07-25 17:35:39 -07:00
Greg Price 273533643a install docs: Say explicitly that Zulip should have its own (virtual) machine. 
This is the main thing that https://zulip.org/server.html explains
that we don't yet in our main documentation tree.
 2017-07-25 17:35:39 -07:00
Cynthia Lin 83993aa388 docs: Update user docs guide with new sidebar index. 2017-07-24 22:59:55 -07:00
Rishi Gupta 481c85fb48 settings: Update text in templates. 2017-07-24 17:33:14 -07:00
Shubham Gupta 205d0993ef docs: Updated troubleshooting guide for ssh connection errors. 
Tweaked by tabbott to simplify the language a bit.

Fixes #5889.
 2017-07-24 17:26:19 -07:00
Rishi Gupta 161f3c4e68 docs: Fix link to open accessibility issues. 2017-07-22 11:51:33 -07:00
Vishnu Ks 700e08da4a docs: Use get_user in mypy.md. 2017-07-20 16:50:23 -07:00
Greg Price 2ed02a0c5d gitignore: Anchor patterns that should be anchored. 2017-07-19 14:03:49 -07:00
Pweaver (Paul Weaver) d3ffc81726 Enable Hot Module Replacement in webpack. 
This allow the webbpack dev server to properly reload JavaScript modules
while running in dev without restarting the server. We need to connect
to webpack-dev-server directly because SockJS doesn't support more than
one connection on the same host/port.
 2017-07-18 11:02:05 -07:00
Tim Abbott 2317819e47 nginx: Use the Django 404 page for files under static/. 
This elimintes the need for us to maintain duplicate copies of the
Zulip 404 error pages.

Fixes #5382.
 2017-07-18 09:55:30 -07:00
Tim Abbott 5488ab4225 docs: Update links to python-zulip-api project. 
We just renamed a bunch of files in that repository.
 2017-07-18 00:07:17 -07:00
Rishi Gupta aa845e7f60 models: Replace ScheduledJob with ScheduledEmail. 
ScheduledJob was written for much more generality than it ended up being
used for. Currently it is used by send_future_email, and nothing
else. Tailoring the model to emails in particular will make it easier to do
things like selectively clear emails when people unsubscribe from particular
email types, or seamlessly handle using the same email on multiple realms.
 2017-07-17 16:05:38 -07:00
Durga Akhil Mundroy 146dfa6f0b org-permissions: Add allow_edit_history organiztion setting. 
This new setting controls whether or not users are allowed to see the
edit history in a Zulip organization.  It controls access through 2
key mechanisms:

* For long-ago edited messages, get_messages removes the edit history
  content from messages it sends to clients.

* For newly edited messages, clients are responsible for checking the
  setting and not saving the edit history data.  Since the webapp was
  the only client displaying it before this change, this just required
  some changes in message_events.js.

Significantly modified by tabbott to fix some logic bugs and add a
test.
 2017-07-16 10:10:06 -07:00
Rohitt Vashishtha d31686b576 docs: Fix typos in git-guide.md. 2017-07-16 00:22:05 -07:00
Harshit Bansal ebdd8c9e3d emoji: Switch to using `emoji-datasource` npm package. 
This commit does the following things:
* Instead of using a manual tool for downloading sprite sheets, use
  `emoji-datasource` npm package.
* Modify the `build_emoji` script to use sprite sheets from the npm
  package.

Bumps PROVISION_VERSION.

Fixes: #4730.
 2017-07-13 21:52:01 -07:00
Harshit Bansal 420327b558 provision: Install NPM packages in the beginning of provisioning process. 
NPM packages should be installed at the beginning of the provisioning
process so that later in the provisioning process if a script requires
any NPM package it can use it. Earlier, we were installing NPM packages
in the last as the installation process can fail due to network issues
but since we now retry in case the installation fails, they can be
installed safely at the beginning of the process as well just like apt
packages.
 2017-07-13 21:52:01 -07:00
Tim Abbott 4e2b5bf200 docs: Document naming for schema migrations. 2017-07-10 16:03:16 -07:00
rht 8a50fbfa0b docs: Move ')' to the correct location. 2017-07-10 10:22:47 -07:00
Tim Abbott 6eca9a1fbf docs: Update recommendations of disk requirements. 
Addresses part of #5724.
 2017-07-07 12:58:42 -07:00
Tim Abbott 094c8fd812 docs: Update link to Zulip API bindings code. 2017-07-06 13:08:25 -07:00
Tim Abbott 32bc794a17 docs: Update link to contrib_bots README.md. 2017-07-06 12:37:02 -07:00
Jack Zhang 13a5c625ca docs: Add note for importing _() function in translating.md. 2017-07-05 12:01:59 -07:00
Vaida Plankyte d8ab716820 german.md: Use the singular 'they' pronoun. 2017-07-05 09:27:44 -07:00
Vaida Plankyte 18bf15cfed git-guide.md: Use the singular 'they' pronoun. 2017-07-05 09:27:44 -07:00
Vaida Plankyte 43a98b896b custom-apps.md: Use the singular 'they' pronoun. 2017-07-05 09:27:43 -07:00
Vaida Plankyte c52fc84fd0 bots-guide.md: Use the singular 'they' pronoun. 2017-07-05 11:33:42 +02:00
Vaida Plankyte 9bb0602ad4 docs: Add info on resolving merge conflicts to git-guide.md. 
Fixes #5586.
 2017-07-04 15:48:06 -07:00
Tim Abbott c2ee259987 settings: Simplify testing code for bool realm settings. 
Now, when we add a new realm setting with the bool type, we don't need
to edit the tests at all.
 2017-07-04 14:23:05 -07:00
Tim Abbott b2ada7e706 docs: Expand documentation on Internet access in tests. 2017-07-04 13:17:25 -07:00
Aditya Bansal 26c345f059 backend: Block network access to test suites. 
In this commit we basically start to override the request method of
httplib2.Http() to raise an exception whenever it is called i.e.
a trial is made to access the network from test suits.

Fixes: #1472.
 2017-07-04 13:17:20 -07:00
Eeshan Garg 9a992ec4c7 docs: Add documentation guide for integrations and webhooks. 2017-07-03 20:09:34 -04:00
Eeshan Garg 2f054ef4c9 webhook-walkthrough: Mention Zulip's Markdown macros. 2017-07-03 20:09:34 -04:00
Cory Lynch 802ea9abf5 Refactor to delete mousewheel.js. 
This old third party library added support
for a "mousewheel" event to detect scrolling.
However, it is not compatible with jQuery 3
and is obsolete now that there is a standard
"wheel" event that accomplishes the same thing.
 2017-07-03 11:04:20 -04:00
Pweaver (Paul Weaver) 2c10e7c0db Change from and noreply emails to use EXTERNAL_HOST domain. 
This eliminates another mandatory setting from what one needs to
configure to setup a Zulip server.
 2017-07-01 08:09:25 -07:00
Greg Price ec8ead3033 docs/translating: Clarify Handlebars discussion 
I found the new paragraph from 74d83cc47 somewhat hard to follow,
so here's another version.  Also try to make the structure of
the rest of the section around it somewhat more clear.
 2017-06-30 21:59:58 -07:00
Umair Khan 74d83cc47e lint: Disallow handlebars within {{#tr}}{{/tr}}. 
This commit adds a new linter which runs from tools/travis/backend.
It runs over the translations.json file and checks if any of the
translatable string contains handlebars in it.

Fixes #5544
 2017-06-30 10:12:31 -04:00
Rishi Gupta 85d38bd17b emails: Remove DEFAULT_FROM_EMAIL from prod_settings_template. 2017-06-29 17:54:33 -07:00
Cory Lynch 4327402d57 docs: Add tip to record GIFs with Chrome Capture. 2017-06-29 13:26:38 -07:00
Greg Price 8e82bf6532 docs: Write down some high-level thoughts on doing code reviews. 
This started as a PSA in the form of a series of chat messages in
`#general` on chat.zulip.org; putting them here, with some editing,
to make their value more durable.

Also rearrange this doc slightly so that it's not specific to
the server codebase, except in a few explicit spots.

The bit that's for authors should probably be somewhere else.
I think there isn't right now a great natural spot for it --
probably the top of docs/git-guide, some parts of docs/version-control,
and that paragraph here should all turn into a top-level "guide
to submitting code to Zulip" doc, which would link to the rest
of docs/git-guide and to some other resources.  Leaving that
for another day.
 2017-06-27 08:23:55 -04:00
Cynthia Lin 1ce8258f2e docs: Add reminder to update ReadTheDocs config in release checklist. 2017-06-26 16:09:36 -07:00
vaibhav f25cf988a3 docs: Add flask server documentation. 
Flask server is a simple python server which can be used to interact with bots
through outgoing webhook services.
 2017-06-22 09:48:09 -04:00
Vaida Plankyte 0ed4e22e54 docs: Fix lint/whitespace errors in GCI docs. 2017-06-22 09:30:28 -04:00
Vaida Plankyte 72d126ab78 docs: Change GCI links to point to main repo. 2017-06-22 09:30:28 -04:00
Vaida Plankyte f880ee4ba0 docs: Move GCI docs into main repo. 2017-06-22 09:30:28 -04:00
Vaida Plankyte 15b058121f docs: Fix linking & typos in WIP PR section in git-guide. 2017-06-22 09:28:52 -04:00
Vaida Plankyte 6d2b1e2284 docs: Clarify tools/ script usage in git-guide. 2017-06-22 07:48:32 -04:00
Greg Price 3286fbe8e3 docs/translating: Follow-on cleanups from removing Django templates. 
This follows up the recent commit
3d1d09b3d docs: Remove discussion of old Django templating engine.
with a small grammar fix and removing another vestige of making the
distinction between Jinja2 and Django templates, and also rearranges
the logic slightly to reflect that backend and frontend templates
have separate sections.

Probably a bigger restructuring is in order to help the reader
navigate through all the good content in this doc, but that's
a bigger job for another day.
 2017-06-21 19:05:54 -07:00
Cynthia Lin ac25f515e0 docs: Update ReadTheDocs meta tags. 
Fixes #5482
 2017-06-20 20:59:16 -04:00
Vaida Plankyte 009fa9be1e docs: Add info on using tools/ scripts for fetching PRs. 2017-06-20 11:37:33 -04:00
Vaida Plankyte 0595764807 docs: Add alternative snippet for checking out branch. 2017-06-20 11:37:33 -04:00
Vaida Plankyte 22199d6044 docs: Fix code snippet typo in git-guide.md. 2017-06-20 11:37:33 -04:00
Cynthia Lin 9777496046 repository: Update information with Codecov migration. 2017-06-20 07:17:39 -04:00
Steve Howell 2d06a280b6 Fix broken IIFE link. 
(We now just point the user to a Google search.)
 2017-06-19 09:46:06 -04:00
Vaida Plankyte 52c351aa27 docs: Fix trailing whitespace in git-guide.md. 2017-06-19 07:52:07 -04:00
Vaida Plankyte b02b49ca4e docs: Add screenshot-and-gif-software.md and link to it. 2017-06-19 07:52:07 -04:00
Tim Abbott d98c0d3178 docs: Add a brief architecture overview section on frontend. 2017-06-15 11:55:39 -07:00
Tim Abbott 3d1d09b3d3 docs: Remove discussion of old Django templating engine. 
This was unnecessary complexity for users, and in fact, we removed the
code a couple months ago.
 2017-06-15 11:55:39 -07:00
Tim Abbott 2c76f2b1e3 docs: Document file uploads in nginx section of overview. 2017-06-15 11:54:18 -07:00
Tim Abbott 115bd3ea3c docs: Fix broken link. 2017-06-15 11:52:33 -07:00
Tim Abbott c68484dfd7 docs: Attempt to clarify a bit more the new GitHub step. 2017-06-15 11:33:33 -07:00
Tim Abbott 7668908903 docs: Improve Git guide discussion of names. 2017-06-15 11:33:32 -07:00
Vaida Plankyte 47b450de8c docs: Add links towards GitHub guide in installation instructions. 
This adds two extra links to
http://zulip.readthedocs.io/en/latest/git-guide.html#set-up-git: in
the overall requirements, and once before Step 2: Get Zulip Code.

Fixes #2985.
 2017-06-15 11:30:55 -07:00
Vaida Plankyte 4e5ae83fb0 docs: Emphasise running Git BASH as admin under Win10. 2017-06-15 09:58:19 -07:00
Tim Abbott f4aec8fedd docs: Reorganize git guide discussion of WIP pull requests. 2017-06-15 02:13:24 -07:00
Vaida Plankyte f56ecdd34f docs: Emphasise WIP PRs in git-guide.md. 
Fiuxes #3233.
 2017-06-15 02:05:57 -07:00
Cory Lynch 3e10bdf0e8 docs: Print output URL in Makefile. 2017-06-14 20:16:08 -07:00
Cory Lynch 3bc369f1cf tools: Add wrapper tool 'build-docs' for building documentation. 2017-06-14 20:16:02 -07:00
Cynthia Lin 1d5a5036c5 repository: Add CODE_OF_CONDUCT.md. 2017-06-14 18:43:08 -07:00
Tim Abbott fa87c6113d docs: Document that we use `ts` automatically in Travis CI. 2017-06-14 17:26:41 -07:00
Steve Howell d8598e18e0 changelog: Suggest creating indexes for starred/mentioned. 2017-06-13 13:58:58 -07:00
Robert Hönig f9c5086658 bots: Rename BotHandlerApi object `client` to `bot_handler`. 2017-06-13 11:13:23 -07:00
Tim Abbott 357105a4c1 docs: Fix recently changed URLs to Python packaging guide. 2017-06-12 22:39:15 -07:00
Pweaver (Paul Weaver) 5c07125994 Enable EmailAuthBackend by default to simplify a production install. 
This should save a step from the installation process in the common
case.
 2017-06-12 21:53:35 -07:00
Tim Abbott 2ae1e7f5e6 docs: Fix broken mailgun link. 
It appears that Mailgun upddated their documentation URL structure.
 2017-06-12 21:06:40 -07:00
Tim Abbott f4484bd7e2 docs: Fix broken links to old chinese language code. 2017-06-12 21:06:01 -07:00
Tim Abbott dd61f202d3 docs: Remove links to old zulip.com. 2017-06-12 20:42:40 -07:00
Rafid Aslam 4f482834b4 deps: Upgrade and move `perfect-scrollbar` from `static/third` to `npm`. 
- Remove `perfect-scrollbar` from `static/third` and fetch it from npm.
- Upgrade `perfect-scrollbar` to 0.7.1.
- Bump up the `PROVISION_VERSION` to 5.6.

Changed `wheelSpeed` in "static/js/scroll_bar.js" to 0.5, because when it
20, the scrollbar scrolls very fast.

Changed 'wheelSpeed' in "static/js/emoji_picker.js" from 25 to 0.68
(based on tabbott's testing of scrolling through the emoji list).

Part of #1709.
 2017-06-11 10:15:48 -07:00
Vaida bf2cfa8073 docs: Fix mispelled tool name in translating.md. 2017-06-11 10:12:54 -07:00
Rishi Gupta 8ea7d01aed docs: Fix ToS link in prod-mobile-push-notifications. 2017-06-11 08:27:12 -05:00
Rishi Gupta ed8e95f0dd docs: Add documentation of our email system. 2017-06-11 08:27:12 -05:00
Tim Abbott 75c72552db docs: Fix quoting of push bouncer URL. 2017-06-09 10:06:34 -07:00
Rishi Gupta 443c4cfbf6 docs: Update instructions in prod-mobile-push-notifications. 2017-06-08 15:49:41 -07:00
Tim Abbott ed818f12a2 docs: Add link to font awesome accessibility docs. 2017-06-08 14:05:18 -07:00
Tim Abbott e1110308fc docs: Update push notifications setup/testing instructions. 2017-06-08 13:40:08 -07:00
Tim Abbott 4baf169690 docs: Highlight getting started guide more strongly. 2017-06-08 13:28:51 -07:00
Feorlen 7124098a8e Explain how to add Swagger REST API doc coverage in zulip.yaml. 
Introduce Swagger UI and the Swagger/OpenAPI specification. Explain
the structure of zulip.yaml and show examples of different sections
of the file.

This is a new file in /docs not yet included in the Read the Docs
table of contents. Where it should go should be determined as we iterate
on the Swagger UI integration and expand REST API doc coverage using it.

For more on Swagger UI and how Zulip uses it, see:
https://github.com/zulip/zulip/issues/3474
https://github.com/zulip/zulip/pull/3397

With some minor tweaks to advertise this by tabbott.
 2017-06-07 22:46:20 -07:00
Greg Price d89a944902 docs/version-control: Revise "Commit Messages" section. 
The formatting was coming out pretty badly on readthedocs,
and also I think the exposition could be a little clearer.

I still don't love how the formatting comes out, but
I think this is pretty OK.
 2017-06-07 22:08:55 -07:00
Greg Price 8ff5e09b07 docs/version-control: Small wording and formatting tweaks. 2017-06-07 22:08:55 -07:00
Rohitt Vashishtha 7125ea6b61 docs: Update git-guide with tools/clean-branches. 2017-06-06 23:50:36 -07:00
Rohitt Vashishtha 7a81591f38 docs: Update git-guide with tools/fetch-pull-request. 2017-06-06 23:50:36 -07:00
Tim Abbott 27de57b621 docs: Document new user discussion streams. 2017-06-06 17:38:50 -07:00
Tim Abbott 2e9f469c9a Release Zulip Server 1.6.0. 2017-06-06 16:57:10 -07:00
Tim Abbott b286a4210e docs: Update release checklist. 2017-06-06 14:20:13 -07:00
Tim Abbott 2215af4b57 docs: Add a bunch of documentation on Travis CI. 2017-06-06 13:39:51 -07:00
derAnfaenger 64ab1080dc docs: Update directory-structure.md with new bots dirs. 2017-06-06 08:51:16 -07:00
derAnfaenger a596878fe1 docs: Fix header structure in bots-guide.md. 2017-06-06 08:51:16 -07:00
rht 486e4e30da Update 'OS X' reference to macOS. 2017-06-05 22:11:34 -07:00
Steve Howell 0d08edc6b6 docs: Add note about tools/linter_lib to lint docs. 2017-06-05 09:20:21 -07:00
Joshua Pan 28f2d33543 docs: Tweak developer discussions in chat-zulip-org doc. 2017-06-04 13:25:09 -07:00
Tim Abbott 772b51f938 docs: Update chat-zulip-org to discuss chat meetings. 2017-06-04 12:31:45 -07:00
Tim Abbott a3515b2f06 docs: Improve documentation on resource requirements. 2017-06-03 23:40:38 -07:00
Tim Abbott e8166ee1b0 docs: Update installation docs for new RAM requirements. 
This is a follow-up to #32.
 2017-06-03 23:30:55 -07:00
Tim Abbott 907a059301 docs: update changelog with recent changes and 1.5.2 release. 2017-06-02 17:49:13 -07:00
Eeshan Garg 32786802b0 docs: Document the release process for the Zulip API PyPI package. 2017-06-02 17:08:00 -07:00
Cory Lynch 76a497650b docs: Update feature tutorial for server_events_dispatch.js. 2017-06-02 16:51:46 -07:00
Tim Abbott d9b8da2483 docs: Fix emoji cache setup when not using provision.py. 
There were 2 things wrong here:
(1) The new emoji cache directories weren't being created properly
(2) We weren't downloading the new emoji sprite sheets.

I think based on this experience, we should definitely invest in
moving more platforms to use provision.py.

Fixes #5160.
 2017-06-02 15:21:46 -07:00
Rohitt Vashishtha db9918f3d6 bots: Move contrib_bots to api/bots*. 
This will make it convenient to include these bots in Zulip API
releases on pypi.

Fix #5009.
 2017-06-01 12:31:54 -07:00
Saket Kumar 5093adf3f5 Update reading-list.md 
Adds some course for React Native and Java Beginners.
 2017-06-01 09:35:18 -06:00
neiljp 9b13b19006 docs: Add ')' and correct reference to step number in bots guide. 2017-05-29 20:52:23 -07:00
Abhijeet Kaur 9f17bded92 Fix minor errors in bots-guide. 2017-05-29 20:41:15 -07:00
derAnfaenger 735aa9f2c6 Rename misleading 'system-docs' reference. 2017-05-28 22:21:13 -07:00
derAnfaenger c0f0dabec6 Rename misleading 'code-docs' reference. 2017-05-28 22:21:13 -07:00
derAnfaenger 7f6b6fae26 Rename misleading 'tutorial-docs' reference. 2017-05-28 22:21:13 -07:00
derAnfaenger f6c59a483c docs: Rename misleading 'dev-install-docs' reference. 2017-05-28 22:21:13 -07:00
derAnfaenger 54a618b597 docs: Rename misleading 'prod-install-docs' reference. 2017-05-28 22:21:13 -07:00
derAnfaenger 9c0ba87b5e docs: Rename misleading 'user-docs' reference. 2017-05-28 22:21:13 -07:00
Ian Winter a277164ad6 docs: Add new functions to bots-guide.md. 
This commit reflects the recent changes being
done to the `contrib_bots` API and introduces
the new methods in the docs.
 2017-05-28 17:46:25 -07:00
Pweaver (Paul Weaver) 2a394708ba Modify front-end-build-process.md to reflect use of typescript. 2017-05-28 17:32:49 -07:00
Tim Abbott 4a8eb8775f docs: Fix a link on accessibility page. 2017-05-26 21:02:47 -07:00
Tim Abbott 9b050f4cac bots: Remove legacy bots/ directory. 2017-05-26 15:21:30 -07:00
Reid Barton 2f21290407 bots: Move IRC and Jabber mirror scripts to api/integrations. 
This is part of cleaning out the old bots/ top level directory.
 2017-05-26 15:04:55 -07:00
Tim Abbott 944935dbe3 docs: Update Git tips blog post in reading list. 2017-05-25 15:29:37 -07:00
Reid Barton ccc2451b93 docs: Add missing single quote in EMAIL_FILE_PATH. 2017-05-24 17:37:49 -07:00
Mahim Goyal 44ff978ecb docs: Add a mounting shared folder error for vagrant. 
I faced this problem many a times, might be of help to
beginners. Because, the same thing doesn't work when done through
`vagrant suspend` followed by `vagrant up`.
 2017-05-24 11:54:00 -07:00
Theodore Chen c29e0b4c32 docs: Recommend testing contrib_bots with helloworld bot. 2017-05-23 20:22:40 -07:00
Tim Abbott e1f6b8135f docs: Fix long lines in accessibility document. 2017-05-22 19:12:43 -07:00
Jeremy Bowman cdb4d9852b Add accessibility documentation. 2017-05-22 18:46:02 -07:00
Elliott Jin ce9c3b7a0f Add clarifications to bots guide. 2017-05-22 16:51:29 -07:00
Elliott Jin 59bfc9bf69 Clean up bots guide. 
Due to the directory symlink structure in the dev VM, including the
`~/zulip/contrib_bots/` prefix in the command for running a bot causes
`run.py` to fail with an error.
 2017-05-22 13:49:02 -07:00
Robert Hönig 9fcd63bdf9 docs: Refine bots-guide.md. 2017-05-22 11:18:14 -07:00
Carey Metcalfe c2c7377719 Fix documentation for Debian Jessie 
Adds some dependancies and specialized instructions for installing
pgroonga.
 2017-05-22 11:08:43 -07:00
Tim Abbott a2f5d133e8 docs: Document the push notification forwarding service. 2017-05-18 13:39:58 -07:00
Joshua Pan 3e4fb01685 changelog: Minor grammar and wording changes. 2017-05-17 18:42:48 -07:00
Greg Price d76e9b7d71 docs: Add Vagrant instructions for Debian "stretch". 
Aka the current "testing" release, expected to graduate to "stable"
later in 2017.

Fortunately the instructions are very similar to those for
Ubuntu 16.04 and 14.04 -- two packages don't exist, and
those two packages turn out (empirically, on my laptop)
not to be necessary.

Leave most references to "Ubuntu" still just saying "Ubuntu",
on the theory that Debian users will generally follow those
breadcrumbs where they lead and in order to keep lists short.
 2017-05-17 13:04:30 -07:00
Tim Abbott f970ea935b docs: Update changelog. 2017-05-16 21:39:11 -07:00
Tim Abbott 7a545eeb13 docs: Update copyright notices for 2017. 
Also record Kandra Labs, Inc., as a major copyright holder.
 2017-05-16 19:04:59 -07:00
Tim Abbott 44113d6436 docs: Update link to python-social-auth. 2017-05-13 23:00:50 -07:00
Tim Abbott 97abaae9af home: Remove now-unnecessary page_params_core_fields duplication. 
Also, we update the documentation to make the overall system a bit
clearer.

Fixes #4628.
 2017-05-13 22:58:18 -07:00
Eeshan Garg 762850876b integration-guide: Replace references to old style fixture names. 
The integration-guide has now been updated to reflect the recent
decision to rename webhook fixtures from
<webhook_name>/fixtures/<webhook_name>_<event_type>.json to
<webhook_name>/fixtures/<event_type>.json.
 2017-05-13 20:22:40 -02:30
Eeshan Garg eb229dd40e webhook-walkthrough: Replace references to old style fixture names. 
The webhook-walkthrough has now been updated to reflect the recent
decision to rename webhook fixtures from
<webhook_name>/fixtures/<webhook_name>_<event_type>.json to
<webhook_name>/fixtures/<event_type>.json.
 2017-05-13 20:13:35 -02:30
rht 34ffda9a1e docs: Fix a bunch of documentation build warnings. 
This helps clean unnecessary warnings out of Zulip's Travis CI output.
 2017-05-13 10:09:20 -07:00
Tim Abbott 937dcdde59 docs: Update which projects are marked complete in roadmap. 
We need to do a more significant update soon, but this will at least
make things passable for now.
 2017-05-09 14:34:53 -07:00
Tim Abbott 68be0edc67 Update changelog since the Zulip 1.5 release. 
It's amazing how much we've done in the last few months.
 2017-05-09 14:02:24 -07:00
Steve Howell 0a0f567aeb Split out markdown.js from echo.js. 
The new module handles markdown rendering.

The code left behind in echo.js does local-echo kind of things
like reifying message ids.
 2017-05-09 11:06:10 -07:00
Aditya Bansal e83b703780 pep8: Add compliance with rule E261 to docs/conf.py. 2017-05-07 23:21:50 -07:00
hackerkid 6329b472b0 docs: Update the path of Supervisor config file. 
zulip.conf was changed to template file but the update was missed out in the doc.
See ae09d55e46
 2017-05-07 23:20:38 -07:00
Tim Abbott 15c6d683a9 docs: Add notes on future direction to the bots guide. 2017-05-05 13:28:40 -07:00
Tim Abbott 21f766c6dd docs: Further clarify that the bots guide doesn't need your own server. 2017-05-05 13:28:40 -07:00
derAnfaenger e0ec664994 documentation: Clarify deployment requirements. 
This commit removes the false statement that deploying
a bot requires an own Zulip development server and
updates the instructions respectively.
 2017-05-05 13:28:40 -07:00
jersou 1a89928999 docker: Fix setting owner of /srv/zulip inside container. 2017-05-05 09:37:38 -07:00
Josh Mandel 92a25f2b91 Update migration instructions to use previous rabbitmq secret. 2017-05-04 19:44:44 -07:00
Umair Khan 6b1c53059b testing: Run in parallel mode by default. 
This commit changes the backend testing framework to run
in parallel mode which is same as --processes=4. If --coverage
is supplied, we enforce serial mode, --processes=1, because
coverage is not compatible with parallel mode at the moment.
 2017-05-04 16:06:34 -07:00
Eeshan Garg c388baa431 docs: Document zerver.models.Client's usage for analytics and webhooks. 2017-05-01 23:50:51 -07:00
Eeshan Garg e87e246fcb zerver/decorator: Set request.client in api_key_only_webhook_view. 
Previously, api_key_only_webhook_view passed 3 positional arguments
(request, user_profile, and client) into a function. However, most
of our other auth decorators only pass 2 positional arguments. For
the sake of consistency, we now make api_key_only_webhook_view set
request.client and pass only request and user_profile as positional
arguments.
 2017-05-01 23:44:07 -07:00
Cory Lynch 0965c43238 Add typeahead for syntax highlighting languages. 
Modified composebox_typeahead.js to recognize the triple backtick
and tilde for code blocks, and added appropriate typeahead functions
in that file and in typeahead_helper.js.

Additionally, a new file pygments_data.js contains a dictionary of
the supported languages, mapping to relative popularity
rankings. These rankings determine the order of sort of the
languages in the typeahead.

This JavaScript file is actually in static/generated/pygments_data.js, as it
is generated by a Python script, tools/build_pymgents_data.py. This is
so that if Pygments adds support for new languages, the JavaScript file
will be updated appropriately. This python script uses a set of popularity
rankings defined in lang.json.

Corresponding unit tests were also added.

Fixes #4111.
 2017-04-28 17:22:59 -07:00
Eeshan Garg 8ad3a8bc9a integration-guide: Replace references to old-style fixture directories. 
The integration guide has now been updated to reflect the recent
decision to store webhook fixtures in
zerver/webhooks/<webhook_name>/fixtures/ as opposed to
zerver/fixtures/<webhook_name>/.
 2017-04-28 11:07:03 -07:00
Eeshan Garg b3ffffd3b7 webhook-walkthrough: Replace references to old-style fixture directories. 
The webhook walkthrough has now been updated to reflect the recent
decision to store webhook fixtures in
zerver/webhooks/<webhook_name>/fixtures/ as opposed to
zerver/fixtures/<webhook_name>/.
 2017-04-28 11:07:03 -07:00
Diego Berrocal e0a45640d2 Documentation: Improve new feature tutorial. 
Resolves a few comments from #4598.
 2017-04-26 16:19:51 -07:00
Tim Abbott 60225012e6 unread: Add tool for marking all messages as unread for testing. 
This tool can save a lot of manual work in testing our unread counts
logic.
 2017-04-25 15:40:12 -07:00
vbNETonIce cb2181d42d Update prod-maintain-secure-upgrade.md 
fixing typo in line 370: 'we should' > 'we show'
 2017-04-25 15:25:22 -07:00
Sarah faf20d9b47 Documentation: Update new feature tutorial. 
Update the steps listed in the "Writing a new application
feature" section, based on changes to how realm properties
are created and updated on the backend.

Addresses part of issue #3854.
 2017-04-25 11:16:27 -07:00
Eeshan Garg 047c02781c webhook-walkthrough: Recommend passing kwargs to build_webhook_url. 
When constructing URLs for testing, we now recommend passing
query parameters as keyword arguments to build_webhook_url
instead of overriding it.
 2017-04-25 10:46:21 -07:00
Cynthia Lin a267c61cdd integrations: Update docs for adding integration images. 2017-04-24 22:34:36 -07:00
Emilio Aburto L a8521dc988 docs: Update Docker development instructions to include chown. 
This adds a command to change ownership of /srv/zulip to the zulip
user.
 2017-04-24 21:40:44 -07:00
Maxim Averin 73a1dd63d5 analytics: Refactor legacy 'zulip_internal' decorator. 
Rename 'zulip_internal' decorator to 'require_server_admin', add
documentation for 'server_admin', explaining how to give permission
for ./activity page.

Fixes: #1463.
 2017-04-22 11:42:02 -07:00
Joshua Pan 64984f5bf4 Rename tools/lint-all to tools/lint. 
Fixes #4574.
 2017-04-21 14:57:47 -07:00
Joshua Pan 11878313fb docs: Tweak reset-to-pull-request warning. 
Tweaked this warning because we currently check if there are any
uncommited changes before we reset to a specific pull request.

Changes expanded a bit by tabbott.
 2017-04-21 10:12:04 -07:00
Tim Abbott 21c4be3f00 chat-zulip-org: Document learning stream. 2017-04-20 16:04:42 -07:00
Rishi Gupta 2535f6c8f2 docs: Remove CountStat description from analytics.md. 
It is no longer correct, as of the string of commits ending in 49bd330.
 2017-04-18 11:02:51 -07:00
Raghav Jajodia 014ec04620 docs: Update docs to include `renumber-migrations` tool. 2017-04-17 20:53:35 -07:00
hackerkid 4c0a5cf7fb docs: Update code-style.md to reflect timezone import change. 2017-04-16 12:28:56 -07:00
Rishi Gupta 5e1c8e4532 docs: Update chat-zulip-org with instruction to use gender-neutral language. 2017-04-15 16:53:04 -07:00
Rishi Gupta 0554ec13e8 docs: Update code of conduct. 2017-04-15 16:53:04 -07:00
Rishi Gupta b3991e2557 counts.py: Move CountStat.group_by into ZerverCountQuery. 
Part of a larger refactoring to reduce cyclic dependencies between CountStat
and DataCollector (coming soon).
 2017-04-14 11:41:07 -07:00
Rishi Gupta 341e1b54fc counts.py: Remove zerver_table from ZerverCountQuery. 
Was only needed for filter_args, which are now gone.
 2017-04-14 11:41:07 -07:00
Rishi Gupta 661de6bf25 counts.py: Remove filter_args argument from CountStat definition. 
It turned out to not be that useful once we added subgroup. The previous
design of the CountStat object also assumed more reuseability of the *_query
strings than what ended up happening.

The filter_args also had some carrying costs:

* It's hard to be confident that filter_args other than the ones explicitly
  in our tests would have had expected behavior.
* The filter_args/join_args system is the most complex part of the CountStat
  object, and makes understanding the *_query strings unnecessarily
  difficult for a new contributor.
 2017-04-14 11:41:07 -07:00
Rishi Gupta 9b661ca91f analytics: Replace CountStat.is_gauge with interval. 
Groundwork for allowing stats like "Monthly Active Users".

CountStat.interval is no longer as clean a value as before, so removed it
from views.get_chart_data. It wasn't being used by the frontend anyway.

Removing interval from logger calls in counts.py is not a big loss since we
now include the frequency (which is typically also the interval) in
CountStat.property.
 2017-04-14 11:41:07 -07:00
K.Kanakhin 4891a8d850 Add default response for `terms` and `privacy` endpoints. 
- Add setting for `privacy policy` template defining.
- Configure default templates for `privacy policy` and
  `terms of service` pages.
- Add route for privacy page.
- Remove condition for showing `privacy` and `terms` pages.
- Add `privacy_policy` setting to context processor.
- Add documentaion part for `privacy` and `terms` templates
  configuration.
- Add tests.

Fixes #3686.
 2017-04-12 14:09:14 -07:00
Adarsh S d54dea819d Add option for re-running failed tests. 
This adds the option '--rerun' to the `test-backend` infrastructure.
It runs the tests that failed during the last 'test-backend' run.  It
works by stailing failed test info at var/last_test_failure.json

Cleaned up by Umair Khan and Tim Abbott.
 2017-04-12 11:35:31 -07:00
Joshua Pan b39006655e prod-requirements.md: Fix grammar. 
Change "strong" to "strongly" (adverb).
 2017-04-11 22:30:02 -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
Sumana Harihareswara 314843304d Add expectations for office hours and sprints. 2017-04-06 14:07:01 -07:00
Tomasz Kolek 5b17622589 docs: Move integrations.html to integrations/index.html. 
Add omiting rule for all of integrations docs in test_templates.
 2017-04-05 13:19:58 -07:00
Aditya Bansal a9cb193b51 docs: Update icon instructions to use the new font awesome CSS classes. 
We basically want readers to use the new fa class as the base class
instead of icon-vector while using icons from font-awesome library.
 2017-04-05 12:05:08 -07:00
Steve Howell 6b4825a763 tools: Convert test-js-with-node to Python. 
This is mostly a straight port from bash to Python, but we
rename the coverage option to `--coverage` and we add checks
for being in a venv and being correctly provisioned.

Fixes #4009.
 2017-04-05 12:02:49 -07:00
Harshit Bansal ac2172e233 models: Rename RealmAlias model to RealmDomain. 
Includes a migration.
 2017-04-04 15:48:03 -07:00
Luis Saul Trinidad d8fad9587c code-style.md: Fix typo for selected_related(). 
This changes a mention to QuerySet's method `.select_related()` which was written as `.selected_related()`.
 2017-04-03 06:43:19 -07:00
Rishi Gupta c65f9c1510 docs: Update reference to font awesome version in user-docs. 2017-03-29 11:36:51 -07:00
Yago González 0b87118b03 docs: Add explanation on small fixes in PRs. 2017-03-27 14:44:33 -07:00
Steve Howell c0a6038a95 css: Enforce one selector per line. 
While it's sometimes nice to put a few selectors on the same line,
it is generally better to have a consistent way of formatting our
selectors, and most of our code up until now lists them vertically.
This change fixes the linter to enforce one selector per line, and
it cleans up the places in the CSS where we had multiple selectors
on the same line.

The advantages of one-per-line are as followers:
    * cleaner diffs
    * easier to see when multiple areas of the app may have the
      same format
    * less likely to go over 80 cols
    * makes it more clear where we have deep nesting in the
      individual selectors
    * makes it easier for our linting tools to enforce
      whitespace violations

This also fixed an old bug where we had ".landing_page h2, h4", which
sets "h4" styles outside of the landing page.
 2017-03-26 16:57:33 -07:00
Moritz Neeb 65e8d66376 docs: hashchange-system: add more detail and fix some sentences. 
Edited slightly by tabbott for typos and line-wrapping.
 2017-03-23 15:15:44 -07:00
Tim Abbott 06492738b5 dev: Expose coverage and built documentation to web. 
This makes it much more convenient for developers to access coverage
and built developer documentation.
 2017-03-23 13:10:06 -07:00
Tim Abbott 2a5e600623 glossary: Add a few comment useful terms. 2017-03-22 15:49:20 -07:00
Moritz Neeb b96d18eb6f documentation: explain the term "bankruptcy". 2017-03-22 15:49:19 -07:00
Tim Abbott 2a5269baa9 docs: Document the frontend hashchange system. 2017-03-22 15:21:36 -07:00
adnrs96 a91012bd70 Move thirdparty-fonts.css from static/styles to static/third. 2017-03-21 13:40:05 -07:00
Steve Howell b98cd55ddb Add ui_report shim. 2017-03-19 11:05:44 -07:00
Yago González a5ecb5e5cf docs: Fix minor link formatting. 2017-03-19 09:16:06 -07:00
Akash Kothawale 93a00d9772 docs: Add missing backtick in architecture-overview. 2017-03-19 09:12:14 -07:00
Yago González 30c0023847 docs: Explain Python 2/3 virtualenvs. 2017-03-19 08:56:19 -07:00
sonali0901 49c2472006 docs: Document use of vagrant provision to troubleshoot. 
Also documents `provision.log` a bit more.

Tweaked and moved around significantly by tabbott.

Fixes #1886.
 2017-03-17 12:58:46 -07:00
Cynthia Lin 5a95583527 docs: Update zulipbot guide with new features. 2017-03-15 18:01:23 -07:00
Rishi Gupta 40fb6ea80e lint: Prevent importing from zerver in migrations. 2017-03-15 12:02:24 -07:00
Umair Khan 83dd901ecf Add capitalization checker tool. 
Initial rules significantly by modified by tabbott, who also added the
hacky list of excludes that the tool can't handle correctly yet.

Fixes: #3899.
 2017-03-09 00:44:57 -08:00
Tim Abbott 3b59e6c3cc subs: Rename /#subscriptions to /#streams. 
Fixes #3653.
 2017-03-08 16:57:58 -08:00
Tim Abbott 5cc900eca6 README: Rename peer review -> code review. 2017-03-08 11:44:33 -08:00
Tim Abbott 3d98b1cdef tests: Extract zerver/tests/test_queue_worker.py. 2017-03-08 03:57:37 -08:00
Abhijeet Kaur b8341280e8 doc updates: Remove triage_message function from contrib-bots. 2017-03-07 22:23:11 -08:00
Elliott Jin fa9b8d8114 docs: Fix typos in events-system.md. 2017-03-07 19:46:16 -08:00
Tim Abbott d681ef470d docs: Fully desupport the old iOS app. 2017-03-07 16:48:27 -08:00
Tim Abbott d9eb011da1 docs: Extend discussion of package.json. 2017-03-07 16:39:50 -08:00
Yago González 155978fefd docs: Improve the frontend build process. 2017-03-07 16:37:09 -08:00
Eeshan Garg 70df1f5829 new-feature-tutorial: Recommend updating user documentation. 
Fixes: #3876
 2017-03-05 23:04:56 -08:00
Tim Abbott bd0d6bb9d2 docs: Add discussion of VFL to front-end-build-process.md. 
Also, link to this from various Python files where relevant.
 2017-03-04 21:14:17 -08:00
Tim Abbott 7a048133bf docs: Fix typo in link to translating docs. 2017-03-04 20:58:50 -08:00
Tim Abbott b62cd866e1 docs: Significantly update static asset pipeline docs. 2017-03-04 20:58:30 -08:00
Tim Abbott 0569f8fb5f Document using slow scaleway machines to reproduce casper failures. 
Fixes #1110.
 2017-03-04 18:23:35 -08:00
Cynthia Lin ccbe0b56c3 docs: Document zulipbot and its usage. 
Tweaked by tabbott to document why we need it.

Fixes #3771
 2017-03-04 17:44:43 -08:00
Tim Abbott d25bfb88d3 lint: Ban importing zerver.models in database migrations. 
This doesn't work correctly, but in a subtle way.
 2017-03-04 17:32:48 -08:00
Rishi Gupta 3348083017 docs: Add code style section about naive datetime objects. 2017-03-01 23:03:56 -08:00
Tim Abbott 97c23bc1ab compose: Rename 'New stream message' to 'New topic'. 
This doesn't update documentation, because we need to update that
anyway to show screenshots of the new compose box.
 2017-03-01 21:31:43 -08:00
Tim Abbott 1c73ddd4c6 docs: Advertise tagging strings for translation in a few places. 2017-02-28 20:41:40 -08:00
Raghav Jajodia f140810ad9 Fix stray zerver/views/__init__.py in new-feature-tutorial. 
That file was cleaned out a while ago :).
 2017-02-28 09:45:56 -08:00
Feorlen 57e64daeb9 Explain Django "Invalid HTTP_HOST header" log message. 2017-02-27 00:13:32 -08:00
Elliott Jin b2b1977138 docs: Fix typo in new-feature-tutorial.md. 2017-02-25 00:53:02 -08:00
Brock Whittaker 0f9a5108fc settings: Change admin pages to have readonly view for non-admins. 
This changes the layout of administration for non-administrators such
that they can view organization settings and emoji settings and
displays everything as readonly unless they have the capability to edit.

For now, we just enabled this for the emoji settings and organization
settings features.
 2017-02-23 14:20:31 -08:00
Tim Abbott ce91a43eee docs: Expand discussion of database schema migrations. 
This covers the standard multi-step process for doing large
migrations, as well as other important properties to consider when
writing migrations.

Also documents the new Django 'atomic=False' option.

Fixes #1332.
 2017-02-22 23:44:35 -08:00
Tim Abbott 32c2982299 docs: Document migration atomicity issues. 2017-02-22 23:35:37 -08:00
Tim Abbott cf444203c4 docs: Update email configuration documentation. 
Fixes #2958.
 2017-02-22 22:26:43 -08:00
Tim Abbott 8c1285924e prod_settings_template: Move email configuration up. 
This reflects the fact that you definitely need to configure this, but
you don't have to configure any of the auth backends, really.
 2017-02-22 22:26:43 -08:00
Tim Abbott 7964408633 prod_settings_template: Move ALLOWED_HOSTS up and clarify. 2017-02-22 22:26:43 -08:00
Tim Abbott e208002002 docs: Improve install discussion of settings. 2017-02-22 22:26:43 -08:00
Rishi Gupta 42fc317262 developer docs: Add doc for analytics subsystem. 2017-02-22 22:12:40 -08:00
Sourav Badami 03861e5418 docs: Fix typo in new-feature-tutorial.md. 2017-02-22 00:37:59 -08:00
Tim Abbott f52d812a71 events: Extract apply_event helper. 
This mostly just saves us a level of messy indentation.
 2017-02-20 11:16:35 -08:00
Tim Abbott 8da7976058 queues: Add new system for managing rabbitmq per-queue work. 
Our lists of rabbitmq queues was likely to end up out of date, since
there was nothing enforcing that the various lists of queues were
correct or the same as each other.
 2017-02-19 16:18:37 -08:00
Tim Abbott 6ad883fb61 docs: Update queuing documentation for new templates. 2017-02-19 13:12:34 -08:00
Feorlen 87429e1ff9 Fix typo in webhook "Create documentation" section. 2017-02-19 10:02:33 -08:00
Feorlen 0578ad1563 Add an Advanced topics section. 
Add a new section after the Hello World walkthrough for additional detail that
doesn't directly apply to this example. Included are discussions on creating
negative tests and handling custom query parameters.

Remaining integration of the material originally for #3478
 2017-02-18 21:03:28 -08:00
Feorlen a97e0f6730 Add detail to the existing Hello World webhook example. 
Fill in additonal detail following the existing document structure.
Includes authentication, custom streams, negative tests, and types
of test data and fixtures. Also fix typos and reformat to match the
new integration doc style.

Partial integration of the material originally for #3478
 2017-02-18 21:03:28 -08:00
Tim Abbott ecadb33fbc test-backend: Add 100% test coverage assertions. 
This adds an assertion, when `test-backend` is run with `--coverage`,
that we have 100% test coverage on a list of files that we expect to.
There's a whitelist/blacklist, managed in tools/test-backend.

Fixes #3363.
 2017-02-18 16:34:40 -08:00
Rishi Gupta e83d69def8 docs: Copyedit docs/chat-zulip-org.html. 
Removed the blurb on "#design" since it appears twice.
 2017-02-18 15:03:57 -08:00
Tim Abbott 845f7c10e5 docs: tweak markdown manual testing docs a bit. 2017-02-16 16:24:12 -08:00
Yago González 3746a857af docs: Add details about local echo with Markdown. 2017-02-16 16:24:12 -08:00
Feorlen b2049a3b06 Clarify the install process's use of the root and zulip users. 
Fixes #3680.
 2017-02-14 20:44:20 -08:00
Yago González 1861f02de7 docs: Minor fixes on Zulip's Markdown. 2017-02-14 20:41:29 -08:00
Alicja Raszkowska 1cda0a346f docs: Add a resource to code review doc. 
Add James J. Porter's article on code review.
 2017-02-14 11:32:01 +01:00
Tim Abbott 96f044cb78 docs: Encourage participation in chat.zulip.org. 2017-02-12 17:27:20 -08:00
Tim Abbott fb23d6970e docs: Better describe chat.zulip.org. 2017-02-12 17:16:28 -08:00
Tim Abbott f603235735 docs: Rename #provision -> #provision help. 2017-02-12 17:08:22 -08:00
Tim Abbott 9df733d035 docs: Rename installation help -> production help. 2017-02-12 17:04:05 -08:00
Tim Abbott 9eaa0472d5 docs: Update links to point to new chat-zulip-org.html. 2017-02-12 16:57:14 -08:00
Tim Abbott 35ab9de53c docs: Document chat.zulip.org. 2017-02-12 16:57:11 -08:00
Tim Abbott 29ae1b4d4d docs: Fix link to formal/information in German guide. 2017-02-12 16:46:53 -08:00
Tim Abbott eae125e72f docs: Clarify transifex documentation. 2017-02-11 16:57:50 -08:00
Robert Hönig cbac3fcd64 Merge German translation docs. 
Merge the German translation docs 'general-notes.md' and
'special-terms.md' into one translation guide 'german.md'.
 2017-02-11 16:42:57 -08:00
saisrivathsa b867ac3496 Extract zerver/lib/events.py from actions.py with event registration. 
This moves do_events_register, fetch_initial_state_data and friends to
a new file.

Modified significantly by tabbott for correctness and to remove unused
imports.

Fixes #3635.
 2017-02-10 16:50:43 -08:00
Tim Abbott 92219aa3dd docs: Add a long document explaining the events system. 
This is probably one of Zulip's most important systems, and thus worth
documenting carefully.
 2017-02-10 01:17:15 -08:00
Tim Abbott 092bdc7645 docs: Update the casper docs based on recent debugging. 
Having just found that a number of our casper tests were buggy because
they were using casper.waitForSelector and fixed those, this seemed
like a good opportunity to update the docs to recommend the selectors
that more faithfully do what developers expect them to.

While I was at it, I tried to make this a bit better organized, though
I think more work could be done on that front.
 2017-02-09 23:35:11 -08:00
Kouhei Sutou 5764054bbb docs: Fix markup issue in pgroonga docs. 2017-02-08 10:17:23 -08:00
hackerkid 8b2d4f150a Vagrantfile: Add support for a custom post-provision script. 
Documentation tweaked by tabbott.

Fixes #3108.
 2017-02-07 18:38:07 -08:00
Tim Abbott cf4faf6598 docs: Clarify that non-webhook integrations need documentation too. 2017-02-07 18:24:35 -08:00
Feorlen 78b9b83650 Create new webhook walkthrough page from the integration guide. 
Breaks out the Hello World example to create a new
webhook-walkthrough.md. Includes minor edits so the two docs
read well. Adds the new page, "Webhook walkthrough", to the TOC.

Fixes #3498
 2017-02-07 18:22:31 -08:00
Tim Abbott b809646854 Add release notes from Zulip Server 1.5.1. 
Also update version.py to reflect that everything in 1.5.1 is in this
branch.
 2017-02-07 11:40:49 -08:00
Tim Abbott fee394f7b6 roadmap: Mark a bunch of projects as completed. 2017-02-07 10:12:01 -08:00
Tim Abbott e79520c593 Release Zulip Server 1.5.0. 2017-02-06 21:15:17 -08:00
Tim Abbott 4abb6724d0 changelog: Fix a typo in setting name. 2017-02-03 16:34:46 -08:00
Tim Abbott d6c21c7142 docs: Improve translating guide clarity. 
This corrects a few details and increases the billing of writing a
translating style guide.
 2017-02-03 14:45:56 -08:00
Yago González 00a9f68eea docs: Improve the translation guide. 2017-02-03 14:38:52 -08:00
Tim Abbott 633d4d1882 docs: Update customization docs slightly for Zulip 1.5. 
There's more we'll want to do here now that we have /help/, but this
is a good start.
 2017-02-03 12:57:50 -08:00
Tim Abbott 21f09dcab7 docs: Make it harder to screw up our manage.py commands. 2017-02-03 12:57:50 -08:00
Tim Abbott 621e3f68ba docs: Update changelog. 2017-02-02 17:44:17 -08:00
Cynthia Lin 944b809fd7 docs: Replace "search help" with "search operators". 
For better clarification and to avoid confusion with user documentation tab.
 2017-02-02 12:25:58 -08:00
Tim Abbott a03d816983 docs: Update release checklist to mention GitHub. 2017-02-01 09:48:00 -08:00
Yago González a52cd99452 docs: Add book about OSS prod to the reading list. 2017-01-30 11:32:23 -08:00
Steve Howell 00e815e91d Removed duplicates from changelog. 2017-01-30 11:15:28 -08:00
Tim Abbott 96d3bea6d5 Add changelog from Zulip 1.4.3 release. 2017-01-29 15:32:08 -08:00
Tim Abbott d38b552b02 docs: Add initial documentation on the emoji system. 2017-01-29 12:15:29 -08:00
Tim Abbott 0f75c8d4ed docs: Simplify integration guide discussion of writing docs. 
You don't need to know about the div structure of /integrations
anymore, so we shouldn't get into it.
 2017-01-29 11:53:09 -08:00
Tomasz Kolek 3b48f21f5a Add improvements to integration-guide.md. 
Fix some typos, add a few sentences that might clear it a little.
 2017-01-29 11:49:13 -08:00
Tim Abbott e8fd780413 docs: Fix missing wget when downloading tsearch_extra. 
Fixes #3509.
 2017-01-29 11:23:34 -08:00
Yago González d0d0e6956a docs: Improve Spanish style guide. 2017-01-28 19:08:14 -08:00
Tim Abbott 36d54cf5ff Replace references to zulip.com/dist with zulip.org/dist. 
Now that zulip.org has all the files to distribute, there's no reason
to still point to the soon-to-be-decommissioned zulip.com/dist.
 2017-01-28 17:56:25 -08:00
Akash Kothawale 46ffafab7d docs: Use bash to run tools/provision in docker. 2017-01-27 14:54:18 -08:00
hackerkid c42e4000d6 docs: Suggest vagrant provision if up errors. 
Fixes #3486.
 2017-01-27 14:41:29 -08:00
Tim Abbott b52f606c3a Revert "deps: Upgrade and move `jquery-mousewheel` from `static/third` to `npm`" 
Apparently, the updated version of this has a serious scrolling
performance problem in the left sidebar that basically makes scrolling
in that area unusable.

This reverts commit b683b2d3c3.
 2017-01-26 13:42:00 -08:00
Tomasz Kolek 71e6eb68c0 Update integration-guide according to integrations redesign. 
With numerous typo and grammar fixed by tabbott.
 2017-01-26 12:27:38 -08:00
Feorlen eea6eb23f5 Note in linters doc that untracked files aren't linted. 2017-01-25 05:54:46 -08:00
Eitan Adler 0ce29d7ad6 Remove some some duplicate words in copy. 2017-01-23 23:15:04 -08:00
Tim Abbott d6e38e2a5c lint: Clean up E123 PEP-8 rule. 2017-01-23 21:34:26 -08:00
Tim Abbott e9158dd520 lint: Clean up E121 PEP-8 rule. 2017-01-23 21:02:39 -08:00
Tim Abbott e5a3bbab4f docs: Expand explanation for why we use rebase workflow. 2017-01-22 15:42:27 -08:00
Yago González 8ee8118328 docs: Add explanation on the git rebase workflow. 2017-01-22 15:42:27 -08:00
Yago González 495a25ce1b docs: Fix broken URL. 2017-01-22 13:04:37 -08:00
Robert Hönig af0d985bdf Update the commands in bots-guide.md to fit the new contrib_bots layout. 2017-01-22 05:42:46 -08:00
Tim Abbott 15c4ae9ea9 Revert "docs: Remove broken docker links for now." 
This reverts commit ef953af597.

Docker has fixed their website.

Fixes #3394.
 2017-01-20 11:01:12 -08:00
Rafid Aslam b683b2d3c3 deps: Upgrade and move `jquery-mousewheel` from `static/third` to `npm` 
- Remove `jquery-mousewheel` from `static/third` and fetch it from npm.
- Upgrade `jquery-mousewheel` to 3.1.6.
- Bump up the `PROVISION_VERSION` to 4.5.
- Change some js code to comply with this `jquery-mousewheel` version.

Part of #1709.
 2017-01-19 17:24:53 -08:00
Rafid Aslam 10a8c3d2ae deps: Move `xdate` from `static/third` to `npm` 
- Remove `xdate` from `static/third` and fetch it from `npm`.
- Bump up the `PROVISION_VERSION` to 4.3.

Part of #1709.
 2017-01-19 17:07:55 -08:00
Rafid Aslam 84e802422e deps: Upgrade and move `underscore.js` from `static/third` to `npm` 
- Remove `underscore.js` from `static/third` and fetch it from `npm`.
- Upgrade `underscore.js` to 1.8.3.
- Bump up the `PROVISION_VERSION` to 4.2.

Part of #1709
 2017-01-19 17:07:45 -08:00
Rafid Aslam 911fcd3831 deps: Upgrade and move `codepointat` from `static/third` to `npm` 
- Remove `codepointat` from `static/third` and fetch it from `npm`.
- Upgrade `codepointat` to 0.2.0.
- Bump up the `PROVISION_VERSION` to 4.1.

Part of #1709.
 2017-01-19 17:07:32 -08:00
Rafid Aslam 8ac81d2722 deps: Upgrade and move `winchan.js` from `static/third` to `npm` 
- Remove `winchan.js` from `static/third` and fetch it from `npm`.
- Upgrade `winchan` to 0.2.0.
- Bump up the `PROVISION_VERSION` to 4.0.

Part of #1709.
 2017-01-19 17:07:21 -08:00
Tim Abbott ef953af597 docs: Remove broken docker links for now. 2017-01-19 16:42:50 -08:00
Tim Abbott bbba6b7725 Update changelog. 2017-01-18 15:43:25 -08:00
Tim Abbott 287b84d113 auth: Improve configuration/documentation for password strength. 
Followup to #3190.
 2017-01-17 20:52:52 -08:00
Tim Abbott bbead84afa docs: Extract security-model.md. 2017-01-17 20:52:29 -08:00
Yago González e1429c8069 translations: Reorder and update Spanish terms 2017-01-17 14:53:27 -08:00
Yago González 3d6e56eb15 translations: Improve the Spanish style guide. 2017-01-17 14:53:27 -08:00
Cynthia Lin 8d82d6f3c2 docs: Document *Administrator only feature* macro in user documentation styling guide. 2017-01-17 14:45:15 -08:00
Robert Hönig 789ae8648a Add wrapper and log file output for provisioning. 
Before this commit, provisioning was done by executing provision.py,
which printed the log directly to stdout, making debugging harder.
This commit creates a wrapper bash script 'provision' in tools, which
calls 'zulip/scripts/tools/provision_vm.py' (the new location of
provision.py) and prints all the output to
'zulip/var/log/zulip/zulip_provision.log' via 'tee'.
Travis tests and docs have been modified accordingly.
 2017-01-17 14:23:28 -08:00
Tim Abbott 87a6c258a0 docs: Update Changelog since last release. 2017-01-17 14:10:33 -08:00
Tim Abbott 09b04f2aec docs: Edit user documentation style guide a bit. 2017-01-16 22:15:01 -08:00
synicalsyntax eaa4f4cfa5 docs: Rewrite user documentation styling guide. 2017-01-16 22:15:01 -08:00
Tim Abbott aad3ca0224 Extract docs/user-docs.md from docs/README.md. 2017-01-16 21:58:25 -08:00
Jackson 013fab70ad Fix grammatical and spelling errors in Zulip/docs. 2017-01-16 20:16:12 -08:00
synicalsyntax 6045730902 docs: Document *Save changes* macro in user documentation styling guide. 2017-01-16 19:59:37 -08:00
Tim Abbott 9be76e91dd Fix capitalization in 'Add a new bot'. 2017-01-16 18:00:10 -08:00
Tim Abbott 6bc1653333 Fix capitalization in 'Create bot'. 2017-01-16 18:00:10 -08:00
Tim Abbott 15b718e2d1 Fix capitalization in 'Your bots'. 2017-01-16 18:00:10 -08:00
Tim Abbott 8dc96166fd Fix capitalization in 'Your account'. 2017-01-16 18:00:10 -08:00
Tim Abbott 3667ca8114 Fix capitalization in 'Default language'. 2017-01-16 18:00:10 -08:00
Tim Abbott e1e7788e67 Fix capitalization in 'Deactivated users'. 2017-01-16 18:00:10 -08:00
Tim Abbott 2bbad279ae Fix capitalization in 'Display settings'. 2017-01-16 18:00:10 -08:00
Tim Abbott 0667ae5d26 Fix capitalization in 'Change password'. 2017-01-16 18:00:10 -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 d5f718a3e7 Rename 'Manage Streams' to 'Manage 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
Steve Howell 7b5bc40b42 Remove broken K+R link from reading list. 2017-01-16 09:00:20 -08:00
synicalsyntax b228221fdf docs: Document *Follow steps* macro in user documentation styling guide. 2017-01-15 11:17:16 -08:00
Yago González 814c24cfd6 docs: Reorganize steps in Documenting your integration. 2017-01-13 13:50:58 -08:00
Yago González 5fea825260 docs: Add the Reading list. 2017-01-12 16:42:52 -08:00
JefftheBest1 a549ed6e65 Removed accommodate typos 2017-01-12 04:53:31 -08:00
JefftheBest1 f0afa3e8df Fixed typos with receive 2017-01-12 04:52:44 -08:00
JefftheBest1 9de75f5167 Fixed typos with separate 2017-01-12 04:52:05 -08:00
Tim Abbott 145c5da8bf docs: Fix heading for roadmap doc. 2017-01-10 23:01:32 -08:00
Tim Abbott 007d4becfd Revert "update-sockjs: Update sockjs from version 0.3.4 to 1.1.1." 
This reverts commit 7bf10ec74f.

Apparently, SockJS 1.1.1 is broken with the browser used in our legacy
desktop app, resulting in messages being silently not sent.
 2017-01-10 11:46:15 -08:00
Tim Abbott 4a57367a51 requirements: Document more clearly ports required for Zulip. 2017-01-10 11:46:15 -08:00
Bojidar Marinov 786dd0fca4 auth: Make min password length and strength configurable. 
This adds some configuration options to settings.py, namely
PASSWORD_MIN_LENGTH and PASSWORD_MIN_QUALITY, which control
when the frontend validator invalidates the password.

Closes #2628
 2017-01-10 04:55:41 -08:00
Tommy Ip b70f6a6b7a Add basic system architecture visualization. 
This diagram shows the core components of Zulip.
 2017-01-09 21:29:15 +00:00
Robert Hönig a261801cef Update bots guide statement about the interception of PMs 2017-01-07 15:02:29 -08:00
Tim Abbott 6a7befa812 third: Remove copyright notice for removed review tool. 2017-01-07 10:53:20 -08:00
Tim Abbott 24df5fbd97 Delete remains of deprecated inject-messages. 2017-01-07 10:53:20 -08:00
Tim Abbott 0f50ef12f5 scripts: Fix path to install-node. 2017-01-06 16:48:18 -08:00
Tim Abbott e4b065e03a Move tools/setup/install-node to scripts/setup/. 2017-01-06 16:18:29 -08:00
Tim Abbott c65820618f settings: Set an intelligent default for ALLOWED_HOSTS. 2017-01-06 14:46:47 -08:00
Brock Whittaker 7b00bd6f7e Remove the old spinner, replace with new one. 
This removes the old content loading spinner and replaces it with a new
SVG.
 2017-01-06 10:37:54 -08:00
Tim Abbott b513e63f5e docs: Cleanup whitespace in user docs style guide. 2017-01-06 09:01:27 -08:00
synicalsyntax c9eaf67c78 docs: Update documentation styling guide with new guidelines. 2017-01-05 20:23:26 -08:00
JefftheBest1 e724af3183 docs: Fix incorrect use of warning markdown. 2017-01-05 15:15:19 -08:00
Tim Abbott 8b839c96d4 lint: Check for long lines in all markdown files in general. 
This has a few excludes for cases involving code blocks where it would
have been difficult to clean up.
 2017-01-05 15:06:34 -08:00
Tim Abbott efb8f8c26d docs: Wrap a bunch of long lines. 2017-01-05 14:31:34 -08:00
Tim Abbott c57ef13a62 docs: Wrap long lines in Russian style guide. 2017-01-05 14:31:34 -08:00
Tim Abbott 5dfc13d346 docs: Wrap long lines in translation guides. 2017-01-05 14:08:42 -08:00
Robert Hönig 4d59e2ff74 Fix typo in Spanish and Polish translation guides. 2017-01-05 13:58:46 -08:00
Yago González a2ebb066b4 docs: Fix formatting typo. 2017-01-04 10:12:07 -08:00
Cynthia Lin bf063cebbc docs: Update documentation styling guide with new macro information. 2017-01-04 08:50:38 -08:00
Alex Morozov 338c05a15b docs: Create a Russian translation style guide. 2017-01-03 19:33:43 -08:00
Tim Abbott 0018cd588e docs: Clean up testing with casper selectors discussion. 2017-01-03 16:56:50 -08:00
Yago González 872f288e76 docs: Add explanation for \$\$ selector. 2017-01-03 16:55:10 -08:00
Tim Abbott c199c73b93 docs: Fix formatting error in README.md. 2017-01-02 22:52:31 -08:00
Cynthia Lin edb98b8428 docs: Update style guide for user documentation. 
docs: Update style guide for user documentation.
 2017-01-02 17:46:11 -08:00
Alya Abbott dab7ceb620 Add style guide for user documentation. 2017-01-02 16:34:15 -08:00
Rohan Tibrewal 8e1724e81e Vagrant: Make host_ip a variable set in ~/.zulip-vagrant-config. 2016-12-30 14:50:08 -08:00
Tim Abbott 39f0ffdedd Move static/third/gemoji to static/generated/emoji. 
Fixes #1153.
 2016-12-27 20:16:23 -08:00
Tim Abbott ea8e34008d lint: Fix pep-8 rules on recently added files. 2016-12-27 20:16:23 -08:00
Tim Abbott 08dae5108e emoji: Move tools/setup/emoji_dump to tools/setup/emoji. 2016-12-27 19:58:41 -08:00
Rishi Gupta 4cf894fcb9 mypy: Update docs to recommend typing.Text instead of six.text_type. 2016-12-26 16:11:37 -08:00
Rishi Gupta 6d780d8dc2 mypy: Convert api/ and docs/ to use typing.Text. 2016-12-26 16:11:37 -08:00
Robert Hönig 79bbba04cf Update the bots development guide for change in triage_message 2016-12-26 16:10:54 -08:00
Robert Hönig 1c163c704d Fix wrong command in the bots guide 2016-12-25 10:38:15 -08:00
Tim Abbott 753a25268c help: Enable and use the markdown admonition extension. 
This allows us to add warnings and tips in the Zulip help documents.
 2016-12-21 11:01:49 -08:00
Robert Hönig 5ea1b835c9 Rename and reorder the bots guide 2016-12-20 11:40:04 -08:00
lonerz 25368c6863 bots-guide: Fix numbering indentation 2016-12-20 10:32:30 -08:00
Steve Howell 7317dd1825 Fix broken links in bots-guide.md. 2016-12-19 19:30:25 -08:00
Robert Hönig 63e1ca05ea Add developer documentation for bots 2016-12-19 16:29:42 -08:00
Umair Khan 4155795a16 docs: Fix i18n documentation for translating blocks. 2016-12-15 13:44:13 -08:00
hackerkid 7f8aef1a17 Add additional resources to code review. 2016-12-13 23:12:10 -08:00
hackerkid 3236b8ee2b Add translation in the code review check list. 2016-12-13 23:12:10 -08:00
Umair Khan 336a041ac0 Django 1.10: Use uWSGI. 
Fixes: #1121

With some tweaks by tabbott to make the number of processes configurable.
 2016-12-13 21:40:43 -08:00
Rafid Aslam e0d2839dd7 docs: Fix broken link in git-guide.md 
Update 'how to resolve a merge conflict' link because it is
broken, GitHub has change the link to the newer one.
 2016-12-10 06:09:46 -08:00
Rafid Aslam 0fbbadd303 docs: Extract testing docs to their own TOC section 
Fixes: #2422.
 2016-12-07 07:49:20 -08:00
Rafid Aslam ce94fb2eb1 deps: Change zxcvbn download method from download-zxcvbn to npm. 
- Replace download-zxcvbn with downloading it from npm.
- Change zxcvbn.js path to node_modules (because npm put it to
`node_modules` directory.
- Bump `PROVISION_VERSION` in `version.py` to 2.4.

Fixes #2423.
 2016-12-06 17:54:56 -08:00
actuallyatoaster d11cdac876 docs: Add documentation for linking to a stream. 
Fixes #2560.
 2016-12-06 17:47:26 -08:00
Tim Abbott b8ec9a5a42 docs: Improve installation instruction headings. 
The previous RTD headings were unclear and resulted in some users
attempting to install the Zulip production environment for doing
development.  This clarifies the situation.
 2016-12-06 17:36:42 -08:00
K.Kanakhin 7bf10ec74f update-sockjs: Update sockjs from version 0.3.4 to 1.1.1. 
- Add browserify to npm dependencies.
- Add SockJS-client to npm dependencies.
- Add npm postinstall script to generate browser version of SockJS-client
  from npm package.
- Change deprecated SockJS object property 'protocol_whitelist' to
  'transports'.
- Fix settings.
 2016-12-05 21:36:10 -08:00
Jianchun1 88e2ff3e1c docs: Add chinese translation style guide. 2016-12-04 14:36:04 -08:00
kevv87 1fb9220354 lint: Remove old jslint linter. 
Now that we're using eslint, jslint is no longer required.
 2016-12-02 18:49:42 -08:00
Michael Nguyen 991c84fa1e dev-setup-non-vagrant.md: Add missing install step. 2016-12-01 23:05:18 -08:00
Tommy Ip 46b7d54b3e pep8: Fix E701 violations. 2016-11-30 20:45:09 +00:00
trueskawka 558d359909 translation: Create Polish translation style guide. 
Add general notes on Polish translation.
Translate special terms used in Zulip.
 2016-11-29 19:36:57 -08:00
Tim Abbott ce2cc6d869 docs: Link Spanish style guide from translating page. 2016-11-29 19:35:23 -08:00
Carlos Rey 98e731e4c0 docs: Create a translation guide for Spanish. 2016-11-29 19:31:29 -08:00
Tim Abbott 24f0029111 integration-guide: Fix 'webhook' typo. 
Fixes #2467.
 2016-11-29 19:08:21 -08:00
Tim Abbott b1fce36214 docs: Fix a link to the windows-10 instructions. 2016-11-29 15:26:23 -08:00
Tim Abbott b035a6c606 docs: Change dev -> development everywhere. 2016-11-29 14:23:54 -08:00
Tim Abbott 6512d588ae dev-remote: Clean up some text, mostly dev->development. 2016-11-29 14:16:51 -08:00
Christie Koehler 30c6d9692e docs: Update remote dev with better details about editing. 2016-11-29 14:13:21 -08:00
Christie Koehler e81474cd91 docs: Recommend using Git to sync changes from local to remote dev. 2016-11-29 14:13:21 -08:00
Christie Koehler 641599164d docs: Add instructions for enabling symlinks in Git BASH. 2016-11-29 14:13:21 -08:00
Christie Koehler 23cf8697d1 docs: Update Windows setup to use Git BASH instead of Cygwin. 2016-11-29 14:13:21 -08:00
Christie Koehler 03d5d5d23a docs: Minor clarifications to remote dev tips. 2016-11-29 14:13:21 -08:00
Christie Koehler dfc465c9a2 docs: Make 'next steps' correct heading level and update links. 2016-11-29 14:13:21 -08:00
Christie Koehler cbd3774745 docs: Update zulip path to ~/zulip/ 2016-11-29 14:13:21 -08:00
Christie Koehler 01d6d7791d docs: Update to address first-time provision issues. 2016-11-29 14:13:21 -08:00
Christie Koehler 6def9c44dc Minor clean up of developing remotely guide. 2016-11-29 14:13:21 -08:00
Christie Koehler 3913db9022 docs: Simplify hierarchy of dev setup docs. 
Based on feedback from first-time contributors, this commit simplifies
the number of paths available for finding the dev setup directions you
need. Setup instructions are now organized into Recommended (Vagrant)
and Advanced (non-Vagrant).

In order to get the ToC to display correctly, I've combined all the
advanced, non-Vagrant methods into one page. I've left the old pages
intact, with a note that the content has been moved and link to the new
page. This is in case folks have linked directly to those pages.

The advanced setup directions still need to be cleaned up, but this is a
start.
 2016-11-29 14:13:09 -08:00
Umair Khan cd19a3d870 docs: Fix manual installation instructions. 
The previous version didn't correctly handle permissions around the
virtualenvs.
 2016-11-29 08:56:20 -08:00
Christie Koehler f036a59b4f Move details about configuring a proxy. 2016-11-27 17:06:41 -08:00
Christie Koehler 8b67210ce5 Simplify dev env setup overview. 2016-11-27 16:58:19 -08:00
Stanley Zheng b162969841 docker: Revert Docker development to original instructions. 
There were issues with reproducing the Docker build with the latest
docker file and instructions.
 2016-11-27 10:15:37 -08:00
Tim Abbott 3d1bcb05e1 tornado: Move event_queue.py to zerver/tornado/. 
Fixes #729.
 2016-11-26 22:29:28 -08:00
Tim Abbott 1fcf2ff525 tornado: Move zerver.tornadoviews to zerver.tornado.views. 
This furthers the overall goal of moving all the Tornado-specific code
to zerver/tornado/.
 2016-11-26 22:29:28 -08:00
Tim Abbott a28b20b845 docs: Improve documentation around re-provisioning. 
Fixes #1967.
 2016-11-26 19:21:18 -08:00
Tim Abbott 4f98b73d5e requirements: Document anti-recommendation of t2 style instances. 
If your instance runs out of CPU credits, it will result in a nasty
outage.

Fixes #1605.
 2016-11-26 19:06:45 -08:00
Michael Cordover 4047c7d3c4 docs: Add code of conduct. 2016-11-26 18:40:16 -08:00
Zev Benjamin f66e12ac4d docs: Minor developer documentation improvements. 
Fixes #2424.
 2016-11-26 14:47:16 -08:00
Anders Kaseorg 207cf6302b Always start python via shebang lines. 
This is preparation for supporting using Python 3 in production.

Signed-off-by: Anders Kaseorg <andersk@mit.edu>
 2016-11-26 14:46:37 -08:00
Steve Howell c0f2cebe0c docs: Add initial guide to manual testing. 
With a few small tweaks by tabbott.
 2016-11-26 13:05:25 -08:00
Stanley Zheng 26be74c72c docs: Add additional docker commands and documentation cleanup. 
With some tweaks by tabbott to fix ordering issues.
 2016-11-26 11:17:00 -08:00
Tim Abbott 5896e610cb docs: Fix apt-add-repository arguments in manual instructions. 2016-11-21 12:25:40 -08:00
Tim Abbott 5283c0eef5 docs: Fix generate_secrets.py arguments for manual install. 2016-11-21 12:23:47 -08:00
tonynater 70abbf76fc dev-remote: Edit Setting Up Development Environment docs. 
Added sentences which explain each installation option.
 2016-11-21 04:44:36 -08:00
tonynater a5e0d9cd5c docs: Reorder sections and add details to remote-dev docs. 
This reorders the sections such that setting up the development
environment and making sure it runs comes before editing the
code. Also added some clarifying sentences to give context to bullets.
 2016-11-21 04:44:02 -08:00
Alex Dehnert 65ad144c6c dev-remote: Fix typos (you->your). 2016-11-20 13:28:12 -08:00
Pweaver (Paul Weaver) b986cf9c41 docs: add a tutorial for setting up a remote dev environemnt 2016-11-20 12:38:14 -08:00
Christie Koehler b088c08777 Add detail about how to report issues and ask for help. 2016-11-20 11:38:16 -08:00
Christie Koehler a0635d65c1 Add note about Vagrant 1.8.7 curl issue. 2016-11-20 11:12:17 -08:00
Alex Dehnert c07298b8a3 docs: Don't include zulip.readthedocs.io in internal links 
Two reasons not to use such links:
- when making doc changes, if you follow links in your local build, they can
  cause you to silently end up no longer reading your local changes
- they can cause you to randomly switch between http:// and https://
 2016-11-19 10:16:38 -08:00
Alex Dehnert 4d474b649f docs: Fix broken markdown syntax. 2016-11-19 10:16:32 -08:00
Tim Abbott 2d81813145 roadmap: Add buddy list scalability to agenda. 2016-11-18 15:58:08 -08:00
Tim Abbott e302e2148b docs: Update incorrect links to issues in roadmap docs. 2016-11-18 15:55:02 -08:00
Tim Abbott bbdd0ec08d roadmap: The realm filters feature is merged. 2016-11-17 17:15:17 -08:00
Vladislav Manchev d7e1e4a2c0 Add initial implementation of custom realm filters. 
This PR was abandoned by Vladislav and then substantially modified by
Igor Tokarev and Tim Abbott to complete it and fix a number of bugs.

Fixes #544.
 2016-11-17 17:11:25 -08:00
Tim Abbott 6d4075cef9 docs: Extend our documentation of our documentation. 
The main purpose of this effort is to document our new /help/ docs,
but we update a bunch of other stuff while we're at it.
 2016-11-15 22:01:44 -08:00
Feorlen d56272a162 docs: Explain how the HTML webhook documentation is used. 
Part of #1998.
 2016-11-15 21:00:16 -08:00
Feorlen e45c10884e docs: Fix typo and whitespace. 2016-11-15 21:00:16 -08:00
Feorlen d8afc306ee docs: Clarify that HelloWorldHookTests is subclassing WebhookTestCase. 
Part of #1998.
 2016-11-15 21:00:15 -08:00
Feorlen ed61d3086d docs: Describe what an API key is and how to get one. 
Part of #1998.
 2016-11-15 20:59:43 -08:00
Feorlen 113b2b39fb docs: Describe what a test fixture is. 
Part of #1998.
 2016-11-15 20:59:39 -08:00
Feorlen 4725a7b7de docs: Describe what a webhook is. 
Part of #1998.
 2016-11-15 20:58:39 -08:00
Tim Abbott 86fbc415b9 docs: Fix typo in roadmap reactions item. 2016-11-15 12:27:27 -08:00
Tim Abbott 0145987fbe Update roadmap introduction section of roadmap. 2016-11-15 09:55:30 -08:00
Sumana Harihareswara e1f7b94bf5 Roadmap doc: Update intro date. 2016-11-15 09:55:30 -08:00
Sumana Harihareswara bef4fc94d3 Roadmap doc: Update desktop app section. 2016-11-15 09:55:30 -08:00
Sumana Harihareswara 3ca3668885 Roadmap doc: Update security, testing, & docs sections. 2016-11-15 09:55:30 -08:00
Sumana Harihareswara b06db1e776 Roadmap doc: Remove tasks we've already done. 2016-11-15 09:55:30 -08:00
Sumana Harihareswara 1c68436465 Roadmap doc: Update technology improvement section. 2016-11-15 09:55:30 -08:00
Sumana Harihareswara e0a1e401f6 Roadmap doc: Update realtime sync, performance, and scalability tasks. 
Also move and update community, internationalization, and
development environment tasks.
 2016-11-15 09:55:30 -08:00
Sumana Harihareswara b54aa2e415 Roadmap doc: Update onboarding and administration tasks. 2016-11-15 09:55:30 -08:00
Sumana Harihareswara eba34309dc Roadmap doc: Update user experience and social tasks. 2016-11-15 09:55:30 -08:00
Sumana Harihareswara 98e5f502d3 Roadmap doc: Update mobile tasks. 2016-11-15 09:55:30 -08:00
Sumana Harihareswara 9799da1fc2 Roadmap doc: Update internationalization section. 2016-11-15 09:55:30 -08:00
Sumana Harihareswara 0c9ed70a8d Roadmap doc: Update integrations section. 2016-11-15 09:55:30 -08:00
Sumana Harihareswara 43f77a37a4 Roadmap doc: Update number of PRs merged. 2016-11-15 09:55:30 -08:00
Tim Abbott 151267edf6 Roadmap: Make several more things as finished. 2016-11-11 16:24:20 -08:00
sinwar 4582a98c09 tests: Split out ZulipTestCase and WebhookTestCase to a separate file. 
Fixes #1671.
 2016-11-10 19:29:43 -08:00
Steve Howell 61625ce51e Add draft document for user populations. 
(This is mostly an internal dev document for now.  We should eventually
link it into our RTD system, perhaps after we think we are mostly
bug-free in terms of what the doc specifies.)
 2016-11-08 15:28:04 -08:00
Meena Rajan 30acb23314 bugdown: Add support for strikethrough in markdown processor. 
[Tweaked to move tests to bugdown_data.json, add additional tests, and
add frontend processor support by tabbott]
 2016-11-07 22:26:38 -08:00
Tim Abbott a8fdfccc83 docs: Fix echo.contains_bugdown docs being backwards. 2016-11-07 07:54:27 -08:00
Tim Abbott 7c8d502c70 docs: Add details on our markdown change requirements. 2016-11-06 11:57:10 -08:00
Tim Abbott 1641d1952f docs: Add a section on changing Zulip's markdown. 2016-11-06 11:49:37 -08:00
Tim Abbott 70c00038d9 docs: Clarify our markdown docs. 
This is just a cleanup and reorganization of some of the text; no
changes are made to the actual content.
 2016-11-06 11:37:22 -08:00
hackerkid bb4eb213c1 docs: Add testing notes to markdown doc. 2016-11-06 11:22:34 -08:00
Steve Howell 2088e8420f User user_id, not email, in peer_add events. 2016-11-04 11:37:14 -07:00
Steve Howell c5c3dfe33f Add subscriber counts to changelog.md. 2016-11-04 11:37:14 -07:00
Tim Abbott 945c2c4f86 docs: Add a brief release checklist. 2016-11-04 10:52:48 -07:00
sinwar 67d99c536a docs: change zulip.tabbott.net to chat.zulip.org 2016-11-03 16:07:59 -07:00
deekshaarul 3f5ef8df9e docs: Fix typos in git guide. 2016-11-03 10:12:03 -07:00
Tim Abbott d22a06ee90 docs: Fix a missing close paren. 2016-11-01 12:32:36 -07:00
Tim Abbott 1bae9d10e3 docs: Improve wording details in the new realm document. 2016-11-01 10:50:06 -07:00
hackerkid 1e409032bd docs: Add subsystem section discussing realms and subdomains. 2016-11-01 10:49:47 -07:00
Tim Abbott 14dc98d8b9 server_events: Switch to using REST-style URLs. 
This eliminates our use of /json/get_events; we'll remove that
endpoint in a future commit.
 2016-10-25 18:02:16 -07:00
K.Kanakhin 8dabc6d499 docs: Fix broken link in upgrading docs. 2016-10-25 11:35:14 -07:00
Tim Abbott c970a87dfa code-style: Fix broken links to anti for-in styleguides. 
These two pages were moved over the last few years.
 2016-10-24 11:10:25 -07:00
Rishi Gupta 28dd7080c7 docs: Add message editing policy to prod security section. 
Fixes #1214.
 2016-10-23 20:20:34 -07:00
Sumana Harihareswara f86cd0aa26 docs: Fix style in authentication methods doc. 2016-10-22 20:14:56 -07:00
Sumana Harihareswara 04c8c9d5bd docs: Updates to production customization guide. 2016-10-22 20:13:37 -07:00
Sumana Harihareswara dd3a19ab58 docs: Clarify export_single_user. 2016-10-22 20:13:06 -07:00
Sumana Harihareswara facf0ac1f3 docs: Add psql instructions. 2016-10-22 20:13:06 -07:00
Tim Abbott c20011ccd5 docs: Remove unnecessary and broken SSO breadcrumb link. 2016-10-22 19:30:24 -07:00
K.Kanakhin 9492bd37b4 docs-test: Fix documentation links. 
- Fix internal documentation links and anchors according last project documentation version.

Fixes #1492
 2016-10-22 19:30:24 -07:00
Tim Abbott a32eaf28c0 docs: Remove broken indices and tables index section. 
None of these links worked properly.
 2016-10-22 19:23:11 -07:00
Tim Abbott 4352790795 docs: Fix broken link in node testing docs. 2016-10-22 19:21:19 -07:00
Steve Howell c21fe60430 Add make_stream() to django testing docs. 2016-10-22 18:09:34 -07:00
Prabhakar Gupta bc6421fbfb tools: Remove empty wrapper script build_emoji. 
This renames the old `emoji_dump.py` to `build_emoji`, removing the
old shell essentially empty shell script.  `emoji_dump.py` was always
a weird name, and this makes it a bit easier to read the code for this
system.
 2016-10-20 22:57:45 -07:00
Sumana Harihareswara 2083ffa7a6 docs: Improve export documentation. 
Added user and realm export guidance in production maintenance docs,
linked to conversion guide, and revamped the introduction and styled
the text that Steve wrote.
 2016-10-20 22:52:32 -07:00
Sumana Harihareswara d9d389f64f docs: Add an initial code review document. 
A first pass at a code review guide. Mostly Tim's draft; I added
polish and links.

Fixes: #758.
 2016-10-20 22:41:38 -07:00
Steve Howell 76acab36b2 Remove do_add_subscription from Django testing docs. 2016-10-20 22:05:19 -07:00
Sumana Harihareswara c3d3288b63 docs: Style & link text in prod maintenance guide. 
Also fix line wrapping and some capitalization.
 2016-10-20 11:53:46 -07:00
Sumana Harihareswara a4516bda7d docs: Fix security bug email address. 2016-10-20 11:53:46 -07:00
Tim Abbott 8f6a58f741 docs: Expand translating documentation a bit. 2016-10-19 15:34:31 -07:00
Tim Abbott 92b8ce32fc docs: Clean up translation resources discussion. 2016-10-19 15:32:28 -07:00
Sumana Harihareswara 8d4b32a13a Fix style and linewrapping & add links in translation doc. 2016-10-19 15:30:35 -07:00
Sumana Harihareswara 8d1e87cfff Add translations stream link to translation doc. 2016-10-19 15:30:35 -07:00
Vikas Parashar e962704c71 Add installation troubleshooting instructions in case of pip failure. 
Add help for pip install failure during provisioning step of
initial vagrant up during developer environment installation.

Fixes: #1333.
 2016-10-19 12:34:08 -07:00
Steve Howell c4b2f6d816 docs: Say "Set up" instead of "Setup". 
I think "setup" generally implies a noun.
 2016-10-18 17:29:00 -07:00
Steve Howell 2676083b94 Add introduction to docs on node tests. 
Also, de-emphasize the process for creating new test modules,
as this is an advanced task that we can further document later
and generally handle as part of code review.
 2016-10-17 19:46:17 -07:00