Mirror
/
zulip
mirror of https://github.com/zulip/zulip.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
zulip/docs/directory-structure.rst

96 lines
5.1 KiB
ReStructuredText
Raw Normal View History

Directory structure generated from pandoc, with formatting fixes (imported from commit d54bb062b641bac0520494f0a2cb151d69018d61)
2015-08-19 05:24:21 +02:00
===================
Directory structure
===================
docs: Content editing for directory-structure.rst. (imported from commit aa331a561f1e905c9453bd0590eb1147c19f2be4)
2015-09-23 07:17:56 +02:00
This page documents the Zulip directory structure and how to decide where to
Directory structure generated from pandoc, with formatting fixes (imported from commit d54bb062b641bac0520494f0a2cb151d69018d61)
2015-08-19 05:24:21 +02:00
put a file.
Scripts
=======
Update directory-structure.rst content to fix internal references - Delete references to zilencer - Replace "local server" references - Add directories for message views, frontend templates/tests, and docs (imported from commit 7295835434c17609595399e3aec7f9d565fd6b3d)
2015-08-19 05:26:48 +02:00
+--------------------+-----------------------------------------------------------------------------------+
| ``scripts/`` | Scripts that production deployments might run manually (e.g. ``restart-server``) |
+--------------------+-----------------------------------------------------------------------------------+
| ``bin/`` | Scripts that are needed on production deployments but humans should never run |
+--------------------+-----------------------------------------------------------------------------------+
| ``scripts/setup/`` | Tools that production deployments will only run once, during installation |
+--------------------+-----------------------------------------------------------------------------------+
| ``tools/`` | Development tools |
+--------------------+-----------------------------------------------------------------------------------+
Directory structure generated from pandoc, with formatting fixes (imported from commit d54bb062b641bac0520494f0a2cb151d69018d61)
2015-08-19 05:24:21 +02:00
Bots
====
Update directory-structure.rst content to fix internal references - Delete references to zilencer - Replace "local server" references - Add directories for message views, frontend templates/tests, and docs (imported from commit 7295835434c17609595399e3aec7f9d565fd6b3d)
2015-08-19 05:26:48 +02:00
+------------------------+----------------------------------------------------------------------+
docs: Content editing for directory-structure.rst. (imported from commit aa331a561f1e905c9453bd0590eb1147c19f2be4)
2015-09-23 07:17:56 +02:00
| ``api/integrations`` | Bots distributed as part of the Zulip API bundle. |
Update directory-structure.rst content to fix internal references - Delete references to zilencer - Replace "local server" references - Add directories for message views, frontend templates/tests, and docs (imported from commit 7295835434c17609595399e3aec7f9d565fd6b3d)
2015-08-19 05:26:48 +02:00
+------------------------+----------------------------------------------------------------------+
docs: Content editing for directory-structure.rst. (imported from commit aa331a561f1e905c9453bd0590eb1147c19f2be4)
2015-09-23 07:17:56 +02:00
| ``bots/`` | Previously Zulip internal bots. These usually need a bit of work. |
Update directory-structure.rst content to fix internal references - Delete references to zilencer - Replace "local server" references - Add directories for message views, frontend templates/tests, and docs (imported from commit 7295835434c17609595399e3aec7f9d565fd6b3d)
2015-08-19 05:26:48 +02:00
+------------------------+----------------------------------------------------------------------+
Directory structure generated from pandoc, with formatting fixes (imported from commit d54bb062b641bac0520494f0a2cb151d69018d61)
2015-08-19 05:24:21 +02:00
Management commands
===================
Update directory-structure.rst content to fix internal references - Delete references to zilencer - Replace "local server" references - Add directories for message views, frontend templates/tests, and docs (imported from commit 7295835434c17609595399e3aec7f9d565fd6b3d)
2015-08-19 05:26:48 +02:00
+-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
| ``zerver/management/commands/`` | Management commands one might run at a production deployment site (e.g. scripts to change a value or deactivate a user properly) |
+-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
Directory structure generated from pandoc, with formatting fixes (imported from commit d54bb062b641bac0520494f0a2cb151d69018d61)
2015-08-19 05:24:21 +02:00
Views
=====
+--------------------------------+-----------------------------------------+
| ``zerver/tornadoviews.py`` | Tornado views |
+--------------------------------+-----------------------------------------+
| ``zerver/views/webhooks.py`` | Webhook views |
+--------------------------------+-----------------------------------------+
Update directory-structure.rst content to fix internal references - Delete references to zilencer - Replace "local server" references - Add directories for message views, frontend templates/tests, and docs (imported from commit 7295835434c17609595399e3aec7f9d565fd6b3d)
2015-08-19 05:26:48 +02:00
| ``zerver/views/messages.py`` | message-related views |
+--------------------------------+-----------------------------------------+
Directory structure generated from pandoc, with formatting fixes (imported from commit d54bb062b641bac0520494f0a2cb151d69018d61)
2015-08-19 05:24:21 +02:00
| ``zerver/views/__init__.py`` | other Django views |
+--------------------------------+-----------------------------------------+
Static assets
=============
Update directory-structure.rst content to fix internal references - Delete references to zilencer - Replace "local server" references - Add directories for message views, frontend templates/tests, and docs (imported from commit 7295835434c17609595399e3aec7f9d565fd6b3d)
2015-08-19 05:26:48 +02:00
+---------------+---------------------------------------------------------------------------------------------------------------+
| ``assets/`` | For assets not to be served to the web (e.g. the system to generate our favicons) |
+---------------+---------------------------------------------------------------------------------------------------------------+
| ``static/`` | For things we do want to both serve to the web and distribute to production deployments (e.g. the webpages) |
+---------------+---------------------------------------------------------------------------------------------------------------+
Directory structure generated from pandoc, with formatting fixes (imported from commit d54bb062b641bac0520494f0a2cb151d69018d61)
2015-08-19 05:24:21 +02:00
Puppet
======
Update directory-structure.rst content to fix internal references - Delete references to zilencer - Replace "local server" references - Add directories for message views, frontend templates/tests, and docs (imported from commit 7295835434c17609595399e3aec7f9d565fd6b3d)
2015-08-19 05:26:48 +02:00
+--------------------+----------------------------------------------------------------------------------+
| ``puppet/zulip`` | For configuration for production deployments |
+--------------------+----------------------------------------------------------------------------------+
Directory structure generated from pandoc, with formatting fixes (imported from commit d54bb062b641bac0520494f0a2cb151d69018d61)
2015-08-19 05:24:21 +02:00
Templates
=========
Update directory-structure.rst content to fix internal references - Delete references to zilencer - Replace "local server" references - Add directories for message views, frontend templates/tests, and docs (imported from commit 7295835434c17609595399e3aec7f9d565fd6b3d)
2015-08-19 05:26:48 +02:00
+--------------------------+--------------------------------------------------------+
| ``templates/zerver`` | For templates related to zerver views |
+--------------------------+--------------------------------------------------------+
| ``static/templates`` | Handlebars templates for the frontend |
+--------------------------+--------------------------------------------------------+
Tests
=====
docs: Content editing for directory-structure.rst. (imported from commit aa331a561f1e905c9453bd0590eb1147c19f2be4)
2015-09-23 07:17:56 +02:00
+------------------------+-----------------------------------+
Move frontend tests out of zerver/tests/. This fixes an unfortunate bug where the backend tests in zerver/tests.py were not being run automatically, and also makes these a bit easier to find.
2015-10-13 23:34:50 +02:00
| ``zerver/test*.py`` | Backend tests |
docs: Content editing for directory-structure.rst. (imported from commit aa331a561f1e905c9453bd0590eb1147c19f2be4)
2015-09-23 07:17:56 +02:00
+------------------------+-----------------------------------+
Move frontend tests out of zerver/tests/. This fixes an unfortunate bug where the backend tests in zerver/tests.py were not being run automatically, and also makes these a bit easier to find.
2015-10-13 23:34:50 +02:00
| ``frontend_tests/node`` | Node Frontend unit tests |
docs: Content editing for directory-structure.rst. (imported from commit aa331a561f1e905c9453bd0590eb1147c19f2be4)
2015-09-23 07:17:56 +02:00
+------------------------+-----------------------------------+
Move frontend tests out of zerver/tests/. This fixes an unfortunate bug where the backend tests in zerver/tests.py were not being run automatically, and also makes these a bit easier to find.
2015-10-13 23:34:50 +02:00
| ``frontend_tests/tests`` | Casper frontend tests |
docs: Content editing for directory-structure.rst. (imported from commit aa331a561f1e905c9453bd0590eb1147c19f2be4)
2015-09-23 07:17:56 +02:00
+------------------------+-----------------------------------+
Update directory-structure.rst content to fix internal references - Delete references to zilencer - Replace "local server" references - Add directories for message views, frontend templates/tests, and docs (imported from commit 7295835434c17609595399e3aec7f9d565fd6b3d)
2015-08-19 05:26:48 +02:00
Documentation
=============
+-------------+-----------------------------------------------+
| ``docs/`` | Source for this documentation |
+-------------+-----------------------------------------------+
Directory structure generated from pandoc, with formatting fixes (imported from commit d54bb062b641bac0520494f0a2cb151d69018d61)
2015-08-19 05:24:21 +02:00
docs: Content editing for directory-structure.rst. (imported from commit aa331a561f1e905c9453bd0590eb1147c19f2be4)
2015-09-23 07:17:56 +02:00
You can consult the repository's .gitattributes file to see exactly
which components are excluded from production releases (release
tarballs are generated using tools/build-release-tarball).