Commit Graph

1004 Commits

Author SHA1 Message Date
David Taylor 0ffc758129 Add 'category' to WebhookIntegration definition 2017-08-21 14:58:38 -07:00
Greg Price 78b41f375d py3: Revise and update shebang discussion in docs/shell-tips.
This keeps the examples in line with our actual codebase.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Bumps PROVISION_VERSION.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

The code left behind in echo.js does local-echo kind of things
like reifying message ids.
2017-05-09 11:06:10 -07:00
Aditya Bansal e83b703780 pep8: Add compliance with rule E261 to docs/conf.py. 2017-05-07 23:21:50 -07:00
hackerkid 6329b472b0 docs: Update the path of Supervisor config file.
zulip.conf was changed to template file but the update was missed out in the doc.
See ae09d55e46
2017-05-07 23:20:38 -07:00