Tim Abbott
3fec3f122f
docs: Add missing annotation to conf.py.
2016-08-04 15:57:03 -07:00
Tim Abbott
4a7e6e852f
integration guide: Update documentation instructions.
2016-08-04 12:04:12 -07:00
Tim Abbott
6ab09064ac
integration guide: Increase visibility level of hello world guide.
2016-08-04 11:55:19 -07:00
Tim Abbott
613781f034
integration guide: Swap created files above updated files.
2016-08-04 11:53:05 -07:00
Tim Abbott
0691832817
docs: Document new WEBHOOK_INTEGRATIONS API.
2016-08-04 11:52:28 -07:00
Tim Abbott
5f37485e7f
docs: Improve integration guide link to writing documentation.
2016-08-04 11:49:17 -07:00
Tomasz Kolek
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
Steve Howell
f0c6af2285
Describe events/initial state in new-feature-tutorial.md.
2016-08-04 09:45:37 -07:00
Tim Abbott
03f6cb4b3e
testing: Remove now-unnecessary istanbul install docs.
2016-08-04 09:43:05 -07:00
Sumana Harihareswara
2d43431ad9
Advertise Electron app in documentation.
2016-08-02 16:41:24 -07:00
Sumana Harihareswara
d97702ead6
De-duplicate testing docs.
...
Addresses comment in #1218 .
2016-08-02 19:26:59 -04:00
Christie Koehler
c95e6d4629
Recommend vagrant provision instead of vagrant reload.
...
Fixes #1520 .
2016-08-02 15:10:59 -07:00
Tim Abbott
b82230559c
docs: Document new deploy-zulip-from-git deployment process.
2016-08-02 14:31:07 -07:00
Tim Abbott
720e905150
docs: Fix heading levels in maintaining guide.
2016-08-02 14:31:07 -07:00
Tim Abbott
35cd0e122e
docs/maintaining: Switch markdown header format.
2016-08-02 14:31:07 -07:00
Tim Abbott
98ae0516d2
docs: Fix Fedora secondary links in generic installation.
2016-07-30 21:20:54 -07:00
Tim Abbott
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
Steve Howell
85859fb992
Add notes about JS unit test HTML output in testing.md.
2016-07-29 22:07:24 -07:00
Christie Koehler
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
Tim Abbott
2053c746c1
docs: Document GitHubAuthBackend.
2016-07-29 15:05:24 -07:00
Tim Abbott
3b5629739d
docs: Cleanup typos and language in translating guide.
2016-07-29 14:49:51 -07:00
Reid Barton
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
Sumana Harihareswara
c0e1e23941
Update copyright year in documentation.
2016-07-28 13:57:05 -07:00
Umair Khan
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
Rishi Gupta
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
Tim Abbott
df32750f88
docs: Add a bit of discussion of settings philosophy.
2016-07-25 11:43:41 -07:00
Tim Abbott
488cc547d2
docs: Expand discussion of settings secrets.
2016-07-25 11:43:41 -07:00
Eklavya Sharma
ed03619f95
docs/mypy.md: Document zerver/lib/type_debug.py.
2016-07-23 14:38:24 -07:00
Tim Abbott
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
Tim Abbott
568a2facce
docs: Fix links to troubleshooting guide.
2016-07-20 18:40:10 -07:00
Christie Koehler
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
Tim Abbott
9fb933d456
docs: Fix style issues in life-of-a-request.
2016-07-20 18:31:41 -07:00
Eklavya Sharma
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
acrefoot
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
Eklavya Sharma
f664d00fe8
Add python2 and python3 venv install instructions.
2016-07-20 14:18:51 -07:00
Tim Abbott
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
Tim Abbott
f4ffae8685
docs: Update roadmap with completed projects, etc.
2016-07-20 10:28:35 -07:00
Tim Abbott
b96a10ec9a
Add draft changelog since Zulip 1.3.13 release.
2016-07-20 10:12:57 -07:00
Tim Abbott
35339f5117
Rename local_settings_template to prod_settings_template.
2016-07-19 20:59:59 -07:00
Tim Abbott
19b860ceec
Rename local_settings.py symlink to prod_settings.py.
2016-07-19 20:59:59 -07:00
Tim Abbott
6a90dc07dc
docs: Fix headings for possible testing issues.
2016-07-19 15:00:14 -07:00
Sumana Harihareswara
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
Sumana Harihareswara
db6c9702c2
Update links in README and integration guide.
2016-07-19 14:57:07 -07:00
Sumana Harihareswara
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
Sumana Harihareswara
5473b03e3b
Split out generic UNIX developer install doc.
2016-07-19 14:57:07 -07:00
Sumana Harihareswara
9aba0f84a8
Split non-Vagrant Ubuntu install doc into topic page.
2016-07-19 14:57:07 -07:00
Sumana Harihareswara
cf7b1af508
Split developer environment usage instructions into new page.
2016-07-19 14:57:07 -07:00
Sumana Harihareswara
c40ffd9538
Split out docker setup doc.
2016-07-19 14:57:07 -07:00
Sumana Harihareswara
97ff43e972
Move and rearrange vagrant instructions.
2016-07-19 14:57:07 -07:00
Sumana Harihareswara
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