Commit Graph

1045 Commits

Author SHA1 Message Date
Tim Abbott 7fd7e054e1 docs: Fix broken link in changelog on ReadTheDocs. 2017-10-23 17:43:21 -07:00
Tim Abbott 8a32f012bf docs: Highlight notes on apt upgrades for perf. 2017-10-23 17:41:25 -07:00
Tim Abbott a174455ae1 docs: Document API super user bots a bit more in security model docs. 2017-10-23 17:37:38 -07:00
Tim Abbott e450d9ab8c docs: Document text_content field of our markdown test cases. 2017-10-20 16:08:16 -07:00
Tim Abbott 42d6defd40 docs: Update changelog for changes going into 1.7 release. 2017-10-20 15:39:53 -07:00
derAnfaenger 1b67652380 docs: Add explicit command to su to zulip from prod step 5 on. 2017-10-20 14:57:44 -07:00
Tim Abbott 0828b4ad90 docs: Add troubleshooting notice for `su zulip` as the zulip user. 2017-10-20 14:57:44 -07:00
Tim Abbott 216fbc2f79 docs: Fix a typo in installation docs. 2017-10-20 14:55:20 -07:00
Tim Abbott 54a2ef7b59 docs: Improve discussion of Ubuntu system updates. 2017-10-20 14:38:34 -07:00
Tim Abbott b511e9d0a9 docs: Recommend Xenial over Trusty for new installations. 2017-10-20 14:34:48 -07:00
Greg Price 12f8ec780e docs/expensive-migrations: Revise a bit for clarity.
Borrows some language from the paragraph in the changelog that
points to it.
2017-10-20 14:21:58 -07:00
Greg Price 50927c7cfd changelog: Revise a bit for clarity and formatting before 1.7 release.
This leaves most of the highlights untouched, to be revised
separately.
2017-10-20 14:04:27 -07:00
Tim Abbott 7c7e93cb43 docs: Improve discussion of legacy desktop app in changelog. 2017-10-20 12:11:06 -07:00
Nikhil Kumar Mishra 075158ec81 docs: Correct details about mobile and desktop codebases.
http://zulip.readthedocs.io/en/latest/architecture-overview.html
mentions "Our mobile clients are separate code repositories: Android
and React Native iOS app. " However Zulip Mobile is the official
mobile Zulip client supporting both iOS and Android.

Edited by tabbott to also fix confusion about the desktop.
2017-10-20 11:57:26 -07:00
Tim Abbott b6de7e3b90 docs: Mention system bot realm in multiple organization docs. 2017-10-20 09:57:16 -07:00
Tim Abbott b33d80707c docs: Document push notification redacting setting. 2017-10-19 18:17:35 -07:00
Alexis La Porte ec3b2072ce docs: Fix broken anchor links to troubleshooting section.
The Vagrant environment setup tutorial anchor links for the
Troubleshooting & Common Errors section don't work in GitHub flavored
markdown because the ampersand in the heading gets removed and the
resulting space is filled with a hyphen. (See here:
https://gist.github.com/asabaylus/3071099#gistcomment-1593627)

To make anchor links work with ReadTheDocs as well as with GitHub
markdown for the time being, this commit changes ampersand in the
heading to 'and'.

Fixes #7056.
2017-10-18 15:20:58 -07:00
rht a967ac5fa7 docs: Simplify install instruction for production environment. 2017-10-18 09:21:16 -07:00
rht a603a4f9f5 Remove `from __future__ import absolute_import`.
Except in:
- docs/writing-bots-guide.md, because bots are supposed to be Python 2
  compatible
- puppet/zulip_ops/files/zulip-ec2-configure-interfaces, because this
  script is still on python2.7
- tools/lint
- tools/linter_lib
- tools/lister.py

For the latter two, because they might be yanked away to a separate repo
for general use with other FLOSS projects.
2017-10-17 22:59:42 -07:00
Tim Abbott 88325c7e85 docs: Simplify discussion of sha256sums. 2017-10-17 22:16:37 -07:00
rht dceaa1d19a Add sha256sum integrity check to the release tarball.
This stems from the discussion at
https://chat.zulip.org/#narrow/stream/general/topic/signing.20the.20release
2017-10-17 22:15:14 -07:00
Tim Abbott 2648d595c1 Revert "docs: Fix broken anchor links in troubleshooting guide."
This reverts commit fa71f64adb.
2017-10-17 21:37:26 -07:00
Tim Abbott fa71f64adb docs: Fix broken anchor links in troubleshooting guide.
Fixes #7056.
2017-10-17 20:38:59 -07:00
Priscilla 22ade4f691 docs: Fix typo on "General user guide documentation".
"browsing" on line 11 was missing an "s".
2017-10-16 22:37:34 -07:00
Rishi Gupta 70cf4991da docs: Add notes on audience to user-docs.md. 2017-10-13 11:59:20 -07:00
Garvit Dewan b0235bc458 dependencies.md: Fix a typo. 2017-10-13 07:11:29 -07:00
Tim Abbott 498d061e5e docs/email: Document how to use a Gmail account with 2FA.
Fixes #6974.
2017-10-12 11:38:01 -07:00
Tim Abbott aaf1cf848a docs/email: Clarify discussion Django's EMAIL_HOST_PASSWORD.
This fixes the second part of #6974 about EMAIL_HOST_PASSWORD.
2017-10-12 11:31:06 -07:00
Greg Price 0b6bcc9c33 docs/dev-env: Explicitly recommend VirtualBox 5.1.8 exactly. 2017-10-09 20:43:12 -07:00
Greg Price 0691724836 passwords: Set default zxcvbn threshold to 10k guesses.
See the discussion in the revised docs for background and motivation,
and an explanation of why this value.
2017-10-08 15:48:44 -07:00
Greg Price a116303604 passwords: Express the quality threshold as guesses required.
The original "quality score" was invented purely for populating
our password-strength progress bar, and isn't expressed in terms
that are particularly meaningful.  For configuration and the core
accept/reject logic, it's better to use units that are readily
understood.  Switch to those.

I considered using "bits of entropy", defined loosely as the log
of this number, but both the zxcvbn paper and the linked CACM
article (which I recommend!) are written in terms of the number
of guesses.  And reading (most of) those two papers made me
less happy about referring to "entropy" in our terminology.
I already knew that notion was a little fuzzy if looked at
too closely, and I gained a better appreciation of how it's
contributed to confusion in discussing password policies and
to adoption of perverse policies that favor "Password1!" over
"derived unusual ravioli raft".  So, "guesses" it is.

And although the log is handy for some analysis purposes
(certainly for a graph like those in the zxcvbn paper), it adds
a layer of abstraction, and I think makes it harder to think
clearly about attacks, especially in the online setting.  So
just use the actual number, and if someone wants to set a
gigantic value, they will have the pleasure of seeing just
how many digits are involved.

(Thanks to @YJDave for a prototype that the code changes in this
 commit are based on.)
2017-10-08 15:48:44 -07:00
Tim Abbott 1ceaedb2c5 docs: Remove html_unescape.py.
This was just for 1-time use exported the original Zulip documentation.
2017-10-08 15:41:41 -07:00
Tim Abbott 630037967f docs: Stop linking to removed whitespace section of style guide.
We should probably just encourage linting for this.
2017-10-06 14:02:32 -07:00
Tim Abbott 0ac78cb14d code-style: Simplify discussion of third-party code. 2017-10-06 13:28:45 -07:00
Tim Abbott a632c8471d code-style: Improve state and logs discussion. 2017-10-06 13:26:13 -07:00
Tim Abbott e660faa225 docs: Remove code style section on jQuery global state.
I don't think anyone has tried to do this for a long time, since the
channel module makes it pretty clear how to do an ajax call.
2017-10-06 13:24:26 -07:00
Tim Abbott 0054fa17f1 docs: Simplify javascript var discussion.
We don't need as much as before, since it's enforced by the linter.
2017-10-06 13:24:06 -07:00
derAnfaenger 7ff697d053 linter: Add rule against using `pk` instead of `id`.
There's one exception here, for model._meta.pk.  To support this
nicely, we added this exclude-pattern feature.
2017-10-06 12:56:26 -07:00
derAnfaenger 64b8930225 linter: Add rules against improper shebangs. 2017-10-06 12:46:19 -07:00
derAnfaenger 71159fe19a code style guide: Remove obsolete space-around-bracket rule.
For .py files, our pep8 linter enforces this rule.
For .js files, eslint enforces this rule.
2017-10-06 12:46:12 -07:00
derAnfaenger c022b7a8fa linter: Add rule against using the `style` attribute.
This has a ton of exclude rules, for two reasons:

(1) We haven't been particularly systematic about avoiding unnecessary
inline style in the past, so there's a lot of code we need to fix.

(2) There are cases where one wants to dynamically compute style
rules. For the latter category, ideally we'd figure out a way to
exclude these automatically (e.g. checking for mustache tags in the
style tag).
2017-10-06 08:33:10 -07:00
Tim Abbott 930eef3caa tools: Add new script to sync translations.
We just learned we should be using the "onlytranslated" mode of
Transifex.  Since the command is getting a bit complex (and you need
to remember to run `makemessages` first), it makes sense to have a
tool for it.
2017-10-05 23:07:16 -07:00
Tim Abbott 26982ff55f puppet: Remove pageduty_nagios.pl.
This hasn't been used in like 4 years, and clutters the repo.
2017-10-05 18:46:09 -07:00
derAnfaenger 2cdde8b168 linter: Add rule against verbose $(document).ready() calls. 2017-10-05 10:11:34 -07:00
derAnfaenger 6b99022a02 linter: Add rule against using inline event handlers. 2017-10-05 10:08:40 -07:00
derAnfaenger c01981a65f linter: Extend no-space-before-bracket linting rule. 2017-10-05 10:05:27 -07:00
derAnfaenger c957d1857e code style guide: Update and remove outdated rules.
These are all enforced by our linters, and thus a source of clutter in
this code style guide.
2017-10-05 10:05:17 -07:00
Tim Abbott ab71c42ab8 docs: Update confusing changelog entry.
The original text meant to say "lost", not "last", but also was a bit
confusing anyway.
2017-10-05 09:32:02 -07:00
Joshua Pan a38d275aeb docs: Capitalize Zulip in changelog.md. 2017-10-05 09:24:09 -07:00
Tim Abbott de51eb9e7f docs: Update changelog and roadmap through present. 2017-10-04 22:39:49 -07:00
rht ac01b0c559 docs: Add type annotation.
Discovered while running the 2to3 type annotation.
2017-10-04 16:31:27 -07:00
Vishnu Ks 119157b205 docs: Update email testing section to include EmailLogBackEnd.
Rewritten by tabbott for extra clarity.
2017-10-04 14:44:58 -07:00
Tim Abbott 8d4f084623 code-style: Remove discussion of absolute_import.
It's no longer accurate on Python 3.
2017-10-04 14:09:05 -07:00
Tim Abbott b7974fc9f8 docs: Delete useless/wrong content from JavaScript code style.
One of these isn't true (not requiring braces) and the rest are
already handled by our linters.
2017-10-04 13:59:38 -07:00
Tim Abbott a001b8aef3 docs: Remove unnecessary CSS section from code style.
This is already handled by our linter, so no need to repeat it here.
2017-10-04 13:58:50 -07:00
Tim Abbott 4230871503 docs: Update code style guide for Python. 2017-10-04 13:53:06 -07:00
neiljp (Neil Pilgrim) dbc8415fa5 docs: typos in code-style.md; zephyr -> zerver. 2017-10-04 13:52:31 -07:00
Tim Abbott 4eafec12ac docs: Rewrite the intro to writing bots. 2017-10-04 12:22:02 -07:00
Tim Abbott 26dd1ab6a7 docs: Simplify the guide for running bots. 2017-10-04 12:11:27 -07:00
derAnfaenger 7a43ab00a2 running bots guide: Clarify bot's directory statement. 2017-10-04 11:49:22 -07:00
derAnfaenger 543500bab5 bots guides: Refactor layout.
This flattens the layout, shifts passages and unitizes headings to
use gerunds for the running and writing bots guides.
2017-10-04 11:49:22 -07:00
derAnfaenger b6106ca7ac running bots guide: Add cross-references to writing bots guide. 2017-10-04 11:49:21 -07:00
derAnfaenger 8449ea300b running bots guide: Shorten installation section. 2017-10-04 11:49:21 -07:00
derAnfaenger 6b879a2b04 docs: Split bots guide into running and writing guides. 2017-10-04 11:49:20 -07:00
Vishnu Ks 2267f09813 docs: Change place to ask help from mailing list to chat.zulip.org. 2017-10-04 08:20:29 -07:00
Tim Abbott 1b637658df docs: Add a section documenting the chat.zulip.org traffic level. 2017-10-03 15:41:46 -07:00
Tim Abbott c447e7530b docs: Update realms documentation for REALMS_HAVE_SUBDOMAINS removal. 2017-10-02 16:32:10 -07:00
Eeshan Garg 502e93a5d2 docs: Recommend check_send_stream_message for stream messages.
This commit updates various places where check_send_message had
been previously recommended to recommend check_send_stream_message
for sending messages to a public stream.
2017-10-02 15:27:26 -07:00
Tim Abbott 50eb94f7ee docs: Remove broken link to shell tips.
In theory, we could replace it, but it's not clear that's necessary.
2017-10-01 23:27:29 -07:00
Priscilla 7c0431a60f docs: Correct the instructions for re-running provision.
We apparently missed this when renaming provision.py to simply
provision.
2017-10-01 15:51:32 -07:00
rht e0f7b6f8ef docs: Remove the yarn.lock stutter.
Maybe someday someone will spot this err. However, the documentation is
clear in conveying its content even with the extra yarn.lock.
2017-09-30 09:16:46 -07:00
Alena Volkova e216801be8 docs: Fix a typo in version-control.md. 2017-09-29 18:04:07 -07:00
Greg Price 7e8bbda171 docs/logging: Update for the revised log format.
This accumulates several changes in recent commits: decimal point
rather than comma, compact log level, and logger names, the latter
abbreviated `zr` in the case of `zulip.request`.
2017-09-28 18:26:39 -07:00
Alena Volkova bcb9c76457 docs: Clarify who can collaborate in area label teams.
Collaboration in area label teams is only available to members of the
Zulip organization on GitHub. For non-members the related links are
not working, which can be confusing.  Address this by explaining the
links won't work and also that anyone can join.
2017-09-28 17:26:07 -07:00
Greg Price 85f7764ed4 docs/settings: Small tweaks for clarity. 2017-09-28 17:01:50 -07:00
Robert Hönig db5ed277d1 bots guide: Update outdated `run.py` to `zulip-run-bot`. 2017-09-28 11:10:09 -07:00
Robert Hönig a7d3355fd6 bots guide: Remove need to subscribe bots to streams.
Since 7878c70, bots don't need to to be subscribed to a
stream to be notified on @-mentions.
2017-09-28 11:10:09 -07:00
Greg Price 7b8f725707 APNs: Accept 1.6-format payloads in bouncer.
This is just enough of a quick fix to work with a stock Zulip 1.6
server.  We should really also make this robust to arbitrary input
from the remote Zulip server, even though it'll be a little tedious.
2017-09-28 10:01:16 -07:00
Tim Abbott 2317b63068 docs: Document narrowing reporting. 2017-09-27 19:47:45 -07:00
Tim Abbott 0744961afe docs: Add more comprehensive documentation on error reporting.
Fixes #2232.
2017-09-27 19:47:08 -07:00
rht 8aa8991caa docs: Remove import print_function. 2017-09-27 18:06:47 -07:00
Eeshan Garg bb34ba37b5 tools: Rename build_pygments_data.py -> build_pygments_data.
Dropping the file extension (.py) conforms to our naming
convention for such scripts.
2017-09-26 16:00:41 -07:00
Greg Price a9aa31ac96 docs: Fix lint in typing-indicators. 2017-09-26 13:57:03 -07:00
Steve Howell d6fb17c424 docs: Add typing-indicators.md. 2017-09-26 13:42:14 -07:00
Tim Abbott 3964a6e9a3 docs: Document the new transactional email logs. 2017-09-25 15:37:09 -07:00
Tim Abbott 14ef682a4e docs: Update emoji tooling documentation.
This is a start and fixes the most glaring problems from not updating
this documentation; I'd like Harshit to do a helpful pass on updating
this to cover some of the more subtle details about how our emoji
picker works, emoji aliases, etc.
2017-09-25 14:24:52 -07:00
rht 9bd3f772b7 Move Dockerfile to Dockerfile-dev.
Based on zulip#450, with commits restructured by Rein Zustand.
2017-09-25 12:32:33 -07:00
Tim Abbott a2243378ea settings: Set REALMS_HAVE_SUBDOMAINS by default.
This change means that almost every Zulip server out there will now be
using subdomains for every realm.  There are a few complications noted
in the release notes.
2017-09-25 06:52:32 -07:00
Kiran Shahdadpuri 3776e73db4 docs: Improve analytics onboarding documentation.
Tweaked by tabbott to reorganize the text a bit.
2017-09-25 06:23:30 -07:00
Eeshan Garg 390a1fec92 zulip_bots: Generate static files during provisioning.
This commit implements support for copying over static files
for all bots in the zulip_bots package to
static/generated/bots/ during provisioning. This directory
isn't tracked by Git. This allows us to have access to files
stored in an arbitrary zulip_bots package directory somewhere
on the system. For now, logo.* and doc.md files are copied over.

This commit should act as a starting point for extending our
macro-based Markdown framework to our bots/API packages'
documentation and eventually rendering these static files
alongside our webhooks' documentation.
2017-09-22 15:14:42 -07:00
Tim Abbott 3708f5708a upgrade: Include zulip::static_asset_compiler by default.
Since we've found that it's fairly frequent that we want to recommend
to developers that they upgrade to a version of Zulip from Git, it
makes sense to include that by default.
2017-09-22 11:38:20 -07:00
Tim Abbott 4da9e77096 docs: Expand documentation of provisioning.
Fixes #2668.
2017-09-22 11:23:17 -07:00
Tim Abbott b1f4c7308e docs: Fix a broken link in new documentation. 2017-09-22 11:23:17 -07:00
Tim Abbott 876fd95486 docs: Document how our dependencies are managed.
Fixes #5481.
2017-09-22 11:09:58 -07:00
Vishnu Ks 5db810b5d7 docs: Fix example code in mock section. 2017-09-19 16:56:56 -07:00
Vishnu Ks 14498d1407 docs: Use real method name instead of foo in mock section. 2017-09-19 16:56:56 -07:00
Vishnu Ks f4c69bb126 tools: Create tool for inlining email CSS during provision. 2017-09-16 07:17:48 -07:00
vbNETonIce 264dcb4e2d docs: Fix path to restart-server script. 2017-09-16 02:22:30 -07:00
zeneli 17d35af334 docs: Fix filename for new application view URL. 2017-09-16 00:38:32 -07:00
Robert Hönig fb39e884c8 docs: bots guide: Add section for writing tests. 2017-09-15 08:59:21 -07:00