diff --git a/plugin-settings.md b/plugin-settings.md index 52cae47e..59dedcde 100644 --- a/plugin-settings.md +++ b/plugin-settings.md @@ -169,7 +169,11 @@ Use the `Config` class for accessing the configuration values defined in the con $maxItems = Config::get('acme.demo::maxItems', 50); -A plugin configuration can be overridden by the application by creating a configuration file `config/author/plugin/config.php`, for example `config/acme/todo/config.php`, or `config/acme/todo/dev/config.php` for different environment. Inside the overridden configuration file you can return only values you want to override: +A plugin configuration can be overridden by the application by creating a configuration file `config/author/plugin/config.php`, for example `config/acme/todo/config.php`, or `config/acme/todo/dev/config.php` for an environment specific override (in this case `dev`). + +> **NOTE:** In order for the config override to work, the plugin must contain a default config file (i.e. `plugins/author/plugin/config/config.php`. Even if you expect all configuration to come from the project override instead of the default configuration file it is still **highly** recommended that a default configuration file is provided as a form of documentation as to what configuration options are available to be modified on the project level. + +Inside the overridden configuration file you can return only values you want to override: