2015-08-18 01:25:12 +02:00
|
|
|
.. zulip documentation master file, created by
|
|
|
|
sphinx-quickstart on Mon Aug 17 16:24:04 2015.
|
|
|
|
You can adapt this file completely to your liking, but it should at least
|
|
|
|
contain the root `toctree` directive.
|
|
|
|
|
|
|
|
Welcome to Zulip documentation!
|
|
|
|
===============================
|
|
|
|
|
2016-05-14 18:50:19 +02:00
|
|
|
Zulip is a powerful, open source group chat application. Written in
|
|
|
|
Python and using the Django framework, Zulip supports both private
|
|
|
|
messaging and group chats via conversation streams.
|
|
|
|
|
|
|
|
Zulip also supports fast search, drag-and-drop file uploads, image
|
|
|
|
previews, group private messages, audible notifications, missed-message
|
|
|
|
emails, desktop apps, and much more.
|
|
|
|
|
|
|
|
Further information on the Zulip project and its features can be found
|
|
|
|
at `https://www.zulip.org <https://www.zulip.org>`__ and in these
|
|
|
|
docs. Our code is available at `our GitHub repository
|
|
|
|
<https://github.com/zulip/>`__.
|
|
|
|
|
|
|
|
This set of documents covers installation and contribution instructions.
|
|
|
|
|
2015-08-18 01:25:12 +02:00
|
|
|
Contents:
|
|
|
|
|
2016-06-17 02:59:41 +02:00
|
|
|
* :ref:`user-docs`
|
2016-07-12 21:35:25 +02:00
|
|
|
* :ref:`prod-install-docs`
|
2016-07-15 06:51:37 +02:00
|
|
|
* :ref:`dev-install-docs`
|
2016-06-17 02:59:41 +02:00
|
|
|
* :ref:`tutorial-docs`
|
|
|
|
* :ref:`code-docs`
|
2016-12-06 12:17:05 +01:00
|
|
|
* :ref:`code-testing`
|
2016-06-17 02:59:41 +02:00
|
|
|
* :ref:`system-docs`
|
|
|
|
|
|
|
|
.. _user-docs:
|
|
|
|
|
2015-08-18 01:25:12 +02:00
|
|
|
.. toctree::
|
2016-06-17 02:59:41 +02:00
|
|
|
:maxdepth: 2
|
|
|
|
:caption: Overview
|
2015-08-18 01:25:12 +02:00
|
|
|
|
2016-05-14 18:50:19 +02:00
|
|
|
readme-symlink
|
2016-05-15 00:01:43 +02:00
|
|
|
architecture-overview
|
2016-06-17 02:59:41 +02:00
|
|
|
directory-structure
|
|
|
|
roadmap
|
|
|
|
changelog
|
|
|
|
|
2016-07-12 21:35:25 +02:00
|
|
|
.. _prod-install-docs:
|
|
|
|
|
|
|
|
.. toctree::
|
|
|
|
:maxdepth: 2
|
|
|
|
:caption: Zulip in production
|
|
|
|
|
|
|
|
prod-requirements
|
2016-12-07 02:34:41 +01:00
|
|
|
Installing a production server <prod-install>
|
2016-08-25 06:40:36 +02:00
|
|
|
prod-troubleshooting
|
2016-07-12 22:43:00 +02:00
|
|
|
prod-customize
|
2017-05-16 22:28:15 +02:00
|
|
|
prod-mobile-push-notifications
|
2016-07-12 22:52:29 +02:00
|
|
|
prod-maintain-secure-upgrade
|
2017-01-18 02:43:17 +01:00
|
|
|
security-model
|
2016-07-13 01:05:04 +02:00
|
|
|
prod-authentication-methods
|
2016-07-12 23:37:39 +02:00
|
|
|
prod-postgres
|
2016-07-12 21:35:25 +02:00
|
|
|
|
2016-07-15 06:51:37 +02:00
|
|
|
.. _dev-install-docs:
|
|
|
|
|
|
|
|
.. toctree::
|
|
|
|
:maxdepth: 2
|
2016-12-07 02:34:41 +01:00
|
|
|
:caption: Development environment
|
2016-07-15 06:51:37 +02:00
|
|
|
|
2016-12-07 02:34:41 +01:00
|
|
|
Development environment installation <dev-overview>
|
2016-11-28 02:50:33 +01:00
|
|
|
Recommended setup (Vagrant) <dev-env-first-time-contributors>
|
|
|
|
Advanced setup (non-Vagrant) <dev-setup-non-vagrant>
|
2016-11-29 23:23:54 +01:00
|
|
|
Using the development environment <using-dev-environment>
|
2016-11-28 02:50:33 +01:00
|
|
|
Developing remotely <dev-remote>
|
2016-07-15 06:51:37 +02:00
|
|
|
|
2016-06-17 02:59:41 +02:00
|
|
|
.. _tutorial-docs:
|
|
|
|
|
|
|
|
.. toctree::
|
|
|
|
:maxdepth: 2
|
|
|
|
:caption: Developer tutorials
|
|
|
|
|
2016-04-01 23:55:23 +02:00
|
|
|
integration-guide
|
2017-02-06 22:07:45 +01:00
|
|
|
webhook-walkthrough
|
2015-08-22 02:05:06 +02:00
|
|
|
new-feature-tutorial
|
2016-07-16 03:13:57 +02:00
|
|
|
writing-views
|
2016-07-21 01:58:19 +02:00
|
|
|
life-of-a-request
|
2017-01-10 18:40:25 +01:00
|
|
|
reading-list
|
2016-06-17 02:59:41 +02:00
|
|
|
|
|
|
|
.. _code-docs:
|
|
|
|
|
|
|
|
.. toctree::
|
|
|
|
:maxdepth: 2
|
|
|
|
:caption: Code contribution guide
|
|
|
|
|
2016-09-20 21:40:31 +02:00
|
|
|
git-guide
|
2016-06-26 18:57:27 +02:00
|
|
|
version-control
|
2016-06-17 02:59:41 +02:00
|
|
|
code-style
|
|
|
|
mypy
|
2016-10-19 10:26:51 +02:00
|
|
|
code-reviewing
|
2017-02-12 22:50:11 +01:00
|
|
|
chat-zulip-org
|
2017-03-04 23:22:44 +01:00
|
|
|
zulipbot-usage
|
2017-05-23 01:59:14 +02:00
|
|
|
accessibility
|
2016-06-17 02:59:41 +02:00
|
|
|
|
2016-12-06 12:17:05 +01:00
|
|
|
.. _code-testing:
|
|
|
|
|
|
|
|
.. toctree::
|
|
|
|
:maxdepth: 2
|
|
|
|
:caption: Code testing
|
|
|
|
|
|
|
|
testing
|
|
|
|
linters
|
|
|
|
testing-with-node
|
|
|
|
testing-with-django
|
|
|
|
testing-with-casper
|
|
|
|
manual-testing
|
|
|
|
|
2016-06-17 02:59:41 +02:00
|
|
|
.. _system-docs:
|
|
|
|
|
|
|
|
.. toctree::
|
|
|
|
:maxdepth: 2
|
|
|
|
:caption: Subsystem documentation
|
|
|
|
|
|
|
|
settings
|
2017-02-10 10:09:31 +01:00
|
|
|
events-system
|
2016-06-17 02:59:41 +02:00
|
|
|
queuing
|
2016-12-20 20:16:02 +01:00
|
|
|
bots-guide
|
2016-08-27 17:39:27 +02:00
|
|
|
custom-apps
|
2016-08-11 22:14:22 +02:00
|
|
|
pointer
|
2016-06-17 02:59:41 +02:00
|
|
|
markdown
|
2016-10-31 18:13:56 +01:00
|
|
|
realms
|
2016-06-17 02:59:41 +02:00
|
|
|
front-end-build-process
|
|
|
|
schema-migrations
|
2016-06-27 01:03:56 +02:00
|
|
|
html_css
|
2017-03-22 23:16:46 +01:00
|
|
|
hashchange-system
|
2017-01-29 21:15:29 +01:00
|
|
|
emoji
|
2016-06-26 18:32:54 +02:00
|
|
|
full-text-search
|
2017-02-22 21:49:29 +01:00
|
|
|
analytics
|
2016-04-29 06:55:09 +02:00
|
|
|
translating
|
2017-05-02 03:54:36 +02:00
|
|
|
client
|
2016-06-17 02:59:41 +02:00
|
|
|
logging
|
2016-11-04 18:50:15 +01:00
|
|
|
release-checklist
|
2016-06-26 19:00:02 +02:00
|
|
|
README
|
2017-01-16 21:38:07 +01:00
|
|
|
user-docs
|