Commit Graph

695 Commits

Author SHA1 Message Date
Christie Koehler
3913db9022 docs: Simplify hierarchy of dev setup docs.
Based on feedback from first-time contributors, this commit simplifies
the number of paths available for finding the dev setup directions you
need. Setup instructions are now organized into Recommended (Vagrant)
and Advanced (non-Vagrant).

In order to get the ToC to display correctly, I've combined all the
advanced, non-Vagrant methods into one page. I've left the old pages
intact, with a note that the content has been moved and link to the new
page. This is in case folks have linked directly to those pages.

The advanced setup directions still need to be cleaned up, but this is a
start.
2016-11-29 14:13:09 -08:00
Umair Khan
cd19a3d870 docs: Fix manual installation instructions.
The previous version didn't correctly handle permissions around the
virtualenvs.
2016-11-29 08:56:20 -08:00
Christie Koehler
f036a59b4f Move details about configuring a proxy. 2016-11-27 17:06:41 -08:00
Christie Koehler
8b67210ce5 Simplify dev env setup overview. 2016-11-27 16:58:19 -08:00
Stanley Zheng
b162969841 docker: Revert Docker development to original instructions.
There were issues with reproducing the Docker build with the latest
docker file and instructions.
2016-11-27 10:15:37 -08:00
Tim Abbott
3d1bcb05e1 tornado: Move event_queue.py to zerver/tornado/.
Fixes #729.
2016-11-26 22:29:28 -08:00
Tim Abbott
1fcf2ff525 tornado: Move zerver.tornadoviews to zerver.tornado.views.
This furthers the overall goal of moving all the Tornado-specific code
to zerver/tornado/.
2016-11-26 22:29:28 -08:00
Tim Abbott
a28b20b845 docs: Improve documentation around re-provisioning.
Fixes #1967.
2016-11-26 19:21:18 -08:00
Tim Abbott
4f98b73d5e requirements: Document anti-recommendation of t2 style instances.
If your instance runs out of CPU credits, it will result in a nasty
outage.

Fixes #1605.
2016-11-26 19:06:45 -08:00
Michael Cordover
4047c7d3c4 docs: Add code of conduct. 2016-11-26 18:40:16 -08:00
Zev Benjamin
f66e12ac4d docs: Minor developer documentation improvements.
Fixes #2424.
2016-11-26 14:47:16 -08:00
Anders Kaseorg
207cf6302b Always start python via shebang lines.
This is preparation for supporting using Python 3 in production.

Signed-off-by: Anders Kaseorg <andersk@mit.edu>
2016-11-26 14:46:37 -08:00
Steve Howell
c0f2cebe0c docs: Add initial guide to manual testing.
With a few small tweaks by tabbott.
2016-11-26 13:05:25 -08:00
Stanley Zheng
26be74c72c docs: Add additional docker commands and documentation cleanup.
With some tweaks by tabbott to fix ordering issues.
2016-11-26 11:17:00 -08:00
Tim Abbott
5896e610cb docs: Fix apt-add-repository arguments in manual instructions. 2016-11-21 12:25:40 -08:00
Tim Abbott
5283c0eef5 docs: Fix generate_secrets.py arguments for manual install. 2016-11-21 12:23:47 -08:00
tonynater
70abbf76fc dev-remote: Edit Setting Up Development Environment docs.
Added sentences which explain each installation option.
2016-11-21 04:44:36 -08:00
tonynater
a5e0d9cd5c docs: Reorder sections and add details to remote-dev docs.
This reorders the sections such that setting up the development
environment and making sure it runs comes before editing the
code. Also added some clarifying sentences to give context to bullets.
2016-11-21 04:44:02 -08:00
Alex Dehnert
65ad144c6c dev-remote: Fix typos (you->your). 2016-11-20 13:28:12 -08:00
Pweaver (Paul Weaver)
b986cf9c41 docs: add a tutorial for setting up a remote dev environemnt 2016-11-20 12:38:14 -08:00
Christie Koehler
b088c08777 Add detail about how to report issues and ask for help. 2016-11-20 11:38:16 -08:00
Christie Koehler
a0635d65c1 Add note about Vagrant 1.8.7 curl issue. 2016-11-20 11:12:17 -08:00
Alex Dehnert
c07298b8a3 docs: Don't include zulip.readthedocs.io in internal links
Two reasons not to use such links:
- when making doc changes, if you follow links in your local build, they can
  cause you to silently end up no longer reading your local changes
- they can cause you to randomly switch between http:// and https://
2016-11-19 10:16:38 -08:00
Alex Dehnert
4d474b649f docs: Fix broken markdown syntax. 2016-11-19 10:16:32 -08:00
Tim Abbott
2d81813145 roadmap: Add buddy list scalability to agenda. 2016-11-18 15:58:08 -08:00
Tim Abbott
e302e2148b docs: Update incorrect links to issues in roadmap docs. 2016-11-18 15:55:02 -08:00
Tim Abbott
bbdd0ec08d roadmap: The realm filters feature is merged. 2016-11-17 17:15:17 -08:00
Vladislav Manchev
d7e1e4a2c0 Add initial implementation of custom realm filters.
This PR was abandoned by Vladislav and then substantially modified by
Igor Tokarev and Tim Abbott to complete it and fix a number of bugs.

Fixes #544.
2016-11-17 17:11:25 -08:00
Tim Abbott
6d4075cef9 docs: Extend our documentation of our documentation.
The main purpose of this effort is to document our new /help/ docs,
but we update a bunch of other stuff while we're at it.
2016-11-15 22:01:44 -08:00
Feorlen
d56272a162 docs: Explain how the HTML webhook documentation is used.
Part of #1998.
2016-11-15 21:00:16 -08:00
Feorlen
e45c10884e docs: Fix typo and whitespace. 2016-11-15 21:00:16 -08:00
Feorlen
d8afc306ee docs: Clarify that HelloWorldHookTests is subclassing WebhookTestCase.
Part of #1998.
2016-11-15 21:00:15 -08:00
Feorlen
ed61d3086d docs: Describe what an API key is and how to get one.
Part of #1998.
2016-11-15 20:59:43 -08:00
Feorlen
113b2b39fb docs: Describe what a test fixture is.
Part of #1998.
2016-11-15 20:59:39 -08:00
Feorlen
4725a7b7de docs: Describe what a webhook is.
Part of #1998.
2016-11-15 20:58:39 -08:00
Tim Abbott
86fbc415b9 docs: Fix typo in roadmap reactions item. 2016-11-15 12:27:27 -08:00
Tim Abbott
0145987fbe Update roadmap introduction section of roadmap. 2016-11-15 09:55:30 -08:00
Sumana Harihareswara
e1f7b94bf5 Roadmap doc: Update intro date. 2016-11-15 09:55:30 -08:00
Sumana Harihareswara
bef4fc94d3 Roadmap doc: Update desktop app section. 2016-11-15 09:55:30 -08:00
Sumana Harihareswara
3ca3668885 Roadmap doc: Update security, testing, & docs sections. 2016-11-15 09:55:30 -08:00
Sumana Harihareswara
b06db1e776 Roadmap doc: Remove tasks we've already done. 2016-11-15 09:55:30 -08:00
Sumana Harihareswara
1c68436465 Roadmap doc: Update technology improvement section. 2016-11-15 09:55:30 -08:00
Sumana Harihareswara
e0a1e401f6 Roadmap doc: Update realtime sync, performance, and scalability tasks.
Also move and update community, internationalization, and
development environment tasks.
2016-11-15 09:55:30 -08:00
Sumana Harihareswara
b54aa2e415 Roadmap doc: Update onboarding and administration tasks. 2016-11-15 09:55:30 -08:00
Sumana Harihareswara
eba34309dc Roadmap doc: Update user experience and social tasks. 2016-11-15 09:55:30 -08:00
Sumana Harihareswara
98e5f502d3 Roadmap doc: Update mobile tasks. 2016-11-15 09:55:30 -08:00
Sumana Harihareswara
9799da1fc2 Roadmap doc: Update internationalization section. 2016-11-15 09:55:30 -08:00
Sumana Harihareswara
0c9ed70a8d Roadmap doc: Update integrations section. 2016-11-15 09:55:30 -08:00
Sumana Harihareswara
43f77a37a4 Roadmap doc: Update number of PRs merged. 2016-11-15 09:55:30 -08:00
Tim Abbott
151267edf6 Roadmap: Make several more things as finished. 2016-11-11 16:24:20 -08:00