Commit Graph

393 Commits

Author SHA1 Message Date
Meena Rajan 30acb23314 bugdown: Add support for strikethrough in markdown processor.
[Tweaked to move tests to bugdown_data.json, add additional tests, and
add frontend processor support by tabbott]
2016-11-07 22:26:38 -08:00
Tim Abbott a8fdfccc83 docs: Fix echo.contains_bugdown docs being backwards. 2016-11-07 07:54:27 -08:00
Tim Abbott 7c8d502c70 docs: Add details on our markdown change requirements. 2016-11-06 11:57:10 -08:00
Tim Abbott 1641d1952f docs: Add a section on changing Zulip's markdown. 2016-11-06 11:49:37 -08:00
Tim Abbott 70c00038d9 docs: Clarify our markdown docs.
This is just a cleanup and reorganization of some of the text; no
changes are made to the actual content.
2016-11-06 11:37:22 -08:00
hackerkid bb4eb213c1 docs: Add testing notes to markdown doc. 2016-11-06 11:22:34 -08:00
Steve Howell 2088e8420f User user_id, not email, in peer_add events. 2016-11-04 11:37:14 -07:00
Steve Howell c5c3dfe33f Add subscriber counts to changelog.md. 2016-11-04 11:37:14 -07:00
Tim Abbott 945c2c4f86 docs: Add a brief release checklist. 2016-11-04 10:52:48 -07:00
sinwar 67d99c536a docs: change zulip.tabbott.net to chat.zulip.org 2016-11-03 16:07:59 -07:00
deekshaarul 3f5ef8df9e docs: Fix typos in git guide. 2016-11-03 10:12:03 -07:00
Tim Abbott d22a06ee90 docs: Fix a missing close paren. 2016-11-01 12:32:36 -07:00
Tim Abbott 1bae9d10e3 docs: Improve wording details in the new realm document. 2016-11-01 10:50:06 -07:00
hackerkid 1e409032bd docs: Add subsystem section discussing realms and subdomains. 2016-11-01 10:49:47 -07:00
Tim Abbott 14dc98d8b9 server_events: Switch to using REST-style URLs.
This eliminates our use of /json/get_events; we'll remove that
endpoint in a future commit.
2016-10-25 18:02:16 -07:00
K.Kanakhin 8dabc6d499 docs: Fix broken link in upgrading docs. 2016-10-25 11:35:14 -07:00
Tim Abbott c970a87dfa code-style: Fix broken links to anti for-in styleguides.
These two pages were moved over the last few years.
2016-10-24 11:10:25 -07:00
Rishi Gupta 28dd7080c7 docs: Add message editing policy to prod security section.
Fixes #1214.
2016-10-23 20:20:34 -07:00
Sumana Harihareswara f86cd0aa26 docs: Fix style in authentication methods doc. 2016-10-22 20:14:56 -07:00
Sumana Harihareswara 04c8c9d5bd docs: Updates to production customization guide. 2016-10-22 20:13:37 -07:00
Sumana Harihareswara dd3a19ab58 docs: Clarify export_single_user. 2016-10-22 20:13:06 -07:00
Sumana Harihareswara facf0ac1f3 docs: Add psql instructions. 2016-10-22 20:13:06 -07:00
Tim Abbott c20011ccd5 docs: Remove unnecessary and broken SSO breadcrumb link. 2016-10-22 19:30:24 -07:00
K.Kanakhin 9492bd37b4 docs-test: Fix documentation links.
- Fix internal documentation links and anchors according last project documentation version.

Fixes #1492
2016-10-22 19:30:24 -07:00
Tim Abbott a32eaf28c0 docs: Remove broken indices and tables index section.
None of these links worked properly.
2016-10-22 19:23:11 -07:00
Tim Abbott 4352790795 docs: Fix broken link in node testing docs. 2016-10-22 19:21:19 -07:00
Steve Howell c21fe60430 Add make_stream() to django testing docs. 2016-10-22 18:09:34 -07:00
Prabhakar Gupta bc6421fbfb tools: Remove empty wrapper script build_emoji.
This renames the old `emoji_dump.py` to `build_emoji`, removing the
old shell essentially empty shell script.  `emoji_dump.py` was always
a weird name, and this makes it a bit easier to read the code for this
system.
2016-10-20 22:57:45 -07:00
Sumana Harihareswara 2083ffa7a6 docs: Improve export documentation.
Added user and realm export guidance in production maintenance docs,
linked to conversion guide, and revamped the introduction and styled
the text that Steve wrote.
2016-10-20 22:52:32 -07:00
Sumana Harihareswara d9d389f64f docs: Add an initial code review document.
A first pass at a code review guide. Mostly Tim's draft; I added
polish and links.

Fixes: #758.
2016-10-20 22:41:38 -07:00
Steve Howell 76acab36b2 Remove do_add_subscription from Django testing docs. 2016-10-20 22:05:19 -07:00
Sumana Harihareswara c3d3288b63 docs: Style & link text in prod maintenance guide.
Also fix line wrapping and some capitalization.
2016-10-20 11:53:46 -07:00
Sumana Harihareswara a4516bda7d docs: Fix security bug email address. 2016-10-20 11:53:46 -07:00
Tim Abbott 8f6a58f741 docs: Expand translating documentation a bit. 2016-10-19 15:34:31 -07:00
Tim Abbott 92b8ce32fc docs: Clean up translation resources discussion. 2016-10-19 15:32:28 -07:00
Sumana Harihareswara 8d4b32a13a Fix style and linewrapping & add links in translation doc. 2016-10-19 15:30:35 -07:00
Sumana Harihareswara 8d1e87cfff Add translations stream link to translation doc. 2016-10-19 15:30:35 -07:00
Vikas Parashar e962704c71 Add installation troubleshooting instructions in case of pip failure.
Add help for pip install failure during provisioning step of
initial vagrant up during developer environment installation.

Fixes: #1333.
2016-10-19 12:34:08 -07:00
Steve Howell c4b2f6d816 docs: Say "Set up" instead of "Setup".
I think "setup" generally implies a noun.
2016-10-18 17:29:00 -07:00
Steve Howell 2676083b94 Add introduction to docs on node tests.
Also, de-emphasize the process for creating new test modules,
as this is an advanced task that we can further document later
and generally handle as part of code review.
2016-10-17 19:46:17 -07:00
Sumana Harihareswara 6323494f37 docs: Properly capitalize GitHub. 2016-10-17 19:31:50 -04:00
Christie Koehler 23df7913d5 docs: Add Git and GitHub Guide.
Fixes #783, #1754.
2016-10-17 16:18:16 -07:00
Tim Abbott a28a5bb977 docs: Update roadmap HTML with now-completed issues. 2016-10-16 13:09:28 -07:00
Tim Abbott e37b6488b8 Bugdown: Remove checked-in CodeHilite extension.
The changes that required us to fork this extension had been merged
into upstream CodeHilite, so we can remove it and switch to using the
version that comes with python-markdown.
2016-10-16 00:40:08 -07:00
Abhishek Kumar Singh 87c94a8697 docs/writing-views: Fix minor typo.
I found this typo while reading the blog written about
[mypy](http://blog.zulip.org/2016/10/13/static-types-in-python-oh-mypy/)
2016-10-15 12:26:40 -07:00
Tim Abbott 66df520cbe docs: Add a section on CalledProcessorError issues when provisioning.
Inspired by @deekshaarul's work on
https://github.com/zulip/zulip/pull/1939.
2016-10-14 21:29:27 -07:00
sonali0901 66a740b5c1 Architecture docs: Reposition backtick for address of Nagios plugin 2016-10-14 16:25:25 -07:00
Tim Abbott e2810ca1be docs: Update path to update_realm code. 2016-10-11 21:28:14 -07:00
Tim Abbott de5c1eb363 docs: Move glossary to bottom of architecture overview.
I think the old place where we had it broke up the flow.

Once this is about twice as long as it is currently, we should move it
to be its own document.
2016-10-11 16:44:39 -07:00
Sumana Harihareswara 7fee09458b Add starring to glossary. 2016-10-11 16:44:39 -07:00
Sumana Harihareswara f1593b243c docs: Add chevron and message editing to glossary. 2016-10-11 16:44:39 -07:00
Sumana Harihareswara d9c81dcfdd docs: Add recipient bar to usage assumptions/concepts.
Add start of glossary section.
2016-10-11 16:44:39 -07:00
Christie Koehler 952d91f60a docs: Fix broken image links on prod install page. 2016-10-11 15:19:43 -07:00
Supriya 598c7a506b docs/custom-apps: Fix spelling error. 2016-10-11 13:39:59 -07:00
Tim Abbott fec6527656 dev-overview: Document cloud server option. 2016-10-10 17:10:39 -07:00
zeddmaxx 1348b9dde3 dev-overview: Improve organization of installation overview page.
Fixes #1814.

[substantially tweaked by tabbott]
2016-10-10 17:06:59 -07:00
Bertrand Croq c705819f2d custom-apps docs: Fix stumulus typo. 2016-10-10 08:38:51 -07:00
Steve Howell 0bdc9fef5c Upgrade caspersjs to version 1.1.3. (w/acrefoot)
(Most of this work was done by acrefoot in an earlier branch.
I took over the branch to fix casper tests that were broken during
the upgrade (which were fixed in a different commit).  I also
made most of the changes to run-casper.)

This also upgrades phantomjs to 2.1.7.

The huge structural change here is that we no longer vendor casperjs
or download phantomjs with our own script.  Instead, we just use
casperjs and phantomjs from npm, via package.json.

Another thing that we do now is run casperjs tests individually, so
that we don't get strange test flakes from test interactions.  (Tests
can still influence each other in terms of changing data, since we
don't yet have code to clear the test database in between tests.)

A lot of this diff is just removing files and obsolete configurations.

The main new piece is in package.json, which causes npm to install the
new version.

Also, run-casper now runs files individually, as mentioned above.

We had vendored casperjs in the past.  I didn't bring over any of our
changes.  Some of the changes were performance-related (primarily
5fd58cf249), so the upgraded version may
be slower in some instances.  (I didn't do much measurement of that,
since most of our slowness when running tests is about the setup
environment, not casper itself.)  Any bug fixes that we may have
implemented in the past were either magically fixed by changes to
casper itself or by improvements we have made in the tests themselves
over the years.

Tim tested the Casper suite on his machine and running the full Casper
test suite is faster than it was before this change (1m30 vs. 1m50),
so we're at least not regressing overall performance.
2016-10-08 12:08:43 -07:00
Tim Abbott d0f295c77f docs: Clarify commit message portion of version control docs. 2016-10-05 19:28:21 -07:00
Tim Abbott 5357b286b2 docs: Fix typo in spelling of generate_secrets. 2016-10-05 17:47:14 -07:00
Rishi Gupta 777fcaa6a0 Add new organization type field to Realm objects.
Adds a new field org_type to Realm.  Defaults for restricted_to_domain
and invite_required are now controlled by org_type at time of realm
creation (see zerver.lib.actions.do_create_realm), rather than at the
database level.  Note that the backend defaults are all
org_type=corporate, since that matches the current assumptions in the
codebase, whereas the frontend default is org_type=community, since if
a user isn't sure they probably want community.

Since we will likely in the future enable/disable various
administrative features based on whether an organization is corporate
or community, we discuss those issues in the realm creation form.
Before we actually implement any such features, we'll want to make
sure users understand what type of organization they are a member of.

Choice of org_type (via radio button) has been added to the realm
creation flow and the realm creation management command, and the
open-realm option removed.

The database defaults have not been changed, which allows our testing code
to work unchanged.

[includes some HTML/CSS work by Brock Whittaker to make it look nice]
2016-10-05 17:01:46 -07:00
Tomasz Kolek 7df50cee34 docs: Fix paths in webhooks part of integration-guide.
We forgot to update the documentation when we rearranged the webhooks
tests to be split across several files.

[mostly rewritten by tabbott]
2016-10-04 20:09:58 -07:00
Tim Abbott 279f805448 run-dev: Automate passing --interface='' for vagrant environment.
Fixes #877.
2016-10-04 10:48:26 -07:00
sonali0901 4869e1b0b2 test-backend: Add convenience arguments to run subsets of the tests.
This optimizes the process of running individual or small groups of
backend tests (./tools/test-backend
zerver.tests.test_bugdown.FencedBlockPreprocessorTest.test_simple_quoting)
to allow the following syntaxes:

    ./tools/test-backend zerver/tests/test_bugdown.py
    ./tools/test-backend zerver.tests.test_bugdown.py
    ./tools/test-backend zerver/tests/test_bugdown
    ./tools/test-backend zerver.tests.test_bugdown
    ./tools/test-backend test_bugdown.py
    ./tools/test-backend test_bugdown
    ./tools/test-backend FencedBlockPreprocessorTest
    ./tools/test-backend FencedBlockPreprocessorTest.test_simple_quoting

Fixes #1670.
2016-09-28 11:52:05 -07:00
Tim Abbott 03bf8893e2 Remove legacy /api/v1/send_message endpoint.
This was the original way to send messages via the Zulip API in the
very early days of Zulip, but was replaced by the REST API back in
2013.

Fixes: #730.
2016-09-27 14:51:54 -07:00
Sahil Dua 058587da77 Remove extra new lines at the ends of Zulip authoried files.
Fixes #1627.

[tweaked by tabbott to avoid patching third-party modules, for now]
2016-09-26 21:05:24 -07:00
umkay 798e6faa9e provision: Use NVM to install node and npm.
NVM takes a specific node version and installs the node package and
a corresponding compatible npm package.

We use it in a somewhat hackish way to install node/npm globally with
a pinned version, since that's how we actually want to consume node in
our development environment.

Other details:
- Travis CI now is configured to use the version of node installed by
provision; the easiest way to do this was to sabotage the existing node
installation.
- jsdom is upgraded to a current version, which both requires recent
node and also is required for the tests to pass with recent node.
This fixes running the node tests on Xenial.

Fixes #1498.

[tweaked by tabbott]
2016-09-23 14:34:44 -07:00
Eklavya Sharma 2d3921e3e4 Add instructions for manually installing pgroonga. 2016-09-17 09:23:54 -07:00
sonali0901 15331ad9fa docs: Document invite-only streams are hidden from other users.
Fixes: #1756.
2016-09-14 10:06:10 -07:00
Tim Abbott cd0025f67f docs: Update roadmap with recently completed projects. 2016-09-12 14:56:08 -07:00
Tim Abbott b744a3a4d7 docs: Update changelog since 1.4.0 release. 2016-09-07 19:51:14 -07:00
Tim Abbott c9f9fb265e Update provision.py and Vagrantfile to support VMWare.
This adds support for using VMWare Fusion as the Vagrant provider,
which has better performance than Virtualbox at the price of being
nonfree (in all senses of the term).

We haven't done solid benchmarking as to how much faster it is than
the Virtualbox provider.
2016-09-07 19:30:48 -07:00
neurodynamic 91a1e8aebc Add note about the email_password setting 2016-08-28 13:29:51 -07:00
Steve Howell 65b884f44d docs: Explain how to re-build the table of contents. 2016-08-27 11:30:57 -07:00
Steve Howell c8e37f30d2 docs: Add "Custom Apps" to "Subsystem Documentation". 2016-08-27 11:30:57 -07:00
Steve Howell f5a1923cbf docs: Create "Custom Apps" document. 2016-08-27 11:30:57 -07:00
Kouhei Sutou 683f49aa99 Support full text search for all languages using pgroonga.
This adds support for using PGroonga to back the Zulip full-text
search feature.  Because built-in PostgreSQL full text search doesn't
support languages that don't put space between terms such as Japanese,
Chinese and so on. PGroonga supports all languages including Japanese
and Chinese.

Developers will need to re-provision when rebasing past this patch for
the tests to pass, since provision is what installs the PGroonga
package and extension.

PGroonga is enabled by default in development but not in production;
the hope is that after the PGroonga support is tested further, we can
enable it by default.

Fixes #615.

[docs and tests tweaked by tabbott]
2016-08-26 21:04:03 -07:00
Tim Abbott 1d0ae8b11c docs: Clarify that one should unpack in /root to install. 2016-08-26 11:56:12 -07:00
Tim Abbott b200c6cdc0 Move assets/ to live under static/.
This decreases the clutter in the root directory of the Zulip
repository.
2016-08-26 10:23:38 -07:00
Tim Abbott 9001bebf2f Move THIRDPARTY to docs/ subdirectory. 2016-08-25 20:02:42 -07:00
Rag Sagar ce1777b0cb Update update_realm view path and signature in the new feature tutorial. 2016-08-25 19:35:42 -07:00
Tim Abbott 7e4caf3a67 Release Zulip 1.4. 2016-08-25 10:49:00 -07:00
Tim Abbott fba93cb494 scripts: rename deploy-zulip-from-git to reference upgrading. 2016-08-25 10:48:59 -07:00
Tim Abbott 7f445be23d docs: Clean up headings for maintenance page. 2016-08-25 10:48:48 -07:00
Tim Abbott 54c5c989c9 docs: Fix some broken links in headings. 2016-08-25 10:41:00 -07:00
Tim Abbott c0799a9d09 docs: Fix docs for upgrading from a git repository. 2016-08-25 10:40:51 -07:00
Tim Abbott 9839d93362 docs: Clean up duplicated content in development overview. 2016-08-25 10:40:51 -07:00
Tim Abbott f6c4e46afe docs: Move README.dev.md into ReadTheDocs.
Fixes: #669.
2016-08-25 10:40:51 -07:00
Tim Abbott d876909b69 docs: Clean up development environment headings. 2016-08-25 10:40:51 -07:00
Tim Abbott 30b5c2a4c0 docs: Document the fact that 14.04->16.04 is not supported. 2016-08-25 10:40:51 -07:00
Tim Abbott f1a91c8028 docs: Document Zulip PPA is available for 16.04 as well. 2016-08-25 10:40:51 -07:00
Tim Abbott c5417e723b docs: Fix command sequence for retrying Zulip installation. 2016-08-25 10:40:51 -07:00
Tim Abbott c0975b03a5 docs: Document Ubuntu 16.04 support in production. 2016-08-25 10:40:51 -07:00
Tim Abbott c0e68d59cb docs: Rename status/debug page to troubleshooting. 2016-08-25 09:37:33 -07:00
Tim Abbott be4e806d60 docs: Collapse install steps 2 and 3 together. 2016-08-25 09:37:33 -07:00
Tim Abbott cd632faff6 docs: Clean up scrollbar in install docs. 2016-08-25 09:37:33 -07:00
Tim Abbott 8a82c29d21 docs: Move SSL docs to a dedicated page. 2016-08-25 09:37:33 -07:00
Tim Abbott 8086cc549f docs: Merge prod-auth-first-login into main installation page. 2016-08-25 09:37:33 -07:00
Tim Abbott 1d273b93da docs: Move screenshots to their own page. 2016-08-25 09:37:33 -07:00
Tim Abbott da0d9e716d docs: Move management docs to a better place and expand.
Now that a management command is not required to install Zulip, we can
bury the documentation on them a bit more.

Fixes: #551.
2016-08-25 09:37:33 -07:00