Commit Graph

966 Commits

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