fec6527656
dev-overview: Document cloud server option.
2016-10-10 17:10:39 -07:00
1348b9dde3
dev-overview: Improve organization of installation overview page.
...
Fixes #1814 .
[substantially tweaked by tabbott]
2016-10-10 17:06:59 -07:00
c705819f2d
custom-apps docs: Fix stumulus typo.
2016-10-10 08:38:51 -07:00
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
2016-10-08 12:08:43 -07:00
d0f295c77f
docs: Clarify commit message portion of version control docs.
2016-10-05 19:28:21 -07:00
5357b286b2
docs: Fix typo in spelling of generate_secrets.
2016-10-05 17:47:14 -07:00
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
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
279f805448
run-dev: Automate passing --interface='' for vagrant environment.
...
Fixes #877 .
2016-10-04 10:48:26 -07:00
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
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
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
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
2d3921e3e4
Add instructions for manually installing pgroonga.
2016-09-17 09:23:54 -07:00
15331ad9fa
docs: Document invite-only streams are hidden from other users.
...
Fixes : #1756 .
2016-09-14 10:06:10 -07:00
cd0025f67f
docs: Update roadmap with recently completed projects.
2016-09-12 14:56:08 -07:00
b744a3a4d7
docs: Update changelog since 1.4.0 release.
2016-09-07 19:51:14 -07:00
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
91a1e8aebc
Add note about the email_password setting
2016-08-28 13:29:51 -07:00
65b884f44d
docs: Explain how to re-build the table of contents.
2016-08-27 11:30:57 -07:00
c8e37f30d2
docs: Add "Custom Apps" to "Subsystem Documentation".
2016-08-27 11:30:57 -07:00
f5a1923cbf
docs: Create "Custom Apps" document.
2016-08-27 11:30:57 -07:00
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
1d0ae8b11c
docs: Clarify that one should unpack in /root to install.
2016-08-26 11:56:12 -07:00
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
9001bebf2f
Move THIRDPARTY to docs/ subdirectory.
2016-08-25 20:02:42 -07:00
ce1777b0cb
Update update_realm view path and signature in the new feature tutorial.
2016-08-25 19:35:42 -07:00
7e4caf3a67
Release Zulip 1.4.
2016-08-25 10:49:00 -07:00
fba93cb494
scripts: rename deploy-zulip-from-git to reference upgrading.
2016-08-25 10:48:59 -07:00
7f445be23d
docs: Clean up headings for maintenance page.
2016-08-25 10:48:48 -07:00
54c5c989c9
docs: Fix some broken links in headings.
2016-08-25 10:41:00 -07:00
c0799a9d09
docs: Fix docs for upgrading from a git repository.
2016-08-25 10:40:51 -07:00
9839d93362
docs: Clean up duplicated content in development overview.
2016-08-25 10:40:51 -07:00
f6c4e46afe
docs: Move README.dev.md into ReadTheDocs.
...
Fixes : #669 .
2016-08-25 10:40:51 -07:00
d876909b69
docs: Clean up development environment headings.
2016-08-25 10:40:51 -07:00
30b5c2a4c0
docs: Document the fact that 14.04->16.04 is not supported.
2016-08-25 10:40:51 -07:00
f1a91c8028
docs: Document Zulip PPA is available for 16.04 as well.
2016-08-25 10:40:51 -07:00
c5417e723b
docs: Fix command sequence for retrying Zulip installation.
2016-08-25 10:40:51 -07:00
c0975b03a5
docs: Document Ubuntu 16.04 support in production.
2016-08-25 10:40:51 -07:00
c0e68d59cb
docs: Rename status/debug page to troubleshooting.
2016-08-25 09:37:33 -07:00
be4e806d60
docs: Collapse install steps 2 and 3 together.
2016-08-25 09:37:33 -07:00
cd632faff6
docs: Clean up scrollbar in install docs.
2016-08-25 09:37:33 -07:00
8a82c29d21
docs: Move SSL docs to a dedicated page.
2016-08-25 09:37:33 -07:00
8086cc549f
docs: Merge prod-auth-first-login into main installation page.
2016-08-25 09:37:33 -07:00
1d273b93da
docs: Move screenshots to their own page.
2016-08-25 09:37:33 -07:00
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
5a3db059d4
docs: Rewrite first time prod login docs to use new realm creation flow.
...
- Adds heading and reorganizes sections for improved clarity. Sections
now ordered: Create user, grant admin access, default realm settings,
changing realm settings, other manage.py commands, if you can't login.
- Adds screen shots of Zulip web interface.
2016-08-25 09:37:33 -07:00
a7ead9e99d
settings: Eliminate ADMIN_DOMAIN for creating initial realm.
...
We now use `./manage.py generate_realm_creation_link` as the flow flow
for creating one's first realm.
2016-08-25 09:37:33 -07:00
f7ede485d2
docs: Move subscribe step to start of install docs.
2016-08-24 21:04:10 -07:00
7d6541867b
docs: Update Let's Encrypt CertBot install instructions.
2016-08-24 19:02:22 -07:00
d09b07310d
docs: Clean up and clarify documentation flow.
2016-08-24 19:02:18 -07:00
456da49b06
docs: Expand production install docs.
...
- Moves Let's Encrypt option for ssl certs above self-signed option.
Updates Let's Excrypt instructions to user Certbot (new recommended
method). Fixes #1426 .
- Adds and updates headings for clarity.
- Adds new step 6 about configuring authentication (from
prod-auth-first-login.html).
- Adds emphasis on using `su zulip`, `sudo -u zulip -i`, and `sudo -i`
where appropriate. Fixes #1356 .
Fixes #1245 .
2016-08-24 19:02:11 -07:00
cd0ef4ae5b
prod-requirements: Remove unnecssary authentication section.
2016-08-24 16:34:00 -07:00
2c171df9b5
docs: Reorganize requirements page with server/credentials categories.
2016-08-24 16:32:06 -07:00
b90f5537b0
docs: Improve production requirements doc.
...
- Adds headings and organizes for greater clarity.
- Adds some detail about each of the requirements.
2016-08-24 15:14:18 -07:00
f1daf3d66a
docs: Make headings consistent and use the imperative.
2016-08-24 15:02:14 -07:00
48ba0e3974
docs: Improve 'upgrading' section of prod-maintain-secure-upgrade page.
...
- Reformats bullets as regular paragraphs for improved readability.
- Adds headings to subsections to make them easier to read and linkable.
- Clarifies minor points throughout.
2016-08-24 15:01:32 -07:00
36b6184be2
docs: Improve navigation of prod-customize page.
...
- Add headings for each of the six major sections: integrations, streams
and topics, notification settings, mobile and desktop apps, other
great features, and enjoy your Zulip installation.
- Add links to each of these sections to top of page, with first and
most important four formatted as a list.
2016-08-24 14:56:39 -07:00
58ee43c3f0
docs: Improve prod-health-check-debug page.
...
- Adds headings for 'supervisorctl' and 'troubleshooting'.
- Rearranges to include most important info at top: that Supervisor is
used, a reminder to review components architecture, log location, link
to troubleshooting services section, and a request to report any
issues not already documented on this page.
2016-08-24 14:52:44 -07:00
d4f0565c92
docs: Improve Zulip in Production page navigation and ToC.
...
Improves readability of ToC and makes pages more navigable by shortening
Zulip in Production page headings.
2016-08-24 14:48:11 -07:00
8782f6a198
docs: Improve navigation of prod-maintain-secure-upgrade page.
...
- Adds a heading for Upgrading and clarifies wording on Backups heading.
- Adds intro text with links to other sections.
2016-08-24 14:46:40 -07:00
7965320877
Update changelog for Zulip 1.4 release.
2016-08-24 14:26:53 -07:00
ba9e7e290d
frontend: Extract dispatch_normal_event().
...
Extract dispatch_normal_event() from the inner
function dispatch_event() in get_events_success()
in server_events.js. Also, alphabetize the cases in
the switch statement. This starts to address #1541 ,
but see the discussion on the ticket for how we can
continue to clean up our event dispatching.
2016-08-22 20:18:02 -07:00
fd6ee7117f
tests: Renamed AuthedTestCase to ZulipTestCase.
2016-08-22 19:07:44 -07:00
29ba10dfdd
docs: Add docs for Django backend tests.
2016-08-22 19:07:44 -07:00
95fbd5ba31
Update zulip.com/integrations link to point to zulipchat.com.
...
zulip.com will stop running at some point in the near future, and we
don't want these links to break.
2016-08-22 17:26:41 -07:00
602c7c69a9
lint: Document line length checking.
2016-08-19 12:08:22 -07:00
f6b332ecdb
docs: Add linters.md to document our linters.
...
(Also, link to it from the testing docs.)
2016-08-19 11:55:52 -07:00
479aa5b83d
docs: Split out Django/Casper/Node testing docs.
2016-08-18 14:10:46 -07:00
e1b5a0e000
docs: Add link to life of a request docs on URLs.
2016-08-18 12:41:38 -07:00
920e605e17
Add extensive views writing documentation.
...
[section on REQ substantially expanded by tabbott]
Fixes : #880 .
2016-08-18 12:37:33 -07:00
74cdb4954c
docs: Fix outdated security contact list.
2016-08-17 22:19:53 -07:00
f3abea0f1f
doc: Add version number to Trusty in prod requirements.
2016-08-16 16:24:34 -07:00
23aaca376e
doc: Recommend provision stream for install help.
...
Adds a recommendation to the developer installation
documentation suggesting visiting the "provision" stream.
Fixes : #1537 .
2016-08-16 16:22:20 -07:00
b839db1f45
Expand pointer and unread counts guide.
2016-08-16 16:17:54 -07:00
1a9f961bb4
doc: Add pointer and unread counts guide.
...
Tim's comments in #789 are useful to developers
in explaining message selection at browser load,
narrow, etc.
2016-08-16 16:15:38 -07:00
d606b95242
zulip_tools.py: Move zulip_tools.py in scripts/lib.
...
This commit moves zulip_tools.py as part of cleaning the root directory
and organizing proejct into better directory structure.
2016-08-15 16:44:50 -07:00
603352630b
export: Update conversion docs.
2016-08-13 09:36:08 -07:00
fd77585a8c
export: Add docs/conversion.md.
...
This is not hooked into anything yet. After this weekend's
conversion, it will probably be worthwhile to take a second pass
at it!
2016-08-12 15:10:49 -07:00
cdd03dec4d
Extract media queries to media.css.
...
Create `media.css` using media queries that had been at the bottom
of `zulip.css`, then update miscellaneous setttings/docs files.
I also add `.screen-medium-show` and `.screen-narrow-show` to
`media.css`, as they seem to be an important part of our
responsive design.
Fixes #1532 .
2016-08-05 10:32:55 -07:00
cf41629d80
docs: Fill gaps in New Feature Tuturial.
...
Adds some section headings, and provides a better example for the new
django migration system.
2016-08-04 16:02:08 -07:00
4c66bbc1ee
integration guide: Move Hello World walkthrough to end.
2016-08-04 15:59:49 -07:00
6cf6341a49
integration guide: Improve readability and navigation.
2016-08-04 15:59:48 -07:00
4cd28e5e1f
integration guide: Update Hello World walkthrough.
2016-08-04 15:59:28 -07:00
3fec3f122f
docs: Add missing annotation to conf.py.
2016-08-04 15:57:03 -07:00
4a7e6e852f
integration guide: Update documentation instructions.
2016-08-04 12:04:12 -07:00
6ab09064ac
integration guide: Increase visibility level of hello world guide.
2016-08-04 11:55:19 -07:00
613781f034
integration guide: Swap created files above updated files.
2016-08-04 11:53:05 -07:00
0691832817
docs: Document new WEBHOOK_INTEGRATIONS API.
2016-08-04 11:52:28 -07:00
5f37485e7f
docs: Improve integration guide link to writing documentation.
2016-08-04 11:49:17 -07:00
0e33b8bd4d
Add integrations library.
...
Define Integration and WebhookIntegration classes.
Change webhook part of integration's guide.
Replace hardcoded webhook urls to generating
based on WEBHOOKS list.
2016-08-04 11:39:20 -07:00
f0c6af2285
Describe events/initial state in new-feature-tutorial.md.
2016-08-04 09:45:37 -07:00
03f6cb4b3e
testing: Remove now-unnecessary istanbul install docs.
2016-08-04 09:43:05 -07:00
2d43431ad9
Advertise Electron app in documentation.
2016-08-02 16:41:24 -07:00
d97702ead6
De-duplicate testing docs.
...
Addresses comment in #1218 .
2016-08-02 19:26:59 -04:00
c95e6d4629
Recommend vagrant provision instead of vagrant reload.
...
Fixes #1520 .
2016-08-02 15:10:59 -07:00
b82230559c
docs: Document new deploy-zulip-from-git deployment process.
2016-08-02 14:31:07 -07:00
720e905150
docs: Fix heading levels in maintaining guide.
2016-08-02 14:31:07 -07:00
35cd0e122e
docs/maintaining: Switch markdown header format.
2016-08-02 14:31:07 -07:00
98ae0516d2
docs: Fix Fedora secondary links in generic installation.
2016-07-30 21:20:54 -07:00
b63d83538e
docs: Update manual install documentation for tsearch-extras.
...
* Suggest the PPA when possible.
* Use the `postgresql` meta package to avoid manually specifying version.
* Link to the upstream source code.
2016-07-30 21:16:56 -07:00
85859fb992
Add notes about JS unit test HTML output in testing.md.
2016-07-29 22:07:24 -07:00
31efecf03d
Add HelloWorld webhook integration + Walkthough.
...
Improves webhook integration docs and Hello World webhook. Includes
many suggested improvements from @timabbott and @tomaszkolek.
2016-07-29 21:38:40 -07:00
2053c746c1
docs: Document GitHubAuthBackend.
2016-07-29 15:05:24 -07:00
3b5629739d
docs: Cleanup typos and language in translating guide.
2016-07-29 14:49:51 -07:00
a45b28e0b8
Don't use sudo in commands to be run as root.
...
It's confusing as it implicitly sends the message that the commands are to be run as a non-root user.
2016-07-28 15:13:48 -07:00
c0e1e23941
Update copyright year in documentation.
2016-07-28 13:57:05 -07:00
f20f9ce8c8
Update casper testing documentation.
...
This adds a note that waitFor functions cannot be chained together if
the wait can cause race condition.
2016-07-28 13:55:27 -07:00
e515484c41
Fix typos in the documentation.
...
Pushing this now so as to not create merge conflicts with others working on
the prod docs.
2016-07-27 13:44:27 -07:00
df32750f88
docs: Add a bit of discussion of settings philosophy.
2016-07-25 11:43:41 -07:00
488cc547d2
docs: Expand discussion of settings secrets.
2016-07-25 11:43:41 -07:00
ed03619f95
docs/mypy.md: Document zerver/lib/type_debug.py.
2016-07-23 14:38:24 -07:00
2bcce28b07
changelog: Clean up some minor text issues.
...
Thanks @rishig for the review! I forgot to apply these before
merging.
2016-07-20 20:01:30 -07:00
568a2facce
docs: Fix links to troubleshooting guide.
2016-07-20 18:40:10 -07:00
827c015458
Updates Zulip dev setup for first-time contributors
...
Updates Zulip dev setup for first-time contributors as follows:
- Recommends and links to Vagrant version 1.8.4 (from 1.8.1)
- Consolidates Ubuntu 14.04 and Ubuntu 16.04 instructions since they are
now identical.
- Updates memory requirement to 2GB to address out of memory related
errors (see issue #1333 ).
Fixes #1288 .
2016-07-20 18:40:10 -07:00
9fb933d456
docs: Fix style issues in life-of-a-request.
2016-07-20 18:31:41 -07:00
6548f1dd1c
Factor out venv-installing code into a module.
...
Factor out the code in tools/provision.py which installs a python2
and python3 venv into a module (tools/setup/setup_venvs.py) which
can also be used as a script.
2016-07-20 18:20:37 -07:00
38bf0bf39b
Add Life of a Request doc ( #1302 )
...
This doc follows the different layers that Zulip uses
to handle a request, detailing parts of those layers that
would be most commonly interesting to developers.
2016-07-20 17:12:15 -07:00
f664d00fe8
Add python2 and python3 venv install instructions.
2016-07-20 14:18:51 -07:00
14143e2222
roadmap: Fix issue number for upgrading every dependency.
...
The previous issue number corresponded to just the work to move to a
virtualenv, not to actually upgrade the dependency versions.
2016-07-20 10:54:52 -07:00
f4ffae8685
docs: Update roadmap with completed projects, etc.
2016-07-20 10:28:35 -07:00
b96a10ec9a
Add draft changelog since Zulip 1.3.13 release.
2016-07-20 10:12:57 -07:00
35339f5117
Rename local_settings_template to prod_settings_template.
2016-07-19 20:59:59 -07:00
19b860ceec
Rename local_settings.py symlink to prod_settings.py.
2016-07-19 20:59:59 -07:00
6a90dc07dc
docs: Fix headings for possible testing issues.
2016-07-19 15:00:14 -07:00
d828ba5688
Move testing instructions to main test suite doc.
...
Also, improve links and headers in testing.md.
2016-07-19 14:57:07 -07:00
db6c9702c2
Update links in README and integration guide.
2016-07-19 14:57:07 -07:00
e98f24734c
Update developer install docs links and image embed.
...
Sphinx/RTD creates different anchor tags for subheadings than
Markdown does, and treats image embedding differently.
This commit updates hyperlinks to affected anchors,
and fixes an image embed for move to RTD.
2016-07-19 14:57:07 -07:00
5473b03e3b
Split out generic UNIX developer install doc.
2016-07-19 14:57:07 -07:00
9aba0f84a8
Split non-Vagrant Ubuntu install doc into topic page.
2016-07-19 14:57:07 -07:00
cf7b1af508
Split developer environment usage instructions into new page.
2016-07-19 14:57:07 -07:00
c40ffd9538
Split out docker setup doc.
2016-07-19 14:57:07 -07:00
97ff43e972
Move and rearrange vagrant instructions.
2016-07-19 14:57:07 -07:00
b95370f833
Move and rearrange developer setup instructions.
...
We aim to consolidate developer documentation on Read The Docs. As a
start, this commit turns the first part of README.dev.md into a topic
page within /docs/ , and links to it from the doc index.
See #669 .
2016-07-19 14:57:07 -07:00
4519efa266
Document frontend translation syntax.
...
Fixes : #1090
2016-07-18 13:59:07 -07:00
3869e6d008
Fix docs path in docs/README.md.
2016-07-18 12:03:18 -07:00
bf58c06f97
Link to migration-renumbering.html in schema-migrations.md
2016-07-18 12:02:50 -07:00
4f4092ecce
Add docs/migration-renumbering.md
2016-07-18 12:02:50 -07:00
d34000b211
prod install docs: Make minor fixes and edits.
2016-07-15 11:19:58 -07:00
4c8a0340ef
Update requirements docs with LetsEncrypt mention.
2016-07-12 22:15:01 -07:00
2338421c6d
lint: Add documentation lint check for JavaScript spelling.
2016-07-12 19:22:21 -07:00
8257701dc9
Fix formatting & capitalization in testing doc.
2016-07-12 19:14:31 -07:00
850d8d1181
Fix formatting, capitalization, & grammar in mypy doc.
2016-07-12 19:14:31 -07:00
491e98e457
docs: Document the fact that installer is idempotent.
2016-07-12 18:26:44 -07:00
6301fd22dc
docs: Turn SSO auth documentation into general auth page.
...
Also remove this page from the breadcrumb.
2016-07-12 16:19:13 -07:00
260baff4db
Move prod postgres details to separate page.
2016-07-12 15:46:10 -07:00
3a13cf1865
Move prod remote user SSO auth guide to new page.
2016-07-12 15:46:10 -07:00
bfa81a80ad
Move prod maintenance guide to new page.
2016-07-12 15:46:10 -07:00
76fea4f4d4
Move prod customization guide to new page.
2016-07-12 15:46:10 -07:00
07afc9d34b
Move production health check doc to separate page.
2016-07-12 15:46:10 -07:00
ec005726c4
Move prod auth and first login doc to new page.
2016-07-12 15:46:10 -07:00
7d092d2cc4
Move production install instructions to new page.
2016-07-12 15:46:09 -07:00
a10833f489
Simplify title for production requrements page.
2016-07-12 15:44:48 -07:00
3f90f9e29e
Move production installation requirements to separate page.
...
To begin the process of consolidating Zulip documentation on Read
the Docs, the requirements are now their own topic page, and
index.rst links to it.
Fixes : #669 .
2016-07-12 15:43:06 -07:00
2ece2192d9
Fix misspelling in HTML CSS documentation.
2016-07-12 14:15:23 -04:00
51239f225b
Mention build name in docs.
...
Mention in docs that tools/run-mypy and tools/check-py3k are run
in the 'static-analysis' build.
2016-07-11 21:28:01 -07:00
397da44744
Update documentaton to reflect Django-Pipeline==1.6.8.
2016-07-09 07:09:55 -07:00
c15695e514
Add support for running test-js-with-node on particular files.
...
Fixed : #1127 .
2016-07-07 14:32:07 -07:00
054d14bb96
Add documentation to announce default language setting.
2016-07-04 11:56:24 -07:00
fd7cb3fc2b
docs: Fix hardcoding of links to zulip.readthedocs.io.
...
This makes things work better if you're testing the documentation
locally.
2016-06-27 20:54:21 -07:00
31f7fb2fa0
docs: Fix new feature tutorial link to testing docs.
2016-06-27 20:52:20 -07:00
beb8b50623
Move provision.py under tools/.
2016-06-27 19:04:32 -07:00
879ca4b9ea
docs: Add documentation on HTML and CSS.
2016-06-27 12:38:53 -07:00
292556c846
docs: Expand RTD testing section.
2016-06-27 12:38:53 -07:00
f8c710b70e
Update documentation on development auto-reloading.
...
Now that queue workers auto-reload, we need to document that fact.
And we make a few tweaks to the relevant discussion, while we're at
it.
2016-06-26 20:20:13 -07:00
61d1de19cf
docs: Don't require typing module to be installed.
2016-06-26 10:10:59 -07:00
dc014b0866
docs: Add link to documentation building docs.
2016-06-26 10:04:07 -07:00
74c23d71e2
docs: Add details on viewing/editing these docs.
2016-06-26 10:04:06 -07:00
1838cd4d8f
docs: Split out version control guidelines.
2016-06-26 10:04:06 -07:00
96fef7a0a1
docs: Reorganize RTD table of contents.
2016-06-26 10:04:05 -07:00
9aea3cdc9b
docs: Add current Zulip release version to docs.
2016-06-26 10:03:56 -07:00
89b5eaaa7d
docs: Improve several headings.
2016-06-26 09:54:19 -07:00
149fd88733
docs: Add missing link in schema-migrations.md.
2016-06-26 09:54:19 -07:00
ea611c0dcd
docs: Add some full-text search documentation.
2016-06-26 09:32:54 -07:00
420ee968f7
Renumber the casper tests to make space for realm-creation test.
...
And also fix the mysterious gaps at 6 and 8.
2016-06-24 17:47:56 -07:00
85798e2b2c
Dramatically expand directory structure docs.
2016-06-23 14:01:54 -07:00
c8a1c3a86b
docs: Reorder directory structure doc.
2016-06-23 13:58:41 -07:00
b0e1ae4245
docs: Make directory structure headings linkable.
2016-06-23 13:58:41 -07:00
5a1a540377
Expand directory structure details on scripts.
2016-06-23 13:58:41 -07:00
c668f1e299
roadmap: Add strikethrough for completed projects.
2016-06-21 17:30:33 -07:00
4958828747
Add changelog for Zulip 1.3.13 release.
2016-06-21 16:59:48 -07:00
be70907eaa
Remove references to requirements.txt.
2016-06-21 07:48:24 -07:00
7370fd69d7
Move doc building dependencies to requirements/docs.txt.
2016-06-20 16:05:42 -07:00
ce5e7d3ba6
Make minor edits to new settings documentation.
2016-06-17 12:15:15 -07:00
b5e92f541a
Add new documentation on Zulip settings system.
...
Fixes : #962 .
2016-06-17 12:15:15 -07:00
14c4ff2d25
docs/code-style.md: Use ASCII spaces consistently.
...
At some places, '\xc2\xa0' was used instead of ' '. This characters looks
identical, but can hamper searches and lint checks.
2016-06-17 11:33:41 -07:00
07abfc189b
Update docs/README.md to reflect the current state of the world.
...
Fixes #1050 .
2016-06-17 11:30:22 -07:00
f18493f922
Add documentation about zerver/lib/str_utils.py.
2016-06-11 17:31:56 +05:30
85ef5900b4
docs/mypy.md: Add section on annotating strings.
2016-06-10 16:30:14 -07:00
c9ef726048
docs/mypy: Add note about Zulip's annotation goals.
2016-06-10 16:30:14 -07:00
a4c14cd448
Improve docs/mypy.md.
...
Add link to mypy cheat sheet.
Warn against modifying annotations to somehow make them pass on buggy code.
[Description expanded by tabbott]
2016-06-10 16:30:00 -07:00
45b1893284
Convert architecture overview from rST to md for consistency.
...
Fixes : #668 .
2016-06-04 22:27:00 -07:00
6f59683324
Fix and clarify architecture overview.
2016-06-04 22:27:00 -07:00
7057b2ae37
Add documentation for json_error and JsonableError.
...
Add documentation on how to make the strings passing through
json_error and JsonableError translatable.
2016-06-04 18:48:32 -07:00
8c2382deeb
De-duplicate three sections of architecture overview.
2016-06-03 12:56:31 -07:00
4a10923bf1
Add architectural overview documentation.
...
Fixes : #453 .
2016-06-03 11:54:02 -07:00
a45bde7822
Docs: Fix typos in docs.
2016-06-02 10:31:41 -07:00
c5b495b775
Update changelog with important changes since last release.
2016-05-31 11:39:47 -07:00
d056b5601b
docs: Add python-tyoing to RTD dependencies.
...
This should fix the RTD build having been broken since
d9c4be87d1
2016-05-31 11:19:49 -07:00
337155f280
Remove rST files to replace with Markdown.
...
Currently (https://github.com/rtfd/recommonmark/issues/3 )
the recommonmark bridge (which allows Sphinx to read
Markdown) does not support tables, so the directory structure
doc is now a bulleted list instead of a set of tables.
2016-05-31 10:55:49 -07:00
e0bc57ddb1
Rearrange docs table of contents for coherence.
...
The order and structure of the Read The Docs documentation
was fairly arbitrary; here's a suggestion for how to change
its information architecture so it's more useful to a new
contributor. This adds a short Zulip overview, and a table
of contents and code contribution intro for new contributors.
Fixes : #668 .
Signed-off-by: Sumana Harihareswara <sumanah@panix.com>
2016-05-31 09:07:09 -07:00
3029b3681f
Rearrange sections of testing doc for coherence.
2016-05-31 09:05:38 -07:00
f65778f1e2
Improve sub-headings in documentation.
...
Signed-off-by: Sumana Harihareswara <sumanah@panix.com>
2016-05-31 09:05:38 -07:00
86f7695b8c
Fix style, formatting in Bugdown docs.
2016-05-31 08:56:58 -07:00
ad644afa97
Improve code style guidelines.
2016-05-31 08:56:58 -07:00
3631cf3078
Add links in front end build process doc.
...
Signed-off-by: Sumana Harihareswara <sumanah@panix.com>
2016-05-31 08:56:58 -07:00
3ed78eb746
docs/testing: Clean up discussion of rebuilding database.
2016-05-31 07:48:00 -07:00
e06492ec3a
Improve first-time contributor docs.
...
Fixes #747 . Fixes #748 .
This updates README.dev.md to include clear, step-by-step instructions
for setting up the Zulip dev environment Windows 10, OS X El Capitan,
Ubuntu 14.04 Trusty, and Ubuntu 16.04 Xenial. It is aimed at first-time
contributors.
I tested these instructions multiple times on each of the target
systems.
Also added is a "trobleshooting and common errors" section which
documents the most common errors contributors are likely to encounter
during setup and how to fix them.
Improvements based on feedback from @timabbott.
- Fixes whitespace issues so linter will pass.
- Updates memory requirement.
- Re-orders so operating systems are listed alphabetically.
- Updates headings to be clearer.
- Updates and adds ToC entries for clarity.
- Adds screen shot of Zulip dev environment running in browser.
- Adds details about using dev environment, including about logging.
- Misc other minor changes for clarity.
- Adds a stub for docs/logging.md
- Adds details about configuring Cygwin for native symlinks.
2016-05-31 07:47:45 -07:00
1b59b6826a
docs/code-style.rst: Update and clarify shebang rules.
2016-05-29 05:07:50 -07:00
149938d468
Change shebangs from python2.7 to python.
2016-05-29 05:03:08 -07:00
dc060248b4
Add instruction to check screenshot of failed tests.
2016-05-28 23:27:24 +05:30
31968f668c
Correct frontend_test script path.
2016-05-28 23:23:39 +05:30
d9c4be87d1
Make docs/conf.py pass mypy check.
2016-05-25 15:04:39 -07:00
82b5d9304b
[third] Integrate i18next with Handlebars
2016-05-19 22:58:25 -07:00
f9bbc5d6ff
Enable i18n support in URL configuration.
...
This supports i18n using all of the following:
- I18N urls
- Session
- Cookie
- HTTP header
2016-05-19 08:33:30 -07:00
b38913c8f9
Upgrade sphinx version used in ReadTheDocs.
...
According to https://github.com/spatialaudio/nbsphinx/issues/26 , this
should fix support for mixing rST and markdown in our docs.
Fixes #668 .
2016-05-14 14:27:21 -07:00
60722a8fce
Integration guide: Add a note about spelling integraiton names.
2016-05-11 21:19:15 -07:00
eeeb4d0c92
Add CircleCI integration.
...
Fixes : #617 .
2016-05-11 21:17:37 -07:00
92bec8cfea
Merge Zulip 1.3.12 security release.
2016-05-10 11:32:26 -07:00
0d324925b5
Add documentation on translation tags.
...
[substantially modified by tabbott]
2016-05-09 09:55:18 -07:00
5359e6b0d4
Convert Zulip to use Jinja2 templates.
...
This results in a substantial performance improvement for all of
Zulip's backend templates.
Changes in templates:
- Change `block.super` to `super()`.
- Remove `load` tag because Jinja2 doesn't support it.
- Use `minified_js()|safe` instead of `{% minified_js %}`.
- Use `compressed_css()|safe` instead of `{% compressed_css %}`.
- `forloop.first` -> `loop.first`.
- Use `{{ csrf_input }}` instead of `{% csrf_token %}`.
- Use `{# ... #}` instead of `{% comment %}`.
- Use `url()` instead of `{% url %}`.
- Use `_()` instead of `{% trans %}` because in Jinja `trans` is a block tag.
- Use `{% trans %}` instead of `{% blocktrans %}`.
- Use `{% raw %}` instead of `{% verbatim %}`.
Changes in tools:
- Check for `trans` block in `check-templates` instead of `blocktrans`
Changes in backend:
- Create custom `render_to_response` function which takes `request` objects
instead of `RequestContext` object. There are two reasons to do this:
1. `RequestContext` is not compatible with Jinja2
2. `RequestContext` in `render_to_response` is deprecated.
- Add Jinja2 related support files in zproject/jinja2 directory. It
includes a custom backend and a template renderer, compressors for js
and css and Jinja2 environment handler.
- Enable `slugify` and `pluralize` filters in Jinja2 environment.
Fixes #620 .
2016-05-09 09:55:18 -07:00
635828069f
Add feature to mark all in stream/topic as read with mouse.
...
Fixes #736 .
2016-05-08 09:02:46 -07:00
34fb276b7b
changelog: Add some items since the last release.
2016-05-07 20:34:14 -07:00
c5a44043a8
Cleanup changelog.md to be better documentation.
2016-05-07 20:34:06 -07:00
1c24cb32a5
Move changelog.md to docs/ and add to ReadTheDocs.
2016-05-07 20:26:44 -07:00
e5e133eccc
Update docs to reflect the elimination of /bin.
2016-05-07 19:37:06 -07:00
d20791eb6a
docs/new-feature-tutorial: Fix typos in templates path.
2016-05-07 17:37:01 -07:00
f06c8c7cc2
Update *.readthedocs.org => *.readthedocs.io.
...
ReadTheDocs has moved their hosting of user project websites to the
new readthedocs.io domain.
2016-04-29 16:00:08 -07:00
362a622f1f
Add documentation on translating Zulip.
2016-04-28 21:57:10 -07:00
27b8e8b294
Add the Zulip 2016 roadmap document.
2016-04-28 21:55:33 -07:00
b60141fd84
Add documentation on the using the mypy static type checker.
...
[with substantial tweaks by tabbott]
2016-04-28 12:29:45 -07:00
22d407fe0b
docs/testing.rst: Fix typo and name of a package.
...
* Remove duplicate words.
* Replace `futurize` by `future`.
2016-04-28 15:19:22 +05:30
abacd9b2da
Integration guide: Document need to edit urls.py.
2016-04-26 11:50:19 -07:00
672a431fba
Expand documentation on tools/check-py3.
2016-04-25 16:46:46 -07:00
ae46d425b6
Add info about tools/check-py3 in docs/testing.rst.
...
Fixes #701 .
2016-04-26 03:32:29 +05:30
101148c49e
Fix typo and formatting in docs.
2016-04-25 20:29:29 +05:30
74ed9fabd0
Integration guide: Expand instructions on screenshots.
2016-04-21 18:17:26 -07:00
82f1cdb085
Add send_webhook_fixture_message command.
...
This tool simplifies the process of producing nice screenshots for
documenting webhook integrations.
Fixes #658 .
2016-04-20 10:45:27 -07:00
1b988de30a
Integration guide: clean up description of plugin integrations.
2016-04-19 16:21:33 -07:00
92f9a789b8
integration guide: Improve introduction.
2016-04-19 16:21:33 -07:00
4ce4f88a03
Fix formatting in directory-structure.rst.
2016-04-13 15:44:10 -07:00
be96cf809d
Move Zulip backend tests to zerver.tests.
2016-04-11 22:16:09 -07:00
5c810ad0bc
Add new markdown documentation to ReadTheDocs.
2016-04-01 14:57:30 -07:00
52764763c6
Add some docs on schema migrations.
2016-04-01 09:57:00 -07:00
37b79deb60
Expand documentation on frontend build process.
2016-04-01 09:56:59 -07:00
7a671c2652
Add documentation on the Zulip RabbitMQ queues.
2016-04-01 09:56:59 -07:00
96eb81e5d5
Add documentation of Zulip's markdown implementation.
2016-04-01 09:56:59 -07:00
342b4eb457
Add a detailed integration writing guide.
...
Fixes : #70 .
2016-04-01 09:56:59 -07:00
b8c7cfb77e
docs: Add Javascript manual testing section.
2016-04-01 09:34:45 -07:00
2fe0700f55
Update memcache -> remote cache in inline documentation.
2016-03-31 12:56:42 -07:00
02ccb68f7e
code style: Document auto-closing GitHub issues.
2016-03-19 10:17:25 -07:00
ecc66d6eec
code style: Improve the commit message style documentation.
2016-03-19 10:09:21 -07:00
d72b8b83f7
Fixed a typo in documentation.
2016-03-17 22:53:42 -07:00
408ff14be8
Fix parsing html_unescape.py in py3k test.
...
This file was using print as a function but didn't import
print_function; as a result futurize threw an error every time it
parsed this file.
2016-01-09 15:43:30 -08:00
11c69fb0b2
Add documentation on the front end build process and webpack.
2015-11-20 20:32:01 -08:00
d06cb5d55a
Expand documentation on writing and debugging Casper tests.
2015-11-11 21:36:00 -08:00
10657c1d53
Move node tests to node_tests/.
2015-10-28 10:11:47 -07:00
f1074aa491
Move frontend tests out of zerver/tests/.
...
This fixes an unfortunate bug where the backend tests in
zerver/tests.py were not being run automatically, and also makes these
a bit easier to find.
2015-10-28 10:11:47 -07:00
d5435fad1d
Consistently use /usr/bin/env python2.7 in shebangs and commands.
2015-10-21 22:58:21 +00:00
99a2ba38b1
Expand new feature tutorial.
2015-10-15 09:12:22 -04:00
5bf6f05f60
Add readthedocs requirements.txt.
2015-09-25 10:53:47 -07:00
b21a105a99
Reorganize and delete obsolete content from testing.rst.
...
(imported from commit 1d62b50c0b01d5386c8a6ffbde745abb6d79ad6e)
2015-09-25 03:40:31 -07:00
827e7ad19c
docs: Cleanup new feature tutorial and note unfinished.
...
(imported from commit 668eabb53f746afe7455b0f5fd1e8f5741894c5e)
2015-09-22 22:38:55 -07:00
a3c122eb41
Remove largely obsolete documentation pages.
...
(imported from commit eb02c24dd25a12a5676b5e52c914993650f73aa6)
2015-09-22 22:37:45 -07:00
1be909a450
docs: Content editing for directory-structure.rst.
...
(imported from commit aa331a561f1e905c9453bd0590eb1147c19f2be4)
2015-09-22 22:17:56 -07:00
3c1c14a7cc
docs: Fixed a bunch of factual issues in coding style guidelines.
...
(imported from commit 6320d45ad064fcc5b3e8f01247b18af1a85bf91f)
2015-09-22 22:13:28 -07:00
b6e2fd6e83
Rename build-voyager-tarball to build-release-tarball and document.
...
(imported from commit 06f102f4f4c5caf187f4930fadff06147f095401)
2015-09-22 21:22:11 -07:00
ab5e04ef36
Add backend tests location
...
(imported from commit 2f2dcd1773be746bee5d9003ca99020230acae04)
2015-08-22 13:08:11 -07:00
e130884c6a
code-style: Simplify rST syntax.
...
(imported from commit c2bd43f97969b7be61476435ac00ae03fd05ec4d)
2015-08-22 13:08:07 -07:00
c17e50e0c4
Add new feature tutorial.
...
(imported from commit 1577c2567232aba1a1f1c6d1df83370acf54af55)
2015-08-22 12:56:57 -07:00
a9cf471239
Remove documentation on ALLOW_REGISTER since it is out of date.
...
(imported from commit 75938998507f2b903f49bd9c7c4ecc0eadb3259d)
2015-08-22 12:55:18 -07:00
33b7b2d021
Add welcome.rst with info for new developers.
...
(imported from commit 14e27efc47cfb0802f16ec5d2d6c5eadeba7a2c2)
2015-08-22 12:54:20 -07:00
1a3bc517d9
Improve docs/README.md
...
(imported from commit 78193958bdb5f92ae5d8706340a739dae0da5367)
2015-08-22 12:53:54 -07:00
3f7cb34b00
enterprise => voyager
...
(imported from commit 04be792bb480d5e5db1c91d296d1000cf1682571)
2015-08-21 10:33:35 -07:00
f79adf830f
deployed => production
...
(imported from commit 2d7b0a7a73b0c84b32634a88af1e0d666139d4ff)
2015-08-21 10:33:35 -07:00
f78abd2dcc
Update schema changes content and formatting.
...
(imported from commit 46f3d43bfe62883d490ea870b2d29f7a45397c08)
2015-08-20 14:24:59 -07:00
4a6e132a44
Add "Schema changes", rST generated via pandoc -r mediawiki -w rst
...
(imported from commit f3c5621a8b612217986c879d3d15b85c9098ccca)
2015-08-20 14:24:59 -07:00
1e3249c94e
Add note that provision.py sets up postgres test db for you
...
(imported from commit 87d31b04db15b8ea994f40362ab910ccc028c91a)
2015-08-20 14:21:55 -07:00
a1237aa2b2
Update testing notes formatting and content.
...
(imported from commit 44cc34888f14d101c29bcd1c8d63cc082b4ffe09)
2015-08-20 14:21:55 -07:00
bb45f8d8e3
Copy "Testing the app" from the wiki, via pandoc -r mediawiki -o rst
...
(imported from commit 7150179ff1008ffa6849b983fb579a36fffc9c06)
2015-08-20 14:21:55 -07:00
6e55b4df8a
Update directory-structure.rst content to fix internal references
...
- Delete references to zilencer
- Replace "local server" references
- Add directories for message views, frontend templates/tests, and docs
(imported from commit 7295835434c17609595399e3aec7f9d565fd6b3d)
2015-08-19 11:52:49 -07:00
1629e77174
Directory structure generated from pandoc, with formatting fixes
...
(imported from commit d54bb062b641bac0520494f0a2cb151d69018d61)
2015-08-19 11:52:49 -07:00
127cdf63c6
Add CSS style override for RTD to make tables use word wrapping
...
(imported from commit 29007c052dd7048eaf86388a6a9715fc13f102b5)
2015-08-19 11:52:49 -07:00
ef50e74873
Fix up rST formatting in code-style.rst.
...
- Make all code blocks look like code blocks.
- Eliminate nested inline formatting (rST doesn't support it:
http://docutils.sourceforge.net/FAQ.html#is-nested-inline-markup-possible ).
- Punctuation nits.
(imported from commit cd0d780d843b72065678e0f032a2a47d44836adc)
2015-08-18 20:17:47 -07:00
7b9e027e77
Expand the Lint section to replace the Python and JS subsections; remove obsolete comment from Secrets.
...
(imported from commit a6945617913700d4e18c398a68022ed90f56039e)
2015-08-18 20:17:47 -07:00
8461048a11
Add 'Code style', generated via pandoc -r mediawiki -w rst and html_unescape.py
...
With a basic README.md
(imported from commit 91728b2c591bc88b7bee520669cb0b3f53426cd8)
2015-08-18 17:34:02 -07:00
c25d9679a5
Utility for unescaping HTML entities leftover from MediaWiki->rST conversion
...
(imported from commit 2f2507f299c3d09c67bfd26d6c11fab47431d935)
2015-08-18 17:31:33 -07:00
16e462d9d2
Use sphinx_rtd_theme when not on ReadTheDocs
...
(imported from commit ba97a475f85251f694e4c88d1dd25eaf69078fc4)
2015-08-18 17:31:32 -07:00
ac63d942ce
Initial sphinx setup from sphinx-quickstart
...
(imported from commit b9fc7a8f2f9352129c104f5dc9305203f2efc63d)
2015-08-18 17:31:32 -07:00
Tim Abbott
zeddmaxx
Bertrand Croq
Steve Howell
Rishi Gupta
Tomasz Kolek
sonali0901
Sahil Dua
umkay
Eklavya Sharma
neurodynamic
Kouhei Sutou
Rag Sagar
Christie Koehler
Vishnu Ks
acrefoot
Tim Abbott
Sumana Harihareswara
Taranjeet Singh
Tomasz Kolek
Reid Barton
Umair Khan
acrefoot
Preston Hansen
Ryan Moore
Anindya Chakravarti
Allie Jones
Steven Oud
Tim Abbott
Yoyo Zhou
David Roe