modxbot / migrate

A testground for migrating issues and other such fun
0 stars 0 forks source link

Add comments to default config file #10299

Open modxbot opened 10 years ago

modxbot commented 10 years ago

everettg_99 created Redmine issue ID 10299

Because the core/config/config.inc.php and the config.core.php files get rewritten by the MODX install/upgrade process, it's important to alert dev users to that fact. In many (most?) other systems, the config files are not WRITTEN by the app, they are only READ, so the config files become an important spot for developers to add customizations (e.g. defining constants, adding global settings, etc), but in MODX, only the $config_options array is safe from the update process. As a courtesy to any developers who are used to the way other systems handle this, it is important to alert them to this behavior. Just a short blurb of text would suffice:

/* This file is managed by the installation process.  Any modifications to it may get overwritten.*/

Or

/* Add customizations to the $config_options array.  All other modifications to this file may get overwritten by the install or upgrade process. */