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

Directory structure generated from pandoc, with formatting fixes 

(imported from commit d54bb062b641bac0520494f0a2cb151d69018d61)
This commit is contained in:
Yoyo Zhou 2015-08-18 20:24:21 -07:00
parent 127cdf63c6
commit 1629e77174
2 changed files with 87 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

85
docs/directory-structure.rst Normal file
View File

@ -0,0 +1,85 @@
===================
Directory structure
===================
.. attention::
Needs content review
This page documents our directory structure and how to decide where to
put a file.
Scripts
=======
+----------------------+-----------------------------------------------------------------------------------+
| ``scripts/`` | Scripts that local server users might run manually (e.g. ``restart/server``) |
+----------------------+-----------------------------------------------------------------------------------+
| ``bin/`` | Scripts that are needed on local server deployments but humans should never run |
+----------------------+-----------------------------------------------------------------------------------+
| ``scripts/setup/`` | Tools that local server installations will only run once, during installation |
+----------------------+-----------------------------------------------------------------------------------+
| ``tools/`` | Internal tools (not distributed) |
+----------------------+-----------------------------------------------------------------------------------+
Bots
====
+------------------------+---------------------------------------------------+
| ``bots/`` | Not distributed, even to local server instances |
+------------------------+---------------------------------------------------+
| ``api/integrations`` | Distributed in our API bundle |
+------------------------+---------------------------------------------------+
Management commands
===================
+-------------------------------------+---------------------------------------------------------------------------------------------------------------------------+
| ``zerver/management/commands/`` | Management commands one might run at a local server site (e.g. scripts to change a value or deactivate a user properly) |
+-------------------------------------+---------------------------------------------------------------------------------------------------------------------------+
| ``zilencer/management/commands/`` | Management commands for internal use only (e.g. analytics) |
+-------------------------------------+---------------------------------------------------------------------------------------------------------------------------+
Views
=====
+--------------------------------+-----------------------------------------+
| ``zilencer/views.py`` | Internal-only views (analytics, etc.) |
+--------------------------------+-----------------------------------------+
| ``zerver/tornadoviews.py`` | Tornado views |
+--------------------------------+-----------------------------------------+
| ``zerver/views/webhooks.py`` | Webhook views |
+--------------------------------+-----------------------------------------+
| ``zerver/views/__init__.py`` | other Django views |
+--------------------------------+-----------------------------------------+
Static assets
=============
+---------------+----------------------------------------------------------------------------------------------------------------+
| ``assets/`` | For assets not to be served to the web (e.g. the system to generate our favicons, or our tshirt design data) |
+---------------+----------------------------------------------------------------------------------------------------------------+
| ``static/`` | For things we do want to both server to the web and distribute to local server users (e.g. the webpages) |
+---------------+----------------------------------------------------------------------------------------------------------------+
Puppet
======
+-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
| ``puppet/zulip`` | For common configuration relevant to both internal servers and local server (e.g. configuration to run our app, supervisor, etc.) |
+-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
| ``puppet/zulip-internal`` | For configuration for our internal servers (e.g. SSH setup, Nagios setup) |
+-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
Templates
=========
+--------------------------+----------------------------------------------------------------------------------------------------------------------+
| ``templates/zerver`` | For templates related to zerver views. |
+--------------------------+----------------------------------------------------------------------------------------------------------------------+
| ``templates/zilencer`` | For templates related to zilencer views, including random other pages from our corporate website (e.g. job posts). |
+--------------------------+----------------------------------------------------------------------------------------------------------------------+
You can consult the code for ``tools/build-local-server-tarball`` to
check exactly which components are shipped along with local server --
since that is the tool that does the builds, it controls the
distribution.

3
docs/index.rst
View File

@ -11,7 +11,8 @@ Contents:
.. toctree::
:maxdepth: 2
Code Style <code-style>
code-style
directory-structure
Indices and tables
==================