CodeCow/zulip
1
0
Fork 0
mirror of https://github.com/zulip/zulip.git synced 2026-07-15 21:03:26 +08:00
Code Issues Actions 3 Packages Projects Releases Wiki Activity
51,410 Commits 32 Branches 166 Tags 783 MiB
79b00d3c2a
Commit Graph

2783 Commits

Author SHA1 Message Date
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
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
Tim Abbott
879ca4b9ea docs: Add documentation on HTML and CSS. 2016-06-27 12:38:53 -07:00
Tim Abbott
292556c846 docs: Expand RTD testing section. 2016-06-27 12:38:53 -07:00
Tim Abbott
f8c710b70e Update documentation on development auto-reloading. 
Now that queue workers auto-reload, we need to document that fact.
And we make a few tweaks to the relevant discussion, while we're at
it.
 2016-06-26 20:20:13 -07:00
Tim Abbott
61d1de19cf docs: Don't require typing module to be installed. 2016-06-26 10:10:59 -07:00
Tim Abbott
dc014b0866 docs: Add link to documentation building docs. 2016-06-26 10:04:07 -07:00
Tim Abbott
74c23d71e2 docs: Add details on viewing/editing these docs. 2016-06-26 10:04:06 -07:00
Tim Abbott
1838cd4d8f docs: Split out version control guidelines. 2016-06-26 10:04:06 -07:00
Tim Abbott
96fef7a0a1 docs: Reorganize RTD table of contents. 2016-06-26 10:04:05 -07:00
Tim Abbott
9aea3cdc9b docs: Add current Zulip release version to docs. 2016-06-26 10:03:56 -07:00
Tim Abbott
89b5eaaa7d docs: Improve several headings. 2016-06-26 09:54:19 -07:00
Tim Abbott
149fd88733 docs: Add missing link in schema-migrations.md. 2016-06-26 09:54:19 -07:00
Tim Abbott
ea611c0dcd docs: Add some full-text search documentation. 2016-06-26 09:32:54 -07:00
Vishnu Ks
420ee968f7 Renumber the casper tests to make space for realm-creation test. 
And also fix the mysterious gaps at 6 and 8.
 2016-06-24 17:47:56 -07:00
Tim Abbott
85798e2b2c Dramatically expand directory structure docs. 2016-06-23 14:01:54 -07:00
Tim Abbott
c8a1c3a86b docs: Reorder directory structure doc. 2016-06-23 13:58:41 -07:00
Tim Abbott
b0e1ae4245 docs: Make directory structure headings linkable. 2016-06-23 13:58:41 -07:00
Tim Abbott
5a1a540377 Expand directory structure details on scripts. 2016-06-23 13:58:41 -07:00
Tim Abbott
c668f1e299 roadmap: Add strikethrough for completed projects. 2016-06-21 17:30:33 -07:00
Tim Abbott
4958828747 Add changelog for Zulip 1.3.13 release. 2016-06-21 16:59:48 -07:00
Eklavya Sharma
be70907eaa Remove references to requirements.txt. 2016-06-21 07:48:24 -07:00
Tim Abbott
7370fd69d7 Move doc building dependencies to requirements/docs.txt. 2016-06-20 16:05:42 -07:00
Rishi Gupta
ce5e7d3ba6 Make minor edits to new settings documentation. 2016-06-17 12:15:15 -07:00
Tim Abbott
b5e92f541a Add new documentation on Zulip settings system. 
Fixes: #962.
 2016-06-17 12:15:15 -07:00
Eklavya Sharma
14c4ff2d25 docs/code-style.md: Use ASCII spaces consistently. 
At some places, '\xc2\xa0' was used instead of ' '.  This characters looks
identical, but can hamper searches and lint checks.
 2016-06-17 11:33:41 -07:00
Tim Abbott
07abfc189b Update docs/README.md to reflect the current state of the world. 
Fixes #1050.
 2016-06-17 11:30:22 -07:00
Eklavya Sharma
f18493f922 Add documentation about zerver/lib/str_utils.py. 2016-06-11 17:31:56 +05:30
Eklavya Sharma
85ef5900b4 docs/mypy.md: Add section on annotating strings. 2016-06-10 16:30:14 -07:00
Tim Abbott
c9ef726048 docs/mypy: Add note about Zulip's annotation goals. 2016-06-10 16:30:14 -07:00
Eklavya Sharma
a4c14cd448 Improve docs/mypy.md. 
Add link to mypy cheat sheet.
Warn against modifying annotations to somehow make them pass on buggy code.

[Description expanded by tabbott]
 2016-06-10 16:30:00 -07:00
Sumana Harihareswara
45b1893284 Convert architecture overview from rST to md for consistency. 
Fixes: #668.
 2016-06-04 22:27:00 -07:00
Sumana Harihareswara
6f59683324 Fix and clarify architecture overview. 2016-06-04 22:27:00 -07:00
Umair Khan
7057b2ae37 Add documentation for json_error and JsonableError. 
Add documentation on how to make the strings passing through
json_error and JsonableError translatable.
 2016-06-04 18:48:32 -07:00
Sumana Harihareswara
8c2382deeb De-duplicate three sections of architecture overview. 2016-06-03 12:56:31 -07:00
Sumana Harihareswara
4a10923bf1 Add architectural overview documentation. 
Fixes: #453.
 2016-06-03 11:54:02 -07:00
Taranjeet
a45bde7822 Docs: Fix typos in docs. 2016-06-02 10:31:41 -07:00
Tim Abbott
c5b495b775 Update changelog with important changes since last release. 2016-05-31 11:39:47 -07:00
Tim Abbott
d056b5601b docs: Add python-tyoing to RTD dependencies. 
This should fix the RTD build having been broken since
d9c4be87d1.
 2016-05-31 11:19:49 -07:00
Sumana Harihareswara
337155f280 Remove rST files to replace with Markdown. 
Currently (https://github.com/rtfd/recommonmark/issues/3)
the recommonmark bridge (which allows Sphinx to read
Markdown) does not support tables, so the directory structure
doc is now a bulleted list instead of a set of tables.
 2016-05-31 10:55:49 -07:00
Sumana Harihareswara
e0bc57ddb1 Rearrange docs table of contents for coherence. 
The order and structure of the Read The Docs documentation
was fairly arbitrary; here's a suggestion for how to change
its information architecture so it's more useful to a new
contributor. This adds a short Zulip overview, and a table
of contents and code contribution intro for new contributors.

Fixes: #668.

Signed-off-by: Sumana Harihareswara <sumanah@panix.com>
 2016-05-31 09:07:09 -07:00
Sumana Harihareswara
3029b3681f Rearrange sections of testing doc for coherence. 2016-05-31 09:05:38 -07:00
Sumana Harihareswara
f65778f1e2 Improve sub-headings in documentation. 
Signed-off-by: Sumana Harihareswara <sumanah@panix.com>
 2016-05-31 09:05:38 -07:00
Sumana Harihareswara
86f7695b8c Fix style, formatting in Bugdown docs. 2016-05-31 08:56:58 -07:00
Sumana Harihareswara
ad644afa97 Improve code style guidelines. 2016-05-31 08:56:58 -07:00
Sumana Harihareswara
3631cf3078 Add links in front end build process doc. 
Signed-off-by: Sumana Harihareswara <sumanah@panix.com>
 2016-05-31 08:56:58 -07:00
Tim Abbott
3ed78eb746 docs/testing: Clean up discussion of rebuilding database. 2016-05-31 07:48:00 -07:00
Christie Koehler
e06492ec3a Improve first-time contributor docs. 
Fixes #747. Fixes #748.

This updates README.dev.md to include clear, step-by-step instructions
for setting up the Zulip dev environment Windows 10, OS X El Capitan,
Ubuntu 14.04 Trusty, and Ubuntu 16.04 Xenial. It is aimed at first-time
contributors.

I tested these instructions multiple times on each of the target
systems.

Also added is a "trobleshooting and common errors" section which
documents the most common errors contributors are likely to encounter
during setup and how to fix them.

Improvements based on feedback from @timabbott.

- Fixes whitespace issues so linter will pass.
- Updates memory requirement.
- Re-orders so operating systems are listed alphabetically.
- Updates headings to be clearer.
- Updates and adds ToC entries for clarity.
- Adds screen shot of Zulip dev environment running in browser.
- Adds details about using dev environment, including about logging.
- Misc other minor changes for clarity.
- Adds a stub for docs/logging.md
- Adds details about configuring Cygwin for native symlinks.
 2016-05-31 07:47:45 -07:00
Tim Abbott
1b59b6826a docs/code-style.rst: Update and clarify shebang rules. 2016-05-29 05:07:50 -07:00
Eklavya Sharma
149938d468 Change shebangs from python2.7 to python. 2016-05-29 05:03:08 -07:00
Vishnu Ks
dc060248b4 Add instruction to check screenshot of failed tests. 2016-05-28 23:27:24 +05:30
Vishnu Ks
31968f668c Correct frontend_test script path. 2016-05-28 23:23:39 +05:30
Eklavya Sharma
d9c4be87d1 Make docs/conf.py pass mypy check. 2016-05-25 15:04:39 -07:00
Umair Khan
82b5d9304b [third] Integrate i18next with Handlebars 2016-05-19 22:58:25 -07:00
Umair Khan
f9bbc5d6ff Enable i18n support in URL configuration. 
This supports i18n using all of the following:
- I18N urls
- Session
- Cookie
- HTTP header
 2016-05-19 08:33:30 -07:00
Tim Abbott
b38913c8f9 Upgrade sphinx version used in ReadTheDocs. 
According to https://github.com/spatialaudio/nbsphinx/issues/26, this
should fix support for mixing rST and markdown in our docs.

Fixes #668.
 2016-05-14 14:27:21 -07:00
Tim Abbott
60722a8fce Integration guide: Add a note about spelling integraiton names. 2016-05-11 21:19:15 -07:00
Tomasz Kolek
eeeb4d0c92 Add CircleCI integration. 
Fixes: #617.
 2016-05-11 21:17:37 -07:00
Tim Abbott
92bec8cfea Merge Zulip 1.3.12 security release. 2016-05-10 11:32:26 -07:00
Umair Khan
0d324925b5 Add documentation on translation tags. 
[substantially modified by tabbott]
 2016-05-09 09:55:18 -07:00
Umair Khan
5359e6b0d4 Convert Zulip to use Jinja2 templates. 
This results in a substantial performance improvement for all of
Zulip's backend templates.

Changes in templates:
- Change `block.super` to `super()`.
- Remove `load` tag because Jinja2 doesn't support it.
- Use `minified_js()|safe` instead of `{% minified_js %}`.
- Use `compressed_css()|safe` instead of `{% compressed_css %}`.
- `forloop.first` -> `loop.first`.
- Use `{{ csrf_input }}` instead of `{% csrf_token %}`.
- Use `{# ... #}` instead of `{% comment %}`.
- Use `url()` instead of `{% url %}`.
- Use `_()` instead of `{% trans %}` because in Jinja `trans` is a block tag.
- Use `{% trans %}` instead of `{% blocktrans %}`.
- Use `{% raw %}` instead of `{% verbatim %}`.

Changes in tools:
- Check for `trans` block in `check-templates` instead of `blocktrans`

Changes in backend:
- Create custom `render_to_response` function which takes `request` objects
  instead of `RequestContext` object. There are two reasons to do this:
    1. `RequestContext` is not compatible with Jinja2
    2. `RequestContext` in `render_to_response` is deprecated.
- Add Jinja2 related support files in zproject/jinja2 directory. It
  includes a custom backend and a template renderer, compressors for js
  and css and Jinja2 environment handler.
- Enable `slugify` and `pluralize` filters in Jinja2 environment.

Fixes #620.
 2016-05-09 09:55:18 -07:00
Preston Hansen
635828069f Add feature to mark all in stream/topic as read with mouse. 
Fixes #736.
 2016-05-08 09:02:46 -07:00
Tim Abbott
34fb276b7b changelog: Add some items since the last release. 2016-05-07 20:34:14 -07:00
Tim Abbott
c5a44043a8 Cleanup changelog.md to be better documentation. 2016-05-07 20:34:06 -07:00
Tim Abbott
1c24cb32a5 Move changelog.md to docs/ and add to ReadTheDocs. 2016-05-07 20:26:44 -07:00
Tim Abbott
e5e133eccc Update docs to reflect the elimination of /bin. 2016-05-07 19:37:06 -07:00
Tim Abbott
d20791eb6a docs/new-feature-tutorial: Fix typos in templates path. 2016-05-07 17:37:01 -07:00
Tim Abbott
f06c8c7cc2 Update *.readthedocs.org => *.readthedocs.io. 
ReadTheDocs has moved their hosting of user project websites to the
new readthedocs.io domain.
 2016-04-29 16:00:08 -07:00
Tim Abbott
362a622f1f Add documentation on translating Zulip. 2016-04-28 21:57:10 -07:00
Tim Abbott
27b8e8b294 Add the Zulip 2016 roadmap document. 2016-04-28 21:55:33 -07:00
Eklavya Sharma
b60141fd84 Add documentation on the using the mypy static type checker. 
[with substantial tweaks by tabbott]
 2016-04-28 12:29:45 -07:00
Eklavya Sharma
22d407fe0b docs/testing.rst: Fix typo and name of a package. 
* Remove duplicate words.
* Replace `futurize` by `future`.
 2016-04-28 15:19:22 +05:30
Tim Abbott
abacd9b2da Integration guide: Document need to edit urls.py. 2016-04-26 11:50:19 -07:00
Tim Abbott
672a431fba Expand documentation on tools/check-py3. 2016-04-25 16:46:46 -07:00
Eklavya Sharma
ae46d425b6 Add info about tools/check-py3 in docs/testing.rst. 
Fixes #701.
 2016-04-26 03:32:29 +05:30
Eklavya Sharma
101148c49e Fix typo and formatting in docs. 2016-04-25 20:29:29 +05:30
Tim Abbott
74ed9fabd0 Integration guide: Expand instructions on screenshots. 2016-04-21 18:17:26 -07:00
Tomasz Kolek
82f1cdb085 Add send_webhook_fixture_message command. 
This tool simplifies the process of producing nice screenshots for
documenting webhook integrations.

Fixes #658.
 2016-04-20 10:45:27 -07:00
Tim Abbott
1b988de30a Integration guide: clean up description of plugin integrations. 2016-04-19 16:21:33 -07:00
Tim Abbott
92f9a789b8 integration guide: Improve introduction. 2016-04-19 16:21:33 -07:00
Sumana Harihareswara
4ce4f88a03 Fix formatting in directory-structure.rst. 2016-04-13 15:44:10 -07:00
Tim Abbott
be96cf809d Move Zulip backend tests to zerver.tests. 2016-04-11 22:16:09 -07:00
Tim Abbott
5c810ad0bc Add new markdown documentation to ReadTheDocs. 2016-04-01 14:57:30 -07:00
Tim Abbott
52764763c6 Add some docs on schema migrations. 2016-04-01 09:57:00 -07:00
Tim Abbott
37b79deb60 Expand documentation on frontend build process. 2016-04-01 09:56:59 -07:00
Tim Abbott
7a671c2652 Add documentation on the Zulip RabbitMQ queues. 2016-04-01 09:56:59 -07:00
Tim Abbott
96eb81e5d5 Add documentation of Zulip's markdown implementation. 2016-04-01 09:56:59 -07:00
Tim Abbott
342b4eb457 Add a detailed integration writing guide. 
Fixes: #70.
 2016-04-01 09:56:59 -07:00
Tim Abbott
b8c7cfb77e docs: Add Javascript manual testing section. 2016-04-01 09:34:45 -07:00
Ryan Moore
2fe0700f55 Update memcache -> remote cache in inline documentation. 2016-03-31 12:56:42 -07:00
Tim Abbott
02ccb68f7e code style: Document auto-closing GitHub issues. 2016-03-19 10:17:25 -07:00
Tim Abbott
ecc66d6eec code style: Improve the commit message style documentation. 2016-03-19 10:09:21 -07:00
Anindya Chakravarti
d72b8b83f7 Fixed a typo in documentation. 2016-03-17 22:53:42 -07:00
Tim Abbott
408ff14be8 Fix parsing html_unescape.py in py3k test. 
This file was using print as a function but didn't import
print_function; as a result futurize threw an error every time it
parsed this file.
 2016-01-09 15:43:30 -08:00
Allie Jones
11c69fb0b2 Add documentation on the front end build process and webpack. 2015-11-20 20:32:01 -08:00
Tim Abbott
d06cb5d55a Expand documentation on writing and debugging Casper tests. 2015-11-11 21:36:00 -08:00
Tim Abbott
10657c1d53 Move node tests to node_tests/. 2015-10-28 10:11:47 -07:00
Tim Abbott
f1074aa491 Move frontend tests out of zerver/tests/. 
This fixes an unfortunate bug where the backend tests in
zerver/tests.py were not being run automatically, and also makes these
a bit easier to find.
 2015-10-28 10:11:47 -07:00
Steven Oud
d5435fad1d Consistently use /usr/bin/env python2.7 in shebangs and commands. 2015-10-21 22:58:21 +00:00
Allie Jones
99a2ba38b1 Expand new feature tutorial. 2015-10-15 09:12:22 -04:00
Tim Abbott
5bf6f05f60 Add readthedocs requirements.txt. 2015-09-25 10:53:47 -07:00
Tim Abbott
b21a105a99 Reorganize and delete obsolete content from testing.rst. 
(imported from commit 1d62b50c0b01d5386c8a6ffbde745abb6d79ad6e)
 2015-09-25 03:40:31 -07:00
Tim Abbott
827e7ad19c docs: Cleanup new feature tutorial and note unfinished. 
(imported from commit 668eabb53f746afe7455b0f5fd1e8f5741894c5e)
 2015-09-22 22:38:55 -07:00
Tim Abbott
a3c122eb41 Remove largely obsolete documentation pages. 
(imported from commit eb02c24dd25a12a5676b5e52c914993650f73aa6)
 2015-09-22 22:37:45 -07:00
Tim Abbott
1be909a450 docs: Content editing for directory-structure.rst. 
(imported from commit aa331a561f1e905c9453bd0590eb1147c19f2be4)
 2015-09-22 22:17:56 -07:00
Tim Abbott
3c1c14a7cc docs: Fixed a bunch of factual issues in coding style guidelines. 
(imported from commit 6320d45ad064fcc5b3e8f01247b18af1a85bf91f)
 2015-09-22 22:13:28 -07:00
Tim Abbott
b6e2fd6e83 Rename build-voyager-tarball to build-release-tarball and document. 
(imported from commit 06f102f4f4c5caf187f4930fadff06147f095401)
 2015-09-22 21:22:11 -07:00
Yoyo Zhou
ab5e04ef36 Add backend tests location 
(imported from commit 2f2dcd1773be746bee5d9003ca99020230acae04)
 2015-08-22 13:08:11 -07:00
Yoyo Zhou
e130884c6a code-style: Simplify rST syntax. 
(imported from commit c2bd43f97969b7be61476435ac00ae03fd05ec4d)
 2015-08-22 13:08:07 -07:00
David Roe
c17e50e0c4 Add new feature tutorial. 
(imported from commit 1577c2567232aba1a1f1c6d1df83370acf54af55)
 2015-08-22 12:56:57 -07:00
David Roe
a9cf471239 Remove documentation on ALLOW_REGISTER since it is out of date. 
(imported from commit 75938998507f2b903f49bd9c7c4ecc0eadb3259d)
 2015-08-22 12:55:18 -07:00
David Roe
33b7b2d021 Add welcome.rst with info for new developers. 
(imported from commit 14e27efc47cfb0802f16ec5d2d6c5eadeba7a2c2)
 2015-08-22 12:54:20 -07:00
David Roe
1a3bc517d9 Improve docs/README.md 
(imported from commit 78193958bdb5f92ae5d8706340a739dae0da5367)
 2015-08-22 12:53:54 -07:00
David Roe
3f7cb34b00 enterprise => voyager 
(imported from commit 04be792bb480d5e5db1c91d296d1000cf1682571)
 2015-08-21 10:33:35 -07:00
David Roe
f79adf830f deployed => production 
(imported from commit 2d7b0a7a73b0c84b32634a88af1e0d666139d4ff)
 2015-08-21 10:33:35 -07:00
Yoyo Zhou
f78abd2dcc Update schema changes content and formatting. 
(imported from commit 46f3d43bfe62883d490ea870b2d29f7a45397c08)
 2015-08-20 14:24:59 -07:00
Yoyo Zhou
4a6e132a44 Add "Schema changes", rST generated via pandoc -r mediawiki -w rst 
(imported from commit f3c5621a8b612217986c879d3d15b85c9098ccca)
 2015-08-20 14:24:59 -07:00
Yoyo Zhou
1e3249c94e Add note that provision.py sets up postgres test db for you 
(imported from commit 87d31b04db15b8ea994f40362ab910ccc028c91a)
 2015-08-20 14:21:55 -07:00
Yoyo Zhou
a1237aa2b2 Update testing notes formatting and content. 
(imported from commit 44cc34888f14d101c29bcd1c8d63cc082b4ffe09)
 2015-08-20 14:21:55 -07:00
Yoyo Zhou
bb45f8d8e3 Copy "Testing the app" from the wiki, via pandoc -r mediawiki -o rst 
(imported from commit 7150179ff1008ffa6849b983fb579a36fffc9c06)
 2015-08-20 14:21:55 -07:00
Yoyo Zhou
6e55b4df8a Update directory-structure.rst content to fix internal references 
- Delete references to zilencer
- Replace "local server" references
- Add directories for message views, frontend templates/tests, and docs

(imported from commit 7295835434c17609595399e3aec7f9d565fd6b3d)
 2015-08-19 11:52:49 -07:00
Yoyo Zhou
1629e77174 Directory structure generated from pandoc, with formatting fixes 
(imported from commit d54bb062b641bac0520494f0a2cb151d69018d61)
 2015-08-19 11:52:49 -07:00
Yoyo Zhou
127cdf63c6 Add CSS style override for RTD to make tables use word wrapping 
(imported from commit 29007c052dd7048eaf86388a6a9715fc13f102b5)
 2015-08-19 11:52:49 -07:00
Yoyo Zhou
ef50e74873 Fix up rST formatting in code-style.rst. 
- Make all code blocks look like code blocks.
- Eliminate nested inline formatting (rST doesn't support it:
  http://docutils.sourceforge.net/FAQ.html#is-nested-inline-markup-possible).
- Punctuation nits.

(imported from commit cd0d780d843b72065678e0f032a2a47d44836adc)
 2015-08-18 20:17:47 -07:00
Yoyo Zhou
7b9e027e77 Expand the Lint section to replace the Python and JS subsections; remove obsolete comment from Secrets. 
(imported from commit a6945617913700d4e18c398a68022ed90f56039e)
 2015-08-18 20:17:47 -07:00
Yoyo Zhou
8461048a11 Add 'Code style', generated via pandoc -r mediawiki -w rst and html_unescape.py 
With a basic README.md

(imported from commit 91728b2c591bc88b7bee520669cb0b3f53426cd8)
 2015-08-18 17:34:02 -07:00
Yoyo Zhou
c25d9679a5 Utility for unescaping HTML entities leftover from MediaWiki->rST conversion 
(imported from commit 2f2507f299c3d09c67bfd26d6c11fab47431d935)
 2015-08-18 17:31:33 -07:00
Yoyo Zhou
16e462d9d2 Use sphinx_rtd_theme when not on ReadTheDocs 
(imported from commit ba97a475f85251f694e4c88d1dd25eaf69078fc4)
 2015-08-18 17:31:32 -07:00
Yoyo Zhou
ac63d942ce Initial sphinx setup from sphinx-quickstart 
(imported from commit b9fc7a8f2f9352129c104f5dc9305203f2efc63d)
 2015-08-18 17:31:32 -07:00