paulmataruso/zulip
1
0
Fork 0
mirror of https://github.com/zulip/zulip.git synced 2025-11-02 04:53:36 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: Reorder directory structure doc.

Browse Source
This commit is contained in:
Tim Abbott
2016-06-22 10:59:20 -07:00
parent b0e1ae4245
commit c8a1c3a86b
1 changed files with 51 additions and 52 deletions
Download Patch File Download Diff File Expand all files Collapse all files

103
docs/directory-structure.md
View File

@@ -3,6 +3,54 @@
This page documents the Zulip directory structure and how to decide
where to put a file.
### Views
* `zerver/tornadoviews.py` Tornado views
* `zerver/views/webhooks.py` Webhook views
* `zerver/views/messages.py` message-related views
* `zerver/views/__init__.py` other Django views
-------------------------------------------------------------------
### Templates
* `templates/zerver/` For Jinja2 templates for the backend (for zerver app)
* `static/templates/` Handlebars templates for the frontend
----------------------------------------
### Static assets
* `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)
-----------------------------------------------------------------------
### Tests
* `zerver/tests/` Backend tests
* `frontend_tests/node_tests/` Node Frontend unit tests
* `frontend_tests/casper_tests/` Casper frontend tests
-----------------------------------------------------
### Management commands
* `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)
---------------------------------------------------------------
### Scripts
* `scripts/` Scripts that production deployments might run manually
@@ -36,27 +84,13 @@ where to put a file.
* `bots/` Previously Zulip internal bots. These usually need a bit of
work.
-----------------------------------------------------
### Management commands
* `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)
-------------------------------------------------------------------------
### Views
### Puppet
* `zerver/tornadoviews.py` Tornado views
* `puppet/zulip/` For configuration for production deployments
* `zerver/views/webhooks.py` Webhook views
* `zerver/views/messages.py` message-related views
* `zerver/views/__init__.py` other Django views
----------------------------------------
-----------------------------------------------------------------------
### Jinja2 Compatibility Files
@@ -69,41 +103,6 @@ where to put a file.
-----------------------------------------------------------------------
### Static assets
* `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)
---------------------------------------------------------------
### Puppet
* `puppet/zulip/` For configuration for production deployments
-------------------------------------------------------------------
### Templates
* `templates/zerver/` For Jinja2 templates for the backend (for zerver app)
* `static/templates/` Handlebars templates for the frontend
-----------------------------------------------------------------------
### Tests
* `zerver/tests/` Backend tests
* `frontend_tests/node_tests/` Node Frontend unit tests
* `frontend_tests/casper_tests/` Casper frontend tests
-----------------------------------------------------------------------
### Documentation
* `docs/` Source for this documentation