Commit Graph

877 Commits

Author SHA1 Message Date
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
Sumana Harihareswara
6323494f37 docs: Properly capitalize GitHub. 2016-10-17 19:31:50 -04:00
Christie Koehler
23df7913d5 docs: Add Git and GitHub Guide.
Fixes #783, #1754.
2016-10-17 16:18:16 -07:00
Tim Abbott
a28a5bb977 docs: Update roadmap HTML with now-completed issues. 2016-10-16 13:09:28 -07:00
Tim Abbott
e37b6488b8 Bugdown: Remove checked-in CodeHilite extension.
The changes that required us to fork this extension had been merged
into upstream CodeHilite, so we can remove it and switch to using the
version that comes with python-markdown.
2016-10-16 00:40:08 -07:00
Abhishek Kumar Singh
87c94a8697 docs/writing-views: Fix minor typo.
I found this typo while reading the blog written about
[mypy](http://blog.zulip.org/2016/10/13/static-types-in-python-oh-mypy/)
2016-10-15 12:26:40 -07:00
Tim Abbott
66df520cbe docs: Add a section on CalledProcessorError issues when provisioning.
Inspired by @deekshaarul's work on
https://github.com/zulip/zulip/pull/1939.
2016-10-14 21:29:27 -07:00
sonali0901
66a740b5c1 Architecture docs: Reposition backtick for address of Nagios plugin 2016-10-14 16:25:25 -07:00
Tim Abbott
e2810ca1be docs: Update path to update_realm code. 2016-10-11 21:28:14 -07:00
Tim Abbott
de5c1eb363 docs: Move glossary to bottom of architecture overview.
I think the old place where we had it broke up the flow.

Once this is about twice as long as it is currently, we should move it
to be its own document.
2016-10-11 16:44:39 -07:00
Sumana Harihareswara
7fee09458b Add starring to glossary. 2016-10-11 16:44:39 -07:00
Sumana Harihareswara
f1593b243c docs: Add chevron and message editing to glossary. 2016-10-11 16:44:39 -07:00
Sumana Harihareswara
d9c81dcfdd docs: Add recipient bar to usage assumptions/concepts.
Add start of glossary section.
2016-10-11 16:44:39 -07:00
Christie Koehler
952d91f60a docs: Fix broken image links on prod install page. 2016-10-11 15:19:43 -07:00
Supriya
598c7a506b docs/custom-apps: Fix spelling error. 2016-10-11 13:39:59 -07:00
Tim Abbott
fec6527656 dev-overview: Document cloud server option. 2016-10-10 17:10:39 -07:00
zeddmaxx
1348b9dde3 dev-overview: Improve organization of installation overview page.
Fixes #1814.

[substantially tweaked by tabbott]
2016-10-10 17:06:59 -07:00
Bertrand Croq
c705819f2d custom-apps docs: Fix stumulus typo. 2016-10-10 08:38:51 -07:00
Steve Howell
0bdc9fef5c Upgrade caspersjs to version 1.1.3. (w/acrefoot)
(Most of this work was done by acrefoot in an earlier branch.
I took over the branch to fix casper tests that were broken during
the upgrade (which were fixed in a different commit).  I also
made most of the changes to run-casper.)

This also upgrades phantomjs to 2.1.7.

The huge structural change here is that we no longer vendor casperjs
or download phantomjs with our own script.  Instead, we just use
casperjs and phantomjs from npm, via package.json.

Another thing that we do now is run casperjs tests individually, so
that we don't get strange test flakes from test interactions.  (Tests
can still influence each other in terms of changing data, since we
don't yet have code to clear the test database in between tests.)

A lot of this diff is just removing files and obsolete configurations.

The main new piece is in package.json, which causes npm to install the
new version.

Also, run-casper now runs files individually, as mentioned above.

We had vendored casperjs in the past.  I didn't bring over any of our
changes.  Some of the changes were performance-related (primarily
5fd58cf249), so the upgraded version may
be slower in some instances.  (I didn't do much measurement of that,
since most of our slowness when running tests is about the setup
environment, not casper itself.)  Any bug fixes that we may have
implemented in the past were either magically fixed by changes to
casper itself or by improvements we have made in the tests themselves
over the years.

Tim tested the Casper suite on his machine and running the full Casper
test suite is faster than it was before this change (1m30 vs. 1m50),
so we're at least not regressing overall performance.
2016-10-08 12:08:43 -07:00
Tim Abbott
d0f295c77f docs: Clarify commit message portion of version control docs. 2016-10-05 19:28:21 -07:00
Tim Abbott
5357b286b2 docs: Fix typo in spelling of generate_secrets. 2016-10-05 17:47:14 -07:00
Rishi Gupta
777fcaa6a0 Add new organization type field to Realm objects.
Adds a new field org_type to Realm.  Defaults for restricted_to_domain
and invite_required are now controlled by org_type at time of realm
creation (see zerver.lib.actions.do_create_realm), rather than at the
database level.  Note that the backend defaults are all
org_type=corporate, since that matches the current assumptions in the
codebase, whereas the frontend default is org_type=community, since if
a user isn't sure they probably want community.

Since we will likely in the future enable/disable various
administrative features based on whether an organization is corporate
or community, we discuss those issues in the realm creation form.
Before we actually implement any such features, we'll want to make
sure users understand what type of organization they are a member of.

Choice of org_type (via radio button) has been added to the realm
creation flow and the realm creation management command, and the
open-realm option removed.

The database defaults have not been changed, which allows our testing code
to work unchanged.

[includes some HTML/CSS work by Brock Whittaker to make it look nice]
2016-10-05 17:01:46 -07:00
Tomasz Kolek
7df50cee34 docs: Fix paths in webhooks part of integration-guide.
We forgot to update the documentation when we rearranged the webhooks
tests to be split across several files.

[mostly rewritten by tabbott]
2016-10-04 20:09:58 -07:00
Tim Abbott
279f805448 run-dev: Automate passing --interface='' for vagrant environment.
Fixes #877.
2016-10-04 10:48:26 -07:00
sonali0901
4869e1b0b2 test-backend: Add convenience arguments to run subsets of the tests.
This optimizes the process of running individual or small groups of
backend tests (./tools/test-backend
zerver.tests.test_bugdown.FencedBlockPreprocessorTest.test_simple_quoting)
to allow the following syntaxes:

    ./tools/test-backend zerver/tests/test_bugdown.py
    ./tools/test-backend zerver.tests.test_bugdown.py
    ./tools/test-backend zerver/tests/test_bugdown
    ./tools/test-backend zerver.tests.test_bugdown
    ./tools/test-backend test_bugdown.py
    ./tools/test-backend test_bugdown
    ./tools/test-backend FencedBlockPreprocessorTest
    ./tools/test-backend FencedBlockPreprocessorTest.test_simple_quoting

Fixes #1670.
2016-09-28 11:52:05 -07:00
Tim Abbott
03bf8893e2 Remove legacy /api/v1/send_message endpoint.
This was the original way to send messages via the Zulip API in the
very early days of Zulip, but was replaced by the REST API back in
2013.

Fixes: #730.
2016-09-27 14:51:54 -07:00
Sahil Dua
058587da77 Remove extra new lines at the ends of Zulip authoried files.
Fixes #1627.

[tweaked by tabbott to avoid patching third-party modules, for now]
2016-09-26 21:05:24 -07:00
umkay
798e6faa9e provision: Use NVM to install node and npm.
NVM takes a specific node version and installs the node package and
a corresponding compatible npm package.

We use it in a somewhat hackish way to install node/npm globally with
a pinned version, since that's how we actually want to consume node in
our development environment.

Other details:
- Travis CI now is configured to use the version of node installed by
provision; the easiest way to do this was to sabotage the existing node
installation.
- jsdom is upgraded to a current version, which both requires recent
node and also is required for the tests to pass with recent node.
This fixes running the node tests on Xenial.

Fixes #1498.

[tweaked by tabbott]
2016-09-23 14:34:44 -07:00
Eklavya Sharma
2d3921e3e4 Add instructions for manually installing pgroonga. 2016-09-17 09:23:54 -07:00
sonali0901
15331ad9fa docs: Document invite-only streams are hidden from other users.
Fixes: #1756.
2016-09-14 10:06:10 -07:00
Tim Abbott
cd0025f67f docs: Update roadmap with recently completed projects. 2016-09-12 14:56:08 -07:00
Tim Abbott
b744a3a4d7 docs: Update changelog since 1.4.0 release. 2016-09-07 19:51:14 -07:00
Tim Abbott
c9f9fb265e Update provision.py and Vagrantfile to support VMWare.
This adds support for using VMWare Fusion as the Vagrant provider,
which has better performance than Virtualbox at the price of being
nonfree (in all senses of the term).

We haven't done solid benchmarking as to how much faster it is than
the Virtualbox provider.
2016-09-07 19:30:48 -07:00
neurodynamic
91a1e8aebc Add note about the email_password setting 2016-08-28 13:29:51 -07:00
Steve Howell
65b884f44d docs: Explain how to re-build the table of contents. 2016-08-27 11:30:57 -07:00
Steve Howell
c8e37f30d2 docs: Add "Custom Apps" to "Subsystem Documentation". 2016-08-27 11:30:57 -07:00
Steve Howell
f5a1923cbf docs: Create "Custom Apps" document. 2016-08-27 11:30:57 -07:00
Kouhei Sutou
683f49aa99 Support full text search for all languages using pgroonga.
This adds support for using PGroonga to back the Zulip full-text
search feature.  Because built-in PostgreSQL full text search doesn't
support languages that don't put space between terms such as Japanese,
Chinese and so on. PGroonga supports all languages including Japanese
and Chinese.

Developers will need to re-provision when rebasing past this patch for
the tests to pass, since provision is what installs the PGroonga
package and extension.

PGroonga is enabled by default in development but not in production;
the hope is that after the PGroonga support is tested further, we can
enable it by default.

Fixes #615.

[docs and tests tweaked by tabbott]
2016-08-26 21:04:03 -07:00
Tim Abbott
1d0ae8b11c docs: Clarify that one should unpack in /root to install. 2016-08-26 11:56:12 -07:00
Tim Abbott
b200c6cdc0 Move assets/ to live under static/.
This decreases the clutter in the root directory of the Zulip
repository.
2016-08-26 10:23:38 -07:00
Tim Abbott
9001bebf2f Move THIRDPARTY to docs/ subdirectory. 2016-08-25 20:02:42 -07:00
Rag Sagar
ce1777b0cb Update update_realm view path and signature in the new feature tutorial. 2016-08-25 19:35:42 -07:00
Tim Abbott
7e4caf3a67 Release Zulip 1.4. 2016-08-25 10:49:00 -07:00
Tim Abbott
fba93cb494 scripts: rename deploy-zulip-from-git to reference upgrading. 2016-08-25 10:48:59 -07:00
Tim Abbott
7f445be23d docs: Clean up headings for maintenance page. 2016-08-25 10:48:48 -07:00
Tim Abbott
54c5c989c9 docs: Fix some broken links in headings. 2016-08-25 10:41:00 -07:00
Tim Abbott
c0799a9d09 docs: Fix docs for upgrading from a git repository. 2016-08-25 10:40:51 -07:00
Tim Abbott
9839d93362 docs: Clean up duplicated content in development overview. 2016-08-25 10:40:51 -07:00
Tim Abbott
f6c4e46afe docs: Move README.dev.md into ReadTheDocs.
Fixes: #669.
2016-08-25 10:40:51 -07:00
Tim Abbott
d876909b69 docs: Clean up development environment headings. 2016-08-25 10:40:51 -07:00
Tim Abbott
30b5c2a4c0 docs: Document the fact that 14.04->16.04 is not supported. 2016-08-25 10:40:51 -07:00
Tim Abbott
f1a91c8028 docs: Document Zulip PPA is available for 16.04 as well. 2016-08-25 10:40:51 -07:00
Tim Abbott
c5417e723b docs: Fix command sequence for retrying Zulip installation. 2016-08-25 10:40:51 -07:00
Tim Abbott
c0975b03a5 docs: Document Ubuntu 16.04 support in production. 2016-08-25 10:40:51 -07:00
Tim Abbott
c0e68d59cb docs: Rename status/debug page to troubleshooting. 2016-08-25 09:37:33 -07:00
Tim Abbott
be4e806d60 docs: Collapse install steps 2 and 3 together. 2016-08-25 09:37:33 -07:00
Tim Abbott
cd632faff6 docs: Clean up scrollbar in install docs. 2016-08-25 09:37:33 -07:00
Tim Abbott
8a82c29d21 docs: Move SSL docs to a dedicated page. 2016-08-25 09:37:33 -07:00
Tim Abbott
8086cc549f docs: Merge prod-auth-first-login into main installation page. 2016-08-25 09:37:33 -07:00
Tim Abbott
1d273b93da docs: Move screenshots to their own page. 2016-08-25 09:37:33 -07:00
Tim Abbott
da0d9e716d docs: Move management docs to a better place and expand.
Now that a management command is not required to install Zulip, we can
bury the documentation on them a bit more.

Fixes: #551.
2016-08-25 09:37:33 -07:00
Christie Koehler
5a3db059d4 docs: Rewrite first time prod login docs to use new realm creation flow.
- Adds heading and reorganizes sections for improved clarity. Sections
  now ordered: Create user, grant admin access, default realm settings,
  changing realm settings, other manage.py commands, if you can't login.
- Adds screen shots of Zulip web interface.
2016-08-25 09:37:33 -07:00
Vishnu Ks
a7ead9e99d settings: Eliminate ADMIN_DOMAIN for creating initial realm.
We now use `./manage.py generate_realm_creation_link` as the flow flow
for creating one's first realm.
2016-08-25 09:37:33 -07:00
Tim Abbott
f7ede485d2 docs: Move subscribe step to start of install docs. 2016-08-24 21:04:10 -07:00
Christie Koehler
7d6541867b docs: Update Let's Encrypt CertBot install instructions. 2016-08-24 19:02:22 -07:00
Tim Abbott
d09b07310d docs: Clean up and clarify documentation flow. 2016-08-24 19:02:18 -07:00
Christie Koehler
456da49b06 docs: Expand production install docs.
- Moves Let's Encrypt option for ssl certs above self-signed option.
  Updates Let's Excrypt instructions to user Certbot (new recommended
  method). Fixes #1426.
- Adds and updates headings for clarity.
- Adds new step 6 about configuring authentication (from
  prod-auth-first-login.html).
- Adds emphasis on using `su zulip`, `sudo -u zulip -i`, and `sudo -i`
  where appropriate. Fixes #1356.

Fixes #1245.
2016-08-24 19:02:11 -07:00
Tim Abbott
cd0ef4ae5b prod-requirements: Remove unnecssary authentication section. 2016-08-24 16:34:00 -07:00
Tim Abbott
2c171df9b5 docs: Reorganize requirements page with server/credentials categories. 2016-08-24 16:32:06 -07:00
Christie Koehler
b90f5537b0 docs: Improve production requirements doc.
- Adds headings and organizes for greater clarity.
- Adds some detail about each of the requirements.
2016-08-24 15:14:18 -07:00
Christie Koehler
f1daf3d66a docs: Make headings consistent and use the imperative. 2016-08-24 15:02:14 -07:00
Christie Koehler
48ba0e3974 docs: Improve 'upgrading' section of prod-maintain-secure-upgrade page.
- Reformats bullets as regular paragraphs for improved readability.
- Adds headings to subsections to make them easier to read and linkable.
- Clarifies minor points throughout.
2016-08-24 15:01:32 -07:00
Christie Koehler
36b6184be2 docs: Improve navigation of prod-customize page.
- Add headings for each of the six major sections: integrations, streams
  and topics, notification settings, mobile and desktop apps, other
  great features, and enjoy your Zulip installation.
- Add links to each of these sections to top of page, with first and
  most important four formatted as a list.
2016-08-24 14:56:39 -07:00
Christie Koehler
58ee43c3f0 docs: Improve prod-health-check-debug page.
- Adds headings for 'supervisorctl' and 'troubleshooting'.
- Rearranges to include most important info at top: that Supervisor is
  used, a reminder to review components architecture, log location, link
  to troubleshooting services section, and a request to report any
  issues not already documented on this page.
2016-08-24 14:52:44 -07:00
Christie Koehler
d4f0565c92 docs: Improve Zulip in Production page navigation and ToC.
Improves readability of ToC and makes pages more navigable by shortening
Zulip in Production page headings.
2016-08-24 14:48:11 -07:00
Christie Koehler
8782f6a198 docs: Improve navigation of prod-maintain-secure-upgrade page.
- Adds a heading for Upgrading and clarifies wording on Backups heading.
- Adds intro text with links to other sections.
2016-08-24 14:46:40 -07:00
Tim Abbott
7965320877 Update changelog for Zulip 1.4 release. 2016-08-24 14:26:53 -07:00
Steve Howell
ba9e7e290d frontend: Extract dispatch_normal_event().
Extract dispatch_normal_event() from the inner
function dispatch_event() in get_events_success()
in server_events.js.  Also, alphabetize the cases in
the switch statement.  This starts to address #1541,
but see the discussion on the ticket for how we can
continue to clean up our event dispatching.
2016-08-22 20:18:02 -07:00
Steve Howell
fd6ee7117f tests: Renamed AuthedTestCase to ZulipTestCase. 2016-08-22 19:07:44 -07:00
Steve Howell
29ba10dfdd docs: Add docs for Django backend tests. 2016-08-22 19:07:44 -07:00
Tim Abbott
95fbd5ba31 Update zulip.com/integrations link to point to zulipchat.com.
zulip.com will stop running at some point in the near future, and we
don't want these links to break.
2016-08-22 17:26:41 -07:00
Tim Abbott
602c7c69a9 lint: Document line length checking. 2016-08-19 12:08:22 -07:00
Steve Howell
f6b332ecdb docs: Add linters.md to document our linters.
(Also, link to it from the testing docs.)
2016-08-19 11:55:52 -07:00
Steve Howell
479aa5b83d docs: Split out Django/Casper/Node testing docs. 2016-08-18 14:10:46 -07:00
Tim Abbott
e1b5a0e000 docs: Add link to life of a request docs on URLs. 2016-08-18 12:41:38 -07:00
acrefoot
920e605e17 Add extensive views writing documentation.
[section on REQ substantially expanded by tabbott]

Fixes: #880.
2016-08-18 12:37:33 -07:00
Tim Abbott
74cdb4954c docs: Fix outdated security contact list. 2016-08-17 22:19:53 -07:00
Sumana Harihareswara
f3abea0f1f doc: Add version number to Trusty in prod requirements. 2016-08-16 16:24:34 -07:00
Sumana Harihareswara
23aaca376e doc: Recommend provision stream for install help.
Adds a recommendation to the developer installation
documentation suggesting visiting the "provision" stream.

Fixes: #1537.
2016-08-16 16:22:20 -07:00
Tim Abbott
b839db1f45 Expand pointer and unread counts guide. 2016-08-16 16:17:54 -07:00
Sumana Harihareswara
1a9f961bb4 doc: Add pointer and unread counts guide.
Tim's comments in #789 are useful to developers
in explaining message selection at browser load,
narrow, etc.
2016-08-16 16:15:38 -07:00
Taranjeet Singh
d606b95242 zulip_tools.py: Move zulip_tools.py in scripts/lib.
This commit moves zulip_tools.py as part of cleaning the root directory
and organizing proejct into better directory structure.
2016-08-15 16:44:50 -07:00
Steve Howell
603352630b export: Update conversion docs. 2016-08-13 09:36:08 -07:00
Steve Howell
fd77585a8c export: Add docs/conversion.md.
This is not hooked into anything yet.  After this weekend's
conversion, it will probably be worthwhile to take a second pass
at it!
2016-08-12 15:10:49 -07:00
Steve Howell
cdd03dec4d Extract media queries to media.css.
Create `media.css` using media queries that had been at the bottom
of `zulip.css`, then update miscellaneous setttings/docs files.

I also add `.screen-medium-show` and `.screen-narrow-show` to
`media.css`, as they seem to be an important part of our
responsive design.

Fixes #1532.
2016-08-05 10:32:55 -07:00
acrefoot
cf41629d80 docs: Fill gaps in New Feature Tuturial.
Adds some section headings, and provides a better example for the new
django migration system.
2016-08-04 16:02:08 -07:00
Christie Koehler
4c66bbc1ee integration guide: Move Hello World walkthrough to end. 2016-08-04 15:59:49 -07:00
Christie Koehler
6cf6341a49 integration guide: Improve readability and navigation. 2016-08-04 15:59:48 -07:00
Christie Koehler
4cd28e5e1f integration guide: Update Hello World walkthrough. 2016-08-04 15:59:28 -07:00
Tim Abbott
3fec3f122f docs: Add missing annotation to conf.py. 2016-08-04 15:57:03 -07:00
Tim Abbott
4a7e6e852f integration guide: Update documentation instructions. 2016-08-04 12:04:12 -07:00
Tim Abbott
6ab09064ac integration guide: Increase visibility level of hello world guide. 2016-08-04 11:55:19 -07:00
Tim Abbott
613781f034 integration guide: Swap created files above updated files. 2016-08-04 11:53:05 -07:00
Tim Abbott
0691832817 docs: Document new WEBHOOK_INTEGRATIONS API. 2016-08-04 11:52:28 -07:00
Tim Abbott
5f37485e7f docs: Improve integration guide link to writing documentation. 2016-08-04 11:49:17 -07:00
Tomasz Kolek
0e33b8bd4d Add integrations library.
Define Integration and WebhookIntegration classes.
Change webhook part of integration's guide.
Replace hardcoded webhook urls to generating
based on WEBHOOKS list.
2016-08-04 11:39:20 -07:00
Steve Howell
f0c6af2285 Describe events/initial state in new-feature-tutorial.md. 2016-08-04 09:45:37 -07:00
Tim Abbott
03f6cb4b3e testing: Remove now-unnecessary istanbul install docs. 2016-08-04 09:43:05 -07:00
Sumana Harihareswara
2d43431ad9 Advertise Electron app in documentation. 2016-08-02 16:41:24 -07:00
Sumana Harihareswara
d97702ead6 De-duplicate testing docs.
Addresses comment in #1218.
2016-08-02 19:26:59 -04:00
Christie Koehler
c95e6d4629 Recommend vagrant provision instead of vagrant reload.
Fixes #1520.
2016-08-02 15:10:59 -07:00
Tim Abbott
b82230559c docs: Document new deploy-zulip-from-git deployment process. 2016-08-02 14:31:07 -07:00
Tim Abbott
720e905150 docs: Fix heading levels in maintaining guide. 2016-08-02 14:31:07 -07:00
Tim Abbott
35cd0e122e docs/maintaining: Switch markdown header format. 2016-08-02 14:31:07 -07:00
Tim Abbott
98ae0516d2 docs: Fix Fedora secondary links in generic installation. 2016-07-30 21:20:54 -07:00
Tim Abbott
b63d83538e docs: Update manual install documentation for tsearch-extras.
* Suggest the PPA when possible.
* Use the `postgresql` meta package to avoid manually specifying version.
* Link to the upstream source code.
2016-07-30 21:16:56 -07:00
Steve Howell
85859fb992 Add notes about JS unit test HTML output in testing.md. 2016-07-29 22:07:24 -07:00
Christie Koehler
31efecf03d Add HelloWorld webhook integration + Walkthough.
Improves webhook integration docs and Hello World webhook.  Includes
many suggested improvements from @timabbott and @tomaszkolek.
2016-07-29 21:38:40 -07:00
Tim Abbott
2053c746c1 docs: Document GitHubAuthBackend. 2016-07-29 15:05:24 -07:00
Tim Abbott
3b5629739d docs: Cleanup typos and language in translating guide. 2016-07-29 14:49:51 -07:00
Reid Barton
a45b28e0b8 Don't use sudo in commands to be run as root.
It's confusing as it implicitly sends the message that the commands are to be run as a non-root user.
2016-07-28 15:13:48 -07:00
Sumana Harihareswara
c0e1e23941 Update copyright year in documentation. 2016-07-28 13:57:05 -07:00
Umair Khan
f20f9ce8c8 Update casper testing documentation.
This adds a note that waitFor functions cannot be chained together if
the wait can cause race condition.
2016-07-28 13:55:27 -07:00
Rishi Gupta
e515484c41 Fix typos in the documentation.
Pushing this now so as to not create merge conflicts with others working on
the prod docs.
2016-07-27 13:44:27 -07:00
Tim Abbott
df32750f88 docs: Add a bit of discussion of settings philosophy. 2016-07-25 11:43:41 -07:00
Tim Abbott
488cc547d2 docs: Expand discussion of settings secrets. 2016-07-25 11:43:41 -07:00
Eklavya Sharma
ed03619f95 docs/mypy.md: Document zerver/lib/type_debug.py. 2016-07-23 14:38:24 -07:00
Tim Abbott
2bcce28b07 changelog: Clean up some minor text issues.
Thanks @rishig for the review!  I forgot to apply these before
merging.
2016-07-20 20:01:30 -07:00
Tim Abbott
568a2facce docs: Fix links to troubleshooting guide. 2016-07-20 18:40:10 -07:00
Christie Koehler
827c015458 Updates Zulip dev setup for first-time contributors
Updates Zulip dev setup for first-time contributors as follows:

- Recommends and links to Vagrant version 1.8.4 (from 1.8.1)
- Consolidates Ubuntu 14.04 and Ubuntu 16.04 instructions since they are
  now identical.
- Updates memory requirement to 2GB to address out of memory related
  errors (see issue #1333).

Fixes #1288.
2016-07-20 18:40:10 -07:00
Tim Abbott
9fb933d456 docs: Fix style issues in life-of-a-request. 2016-07-20 18:31:41 -07:00
Eklavya Sharma
6548f1dd1c Factor out venv-installing code into a module.
Factor out the code in tools/provision.py which installs a python2
and python3 venv into a module (tools/setup/setup_venvs.py) which
can also be used as a script.
2016-07-20 18:20:37 -07:00
acrefoot
38bf0bf39b Add Life of a Request doc (#1302)
This doc follows the different layers that Zulip uses
to handle a request, detailing parts of those layers that
would be most commonly interesting to developers.
2016-07-20 17:12:15 -07:00
Eklavya Sharma
f664d00fe8 Add python2 and python3 venv install instructions. 2016-07-20 14:18:51 -07:00
Tim Abbott
14143e2222 roadmap: Fix issue number for upgrading every dependency.
The previous issue number corresponded to just the work to move to a
virtualenv, not to actually upgrade the dependency versions.
2016-07-20 10:54:52 -07:00
Tim Abbott
f4ffae8685 docs: Update roadmap with completed projects, etc. 2016-07-20 10:28:35 -07:00
Tim Abbott
b96a10ec9a Add draft changelog since Zulip 1.3.13 release. 2016-07-20 10:12:57 -07:00
Tim Abbott
35339f5117 Rename local_settings_template to prod_settings_template. 2016-07-19 20:59:59 -07:00
Tim Abbott
19b860ceec Rename local_settings.py symlink to prod_settings.py. 2016-07-19 20:59:59 -07:00
Tim Abbott
6a90dc07dc docs: Fix headings for possible testing issues. 2016-07-19 15:00:14 -07:00
Sumana Harihareswara
d828ba5688 Move testing instructions to main test suite doc.
Also, improve links and headers in testing.md.
2016-07-19 14:57:07 -07:00
Sumana Harihareswara
db6c9702c2 Update links in README and integration guide. 2016-07-19 14:57:07 -07:00
Sumana Harihareswara
e98f24734c Update developer install docs links and image embed.
Sphinx/RTD creates different anchor tags for subheadings than
Markdown does, and treats image embedding differently.
This commit updates hyperlinks to affected anchors,
and fixes an image embed for move to RTD.
2016-07-19 14:57:07 -07:00
Sumana Harihareswara
5473b03e3b Split out generic UNIX developer install doc. 2016-07-19 14:57:07 -07:00
Sumana Harihareswara
9aba0f84a8 Split non-Vagrant Ubuntu install doc into topic page. 2016-07-19 14:57:07 -07:00
Sumana Harihareswara
cf7b1af508 Split developer environment usage instructions into new page. 2016-07-19 14:57:07 -07:00
Sumana Harihareswara
c40ffd9538 Split out docker setup doc. 2016-07-19 14:57:07 -07:00
Sumana Harihareswara
97ff43e972 Move and rearrange vagrant instructions. 2016-07-19 14:57:07 -07:00
Sumana Harihareswara
b95370f833 Move and rearrange developer setup instructions.
We aim to consolidate developer documentation on Read The Docs. As a
start, this commit turns the first part of README.dev.md into a topic
page within /docs/ , and links to it from the doc index.

See #669.
2016-07-19 14:57:07 -07:00
Umair Khan
4519efa266 Document frontend translation syntax.
Fixes: #1090
2016-07-18 13:59:07 -07:00
Steve Howell
3869e6d008 Fix docs path in docs/README.md. 2016-07-18 12:03:18 -07:00
Steve Howell
bf58c06f97 Link to migration-renumbering.html in schema-migrations.md 2016-07-18 12:02:50 -07:00
Steve Howell
4f4092ecce Add docs/migration-renumbering.md 2016-07-18 12:02:50 -07:00
Rishi Gupta
d34000b211 prod install docs: Make minor fixes and edits. 2016-07-15 11:19:58 -07:00
Tim Abbott
4c8a0340ef Update requirements docs with LetsEncrypt mention. 2016-07-12 22:15:01 -07:00
Tim Abbott
2338421c6d lint: Add documentation lint check for JavaScript spelling. 2016-07-12 19:22:21 -07:00
Sumana Harihareswara
8257701dc9 Fix formatting & capitalization in testing doc. 2016-07-12 19:14:31 -07:00
Sumana Harihareswara
850d8d1181 Fix formatting, capitalization, & grammar in mypy doc. 2016-07-12 19:14:31 -07:00
Tim Abbott
491e98e457 docs: Document the fact that installer is idempotent. 2016-07-12 18:26:44 -07:00
Tim Abbott
6301fd22dc docs: Turn SSO auth documentation into general auth page.
Also remove this page from the breadcrumb.
2016-07-12 16:19:13 -07:00
Sumana Harihareswara
260baff4db Move prod postgres details to separate page. 2016-07-12 15:46:10 -07:00
Sumana Harihareswara
3a13cf1865 Move prod remote user SSO auth guide to new page. 2016-07-12 15:46:10 -07:00
Sumana Harihareswara
bfa81a80ad Move prod maintenance guide to new page. 2016-07-12 15:46:10 -07:00
Sumana Harihareswara
76fea4f4d4 Move prod customization guide to new page. 2016-07-12 15:46:10 -07:00
Sumana Harihareswara
07afc9d34b Move production health check doc to separate page. 2016-07-12 15:46:10 -07:00
Sumana Harihareswara
ec005726c4 Move prod auth and first login doc to new page. 2016-07-12 15:46:10 -07:00
Sumana Harihareswara
7d092d2cc4 Move production install instructions to new page. 2016-07-12 15:46:09 -07:00
Tim Abbott
a10833f489 Simplify title for production requrements page. 2016-07-12 15:44:48 -07:00
Sumana Harihareswara
3f90f9e29e Move production installation requirements to separate page.
To begin the process of consolidating Zulip documentation on Read
the Docs, the requirements are now their own topic page, and
index.rst links to it.

Fixes: #669.
2016-07-12 15:43:06 -07:00
Sumana Harihareswara
2ece2192d9
Fix misspelling in HTML CSS documentation. 2016-07-12 14:15:23 -04:00
Eklavya Sharma
51239f225b Mention build name in docs.
Mention in docs that tools/run-mypy and tools/check-py3k are run
in the 'static-analysis' build.
2016-07-11 21:28:01 -07:00
Umair Khan
397da44744 Update documentaton to reflect Django-Pipeline==1.6.8. 2016-07-09 07:09:55 -07:00
Tomasz Kolek
c15695e514 Add support for running test-js-with-node on particular files.
Fixed: #1127.
2016-07-07 14:32:07 -07:00
Umair Khan
054d14bb96 Add documentation to announce default language setting. 2016-07-04 11:56:24 -07:00
Tim Abbott
fd7cb3fc2b docs: Fix hardcoding of links to zulip.readthedocs.io.
This makes things work better if you're testing the documentation
locally.
2016-06-27 20:54:21 -07:00
Tim Abbott
31f7fb2fa0 docs: Fix new feature tutorial link to testing docs. 2016-06-27 20:52:20 -07:00
Tim Abbott
beb8b50623 Move provision.py under tools/. 2016-06-27 19:04:32 -07:00