From 7cfbb6d524813c6d3a67f79ba1e6294665090f8f Mon Sep 17 00:00:00 2001 From: Alexander Makarov Date: Thu, 2 Nov 2017 22:14:47 +0300 Subject: [PATCH] Fixes #245: Adjusted explanation of what -local.php configs are to make it cleaner --- docs/guide/structure-environments.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/docs/guide/structure-environments.md b/docs/guide/structure-environments.md index 9bd4ef72c4..bbbe73c47f 100644 --- a/docs/guide/structure-environments.md +++ b/docs/guide/structure-environments.md @@ -16,9 +16,11 @@ By default there are two environments: `dev` and `prod`. First is for developmen and debug turned on. Second is for server deployments. It has debug and developer tools turned off. Typically environment contains application bootstrap files such as `index.php` and config files suffixed with -`-local.php`. These are either personal configs of team members which are usually in `dev` environment or configs of -specific servers. For example, production database connection could be in `prod` environment `-local.php` config. -These local configs are added to `.gitignore` and never pushed to source code repository. +`-local.php`. Local configs in `environments` directory are templates that, after `init` is executed, +are being copied into corresponding application config directories. After that, they become your local configuration. +They are meant to keep secret and environment-specific settings, such as database connection credentials, +and aren't meant to be put into version control system. Thus these files are added to `.gitignore` so git is not +considering them for staging. In order to avoid duplication configurations are overriding each other. For example, the frontend reads configuration in the following order: