From 5a1a540377f7cb17b2b19f22574999d6f0411b1e Mon Sep 17 00:00:00 2001 From: Tim Abbott Date: Wed, 22 Jun 2016 10:56:23 -0700 Subject: [PATCH] Expand directory structure details on scripts. --- docs/directory-structure.md | 17 ++++++++++++++--- 1 file changed, 14 insertions(+), 3 deletions(-) diff --git a/docs/directory-structure.md b/docs/directory-structure.md index c2ebc5b60f..e14fc7fd4e 100644 --- a/docs/directory-structure.md +++ b/docs/directory-structure.md @@ -11,12 +11,23 @@ Scripts (e.g., `restart-server`). * `scripts/lib/` Scripts that are needed on production deployments but - humans should never run. + humans should never run directly. -* `scripts/setup/` Tools that production deployments will only run +* `scripts/setup/` Scripts that production deployments will only run once, during installation. -* `tools/` Development tools. +* `tools/` Scripts used only in a Zulip development environment. + These are not included in production release tarballs for Zulip, so + that we can include scripts here one wouldn't want someone to run in + production accidentally (e.g. things that delete the Zulip database + without prompting). + +* `tools/setup/` Subdirectory of `tools/` for things only used during + the development environment setup process. + +* `tools/travis/` Subdirectory of `tools/` for things only used to + setup and run our tests in Travis CI. Actually test suites should + go in `tools/`. ---------------------------------------------------------