Commit Graph

637 Commits

Author SHA1 Message Date
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