zulip/docs/index.rst

.. 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!
===============================

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.

Contents:

* :ref:`user-docs`
* :ref:`prod-install-docs`
* :ref:`dev-install-docs`
* :ref:`tutorial-docs`
* :ref:`code-docs`
* :ref:`system-docs`

.. _user-docs:

.. toctree::
   :maxdepth: 2
   :caption: Overview

   readme-symlink
   architecture-overview
   directory-structure
   roadmap
   changelog

.. _prod-install-docs:

.. toctree::
   :maxdepth: 2
   :caption: Zulip in production

   prod-requirements
   prod-install
   prod-troubleshooting
   prod-customize
   prod-maintain-secure-upgrade
   prod-authentication-methods
   prod-postgres

.. _dev-install-docs:

.. toctree::
   :maxdepth: 2
   :caption: Installation for developers

   dev-overview
   dev-env-first-time-contributors
   brief-install-vagrant-dev
   install-ubuntu-without-vagrant-dev
   install-generic-unix-dev
   install-docker-dev
   using-dev-environment

.. _tutorial-docs:

.. toctree::
   :maxdepth: 2
   :caption: Developer tutorials

   integration-guide
   new-feature-tutorial
   writing-views
   life-of-a-request

.. _code-docs:

.. toctree::
   :maxdepth: 2
   :caption: Code contribution guide

   git-guide
   version-control
   code-style
   testing
   mypy
   code-reviewing

.. _system-docs:

.. toctree::
   :maxdepth: 2
   :caption: Subsystem documentation

   settings
   queuing
   custom-apps
   pointer
   markdown
   realms
   front-end-build-process
   schema-migrations
   html_css
   full-text-search
   translating
   logging
   release-checklist
   README
Initial sphinx setup from sphinx-quickstart (imported from commit b9fc7a8f2f9352129c104f5dc9305203f2efc63d) 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!`
			`===============================`

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-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.`

Initial sphinx setup from sphinx-quickstart (imported from commit b9fc7a8f2f9352129c104f5dc9305203f2efc63d) 2015-08-18 01:25:12 +02:00			`Contents:`

docs: Reorganize RTD table of contents. 2016-06-17 02:59:41 +02:00			* :ref:`user-docs`
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 21:35:25 +02:00			* :ref:`prod-install-docs`
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-15 06:51:37 +02:00			* :ref:`dev-install-docs`
docs: Reorganize RTD table of contents. 2016-06-17 02:59:41 +02:00			* :ref:`tutorial-docs`
			* :ref:`code-docs`
			* :ref:`system-docs`

			`.. _user-docs:`

Initial sphinx setup from sphinx-quickstart (imported from commit b9fc7a8f2f9352129c104f5dc9305203f2efc63d) 2015-08-18 01:25:12 +02:00			`.. toctree::`
docs: Reorganize RTD table of contents. 2016-06-17 02:59:41 +02:00			`:maxdepth: 2`
			`:caption: Overview`
Initial sphinx setup from sphinx-quickstart (imported from commit b9fc7a8f2f9352129c104f5dc9305203f2efc63d) 2015-08-18 01:25:12 +02:00
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-14 18:50:19 +02:00			`readme-symlink`
Add architectural overview documentation. Fixes: #453. 2016-05-15 00:01:43 +02:00			`architecture-overview`
docs: Reorganize RTD table of contents. 2016-06-17 02:59:41 +02:00			`directory-structure`
			`roadmap`
			`changelog`

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 21:35:25 +02:00			`.. _prod-install-docs:`

			`.. toctree::`
			`:maxdepth: 2`
			`:caption: Zulip in production`

			`prod-requirements`
Move production install instructions to new page. 2016-07-12 21:49:44 +02:00			`prod-install`
docs: Rename status/debug page to troubleshooting. 2016-08-25 06:40:36 +02:00			`prod-troubleshooting`
Move prod customization guide to new page. 2016-07-12 22:43:00 +02:00			`prod-customize`
Move prod maintenance guide to new page. 2016-07-12 22:52:29 +02:00			`prod-maintain-secure-upgrade`
docs: Turn SSO auth documentation into general auth page. Also remove this page from the breadcrumb. 2016-07-13 01:05:04 +02:00			`prod-authentication-methods`
Move prod postgres details to separate page. 2016-07-12 23:37:39 +02:00			`prod-postgres`
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 21:35:25 +02:00
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-15 06:51:37 +02:00			`.. _dev-install-docs:`

			`.. toctree::`
			`:maxdepth: 2`
			`:caption: Installation for developers`

docs: Move README.dev.md into ReadTheDocs. Fixes: #669. 2016-08-25 07:06:35 +02:00			`dev-overview`
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-15 06:51:37 +02:00			`dev-env-first-time-contributors`
Move and rearrange vagrant instructions. 2016-07-15 06:58:43 +02:00			`brief-install-vagrant-dev`
Split non-Vagrant Ubuntu install doc into topic page. 2016-07-15 20:01:07 +02:00			`install-ubuntu-without-vagrant-dev`
Split out generic UNIX developer install doc. 2016-07-15 20:05:08 +02:00			`install-generic-unix-dev`
docs: Clean up development environment headings. 2016-08-25 07:00:46 +02:00			`install-docker-dev`
Split developer environment usage instructions into new page. 2016-07-15 20:43:09 +02:00			`using-dev-environment`
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-15 06:51:37 +02:00
docs: Reorganize RTD table of contents. 2016-06-17 02:59:41 +02:00			`.. _tutorial-docs:`

			`.. toctree::`
			`:maxdepth: 2`
			`:caption: Developer tutorials`

Add new markdown documentation to ReadTheDocs. 2016-04-01 23:55:23 +02:00			`integration-guide`
Add new feature tutorial. (imported from commit 1577c2567232aba1a1f1c6d1df83370acf54af55) 2015-08-22 02:05:06 +02:00			`new-feature-tutorial`
Add extensive views writing documentation. [section on REQ substantially expanded by tabbott] Fixes: #880. 2016-07-16 03:13:57 +02:00			`writing-views`
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-21 01:58:19 +02:00			`life-of-a-request`
docs: Reorganize RTD table of contents. 2016-06-17 02:59:41 +02:00
			`.. _code-docs:`

			`.. toctree::`
			`:maxdepth: 2`
			`:caption: Code contribution guide`

docs: Add Git and GitHub Guide. Fixes #783, #1754. 2016-09-20 21:40:31 +02:00			`git-guide`
docs: Split out version control guidelines. 2016-06-26 18:57:27 +02:00			`version-control`
docs: Reorganize RTD table of contents. 2016-06-17 02:59:41 +02:00			`code-style`
			`testing`
			`mypy`
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-19 10:26:51 +02:00			`code-reviewing`
docs: Reorganize RTD table of contents. 2016-06-17 02:59:41 +02:00
			`.. _system-docs:`

			`.. toctree::`
			`:maxdepth: 2`
			`:caption: Subsystem documentation`

			`settings`
			`queuing`
docs: Add "Custom Apps" to "Subsystem Documentation". 2016-08-27 17:39:27 +02:00			`custom-apps`
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-11 22:14:22 +02:00			`pointer`
docs: Reorganize RTD table of contents. 2016-06-17 02:59:41 +02:00			`markdown`
docs: Add subsystem section discussing realms and subdomains. 2016-10-31 18:13:56 +01:00			`realms`
docs: Reorganize RTD table of contents. 2016-06-17 02:59:41 +02:00			`front-end-build-process`
			`schema-migrations`
docs: Add documentation on HTML and CSS. 2016-06-27 01:03:56 +02:00			`html_css`
docs: Add some full-text search documentation. 2016-06-26 18:32:54 +02:00			`full-text-search`
Add documentation on translating Zulip. 2016-04-29 06:55:09 +02:00			`translating`
docs: Reorganize RTD table of contents. 2016-06-17 02:59:41 +02:00			`logging`
docs: Add a brief release checklist. 2016-11-04 18:50:15 +01:00			`release-checklist`
docs: Add link to documentation building docs. 2016-06-26 19:00:02 +02:00			`README`