Mirror
/
zulip
mirror of https://github.com/zulip/zulip.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
20,381 Commits 28 Branches 143 Tags 606 MiB
Commit Graph

89 Commits

Author SHA1 Message Date
Vaida Plankyte b6da398e17 docs: Add bug report guidelines. 2017-08-09 11:38:46 -07:00
Jack Zhang 4ba5b2f364 docs: Create hotspots subsystem documentation. 2017-08-05 18:32:37 -07:00
Greg Price 76b62620d9 docs: Add a "production" overview page. 
This pulls together what's covered in detail in several
longer pages, and gives us a page that can serve as a good
drop-in replacement for https://zulip.org/server.html .

Also tweak a couple of related bits for clarity and orthography.
 2017-07-27 21:44:58 -07:00
Tim Abbott 7abcc1b274 docs: Add a brief document explaining management commands. 
Fixes #1330.
 2017-07-27 18:00:53 -07:00
Eeshan Garg 9a992ec4c7 docs: Add documentation guide for integrations and webhooks. 2017-07-03 20:09:34 -04:00
Vaida Plankyte 72d126ab78 docs: Change GCI links to point to main repo. 2017-06-22 09:30:28 -04:00
Vaida Plankyte b02b49ca4e docs: Add screenshot-and-gif-software.md and link to it. 2017-06-19 07:52:07 -04:00
Rishi Gupta ed8e95f0dd docs: Add documentation of our email system. 2017-06-11 08:27:12 -05:00
Feorlen 7124098a8e Explain how to add Swagger REST API doc coverage in zulip.yaml. 
Introduce Swagger UI and the Swagger/OpenAPI specification. Explain
the structure of zulip.yaml and show examples of different sections
of the file.

This is a new file in /docs not yet included in the Read the Docs
table of contents. Where it should go should be determined as we iterate
on the Swagger UI integration and expand REST API doc coverage using it.

For more on Swagger UI and how Zulip uses it, see:
https://github.com/zulip/zulip/issues/3474
https://github.com/zulip/zulip/pull/3397

With some minor tweaks to advertise this by tabbott.
 2017-06-07 22:46:20 -07:00
Tim Abbott 2215af4b57 docs: Add a bunch of documentation on Travis CI. 2017-06-06 13:39:51 -07:00
Eeshan Garg 32786802b0 docs: Document the release process for the Zulip API PyPI package. 2017-06-02 17:08:00 -07:00
derAnfaenger 735aa9f2c6 Rename misleading 'system-docs' reference. 2017-05-28 22:21:13 -07:00
derAnfaenger c0f0dabec6 Rename misleading 'code-docs' reference. 2017-05-28 22:21:13 -07:00
derAnfaenger 7f6b6fae26 Rename misleading 'tutorial-docs' reference. 2017-05-28 22:21:13 -07:00
derAnfaenger f6c59a483c docs: Rename misleading 'dev-install-docs' reference. 2017-05-28 22:21:13 -07:00
derAnfaenger 54a618b597 docs: Rename misleading 'prod-install-docs' reference. 2017-05-28 22:21:13 -07:00
derAnfaenger 9c0ba87b5e docs: Rename misleading 'user-docs' reference. 2017-05-28 22:21:13 -07:00
Jeremy Bowman cdb4d9852b Add accessibility documentation. 2017-05-22 18:46:02 -07:00
Tim Abbott a2f5d133e8 docs: Document the push notification forwarding service. 2017-05-18 13:39:58 -07:00
Eeshan Garg c388baa431 docs: Document zerver.models.Client's usage for analytics and webhooks. 2017-05-01 23:50:51 -07:00
Tim Abbott 2a5269baa9 docs: Document the frontend hashchange system. 2017-03-22 15:21:36 -07:00
Cynthia Lin ccbe0b56c3 docs: Document zulipbot and its usage. 
Tweaked by tabbott to document why we need it.

Fixes #3771
 2017-03-04 17:44:43 -08:00
Rishi Gupta 42fc317262 developer docs: Add doc for analytics subsystem. 2017-02-22 22:12:40 -08:00
Tim Abbott 35ab9de53c docs: Document chat.zulip.org. 2017-02-12 16:57:11 -08:00
Tim Abbott 92219aa3dd docs: Add a long document explaining the events system. 
This is probably one of Zulip's most important systems, and thus worth
documenting carefully.
 2017-02-10 01:17:15 -08:00
Feorlen 78b9b83650 Create new webhook walkthrough page from the integration guide. 
Breaks out the Hello World example to create a new
webhook-walkthrough.md. Includes minor edits so the two docs
read well. Adds the new page, "Webhook walkthrough", to the TOC.

Fixes #3498
 2017-02-07 18:22:31 -08:00
Tim Abbott d38b552b02 docs: Add initial documentation on the emoji system. 2017-01-29 12:15:29 -08:00
Tim Abbott bbead84afa docs: Extract security-model.md. 2017-01-17 20:52:29 -08:00
synicalsyntax eaa4f4cfa5 docs: Rewrite user documentation styling guide. 2017-01-16 22:15:01 -08:00
Yago González 5fea825260 docs: Add the Reading list. 2017-01-12 16:42:52 -08:00
Robert Hönig 5ea1b835c9 Rename and reorder the bots guide 2016-12-20 11:40:04 -08:00
Robert Hönig 63e1ca05ea Add developer documentation for bots 2016-12-19 16:29:42 -08:00
Rafid Aslam 0fbbadd303 docs: Extract testing docs to their own TOC section 
Fixes: #2422.
 2016-12-07 07:49:20 -08:00
Tim Abbott b8ec9a5a42 docs: Improve installation instruction headings. 
The previous RTD headings were unclear and resulted in some users
attempting to install the Zulip production environment for doing
development.  This clarifies the situation.
 2016-12-06 17:36:42 -08:00
Tim Abbott b035a6c606 docs: Change dev -> development everywhere. 2016-11-29 14:23:54 -08:00
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
Pweaver (Paul Weaver) b986cf9c41 docs: add a tutorial for setting up a remote dev environemnt 2016-11-20 12:38:14 -08:00
Tim Abbott 945c2c4f86 docs: Add a brief release checklist. 2016-11-04 10:52:48 -07:00
hackerkid 1e409032bd docs: Add subsystem section discussing realms and subdomains. 2016-11-01 10:49:47 -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
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
Christie Koehler 23df7913d5 docs: Add Git and GitHub Guide. 
Fixes #783, #1754.
 2016-10-17 16:18:16 -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
Steve Howell c8e37f30d2 docs: Add "Custom Apps" to "Subsystem Documentation". 2016-08-27 11:30:57 -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 c0e68d59cb docs: Rename status/debug page to troubleshooting. 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
acrefoot 920e605e17 Add extensive views writing documentation. 
[section on REQ substantially expanded by tabbott]

Fixes: #880.
 2016-08-18 12:37:33 -07:00
Sumana Harihareswara 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