mirror of
https://github.com/zulip/zulip.git
synced 2025-11-03 13:33:24 +00:00
169 lines
3.9 KiB
ReStructuredText
169 lines
3.9 KiB
ReStructuredText
.. 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 the Zulip documentation!
|
|
===================================
|
|
|
|
Welcome! Zulip's documentation is split into four parts:
|
|
|
|
- `User documentation <https://zulipchat.com/help>`__, for users and
|
|
administrators of Zulip organizations.
|
|
- `Installation documentation <https://zulip.readthedocs.io/en/latest/prod.html>`__,
|
|
for installing and maintaining a self-hosted Zulip installation.
|
|
- `API documentation <https://zulipchat.com/api/>`__, for writing integrations
|
|
or bots using the Zulip API.
|
|
- `Contributor documentation <https://zulip.readthedocs.io/en/latest/contributing.html>`__,
|
|
for developing the Zulip software, translating, submitting bug reports, or
|
|
making other contributions to the project.
|
|
|
|
Zulip has well over 150,000 words of documentation. If you can't find what
|
|
you're looking for, please
|
|
`let us know <https://zulip.readthedocs.io/en/latest/chat-zulip-org.html>`__!
|
|
Further information on the Zulip project and its features can be found
|
|
at `https://www.zulip.org <https://www.zulip.org>`__.
|
|
|
|
This site contains our installation and contributor documentation. If this
|
|
is your first time here, you may want to start with
|
|
`Production overview <https://zulip.readthedocs.io/en/latest/prod.html>`_ or
|
|
`Contributing to Zulip <https://zulip.readthedocs.io/en/latest/contributing.html>`_.
|
|
|
|
Contents:
|
|
|
|
* :ref:`overview`
|
|
* :ref:`zulip-in-production`
|
|
* :ref:`development-environment`
|
|
* :ref:`developer-tutorials`
|
|
* :ref:`code-contribution-guide`
|
|
* :ref:`code-testing`
|
|
* :ref:`subsystem-documentation`
|
|
|
|
.. _overview:
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
:caption: Overview
|
|
|
|
readme-symlink
|
|
contributing
|
|
architecture-overview
|
|
directory-structure
|
|
roadmap
|
|
changelog
|
|
|
|
.. _zulip-in-production:
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
:caption: Zulip in production
|
|
|
|
Production overview <prod>
|
|
prod-requirements
|
|
Installing a production server <prod-install>
|
|
prod-troubleshooting
|
|
prod-customize
|
|
prod-mobile-push-notifications
|
|
prod-maintain-secure-upgrade
|
|
security-model
|
|
prod-authentication-methods
|
|
prod-postgres
|
|
|
|
.. _development-environment:
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
:caption: Development environment
|
|
|
|
Development environment installation <dev-overview>
|
|
Recommended setup (Vagrant) <dev-env-first-time-contributors>
|
|
Advanced setup (non-Vagrant) <dev-setup-non-vagrant>
|
|
Using the development environment <using-dev-environment>
|
|
Developing remotely <dev-remote>
|
|
|
|
.. _developer-tutorials:
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
:caption: Developer tutorials
|
|
|
|
integration-guide
|
|
integration-docs-guide
|
|
webhook-walkthrough
|
|
new-feature-tutorial
|
|
writing-views
|
|
life-of-a-request
|
|
reading-list
|
|
screenshot-and-gif-software
|
|
fixing-commits
|
|
git-cheat-sheet-detailed
|
|
git-cheat-sheet
|
|
shell-tips
|
|
working-copies
|
|
|
|
.. _code-contribution-guide:
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
:caption: Code contribution guide
|
|
|
|
git-guide
|
|
version-control
|
|
code-style
|
|
mypy
|
|
code-reviewing
|
|
chat-zulip-org
|
|
zulipbot-usage
|
|
accessibility
|
|
bug-reports
|
|
|
|
.. _code-testing:
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
:caption: Code testing
|
|
|
|
testing
|
|
linters
|
|
testing-with-django
|
|
testing-with-node
|
|
testing-with-casper
|
|
travis
|
|
manual-testing
|
|
|
|
.. _subsystem-documentation:
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
:caption: Subsystem documentation
|
|
|
|
dependencies
|
|
settings
|
|
events-system
|
|
queuing
|
|
custom-apps
|
|
pointer
|
|
markdown
|
|
realms
|
|
management-commands
|
|
front-end-build-process
|
|
schema-migrations
|
|
html_css
|
|
hashchange-system
|
|
emoji
|
|
hotspots
|
|
full-text-search
|
|
oauth
|
|
email
|
|
analytics
|
|
translating
|
|
html-templates
|
|
client
|
|
logging
|
|
typing-indicators
|
|
release-checklist
|
|
api-release-checklist
|
|
swagger-api-docs
|
|
documentation
|
|
user-docs
|