Commit 5dff3e37 authored by webchick's avatar webchick

Issue #2545958 by pjonckiere, jhodgdon, matslats: Module/profile use of...

Issue #2545958 by pjonckiere, jhodgdon, matslats: Module/profile use of config/optional is apparently not documented
parent 935a5005
...@@ -231,11 +231,23 @@ ...@@ -231,11 +231,23 @@
* Whether or not configuration files are being used for the active * Whether or not configuration files are being used for the active
* configuration storage on a particular site, configuration files are always * configuration storage on a particular site, configuration files are always
* used for: * used for:
* - Defining the default configuration for a module, which is imported to the * - Defining the default configuration for an extension (module, theme, or
* active storage when the module is enabled. Note that changes to this * profile), which is imported to the active storage when the extension if
* default configuration after a module is already enabled have no effect; * enabled. These configuration items are located in the config/install
* to make a configuration change after a module is enabled, you would need * sub-directory of the extension. Note that changes to this configuration
* to uninstall/reinstall or use a hook_update_N() function. * after a module or theme is already enabled have no effect; to make a
* configuration change after a module or theme is enabled, you would need to
* uninstall/reinstall or use a hook_update_N() function.
* - Defining optional configuration for a module or theme. Optional
* configuration items are located in the config/optional sub-directory of the
* extension. These configuration items have dependencies that are not
* explicit dependencies of the extension, so they are only installed if all
* dependencies are met. For example, in the scenario that module A defines a
* dependency which requires module B, but module A is installed first and
* module B some time later, then module A's config/optional directory will be
* scanned at that time for newly met dependencies, and the configuration will
* be installed then. If module B is never installed, the configuration item
* will not be installed either.
* - Exporting and importing configuration. * - Exporting and importing configuration.
* *
* The file storage format for configuration information in Drupal is * The file storage format for configuration information in Drupal is
...@@ -319,9 +331,8 @@ ...@@ -319,9 +331,8 @@
* modulename.schema.yml file, with an entry for 'modulename.config_prefix.*'. * modulename.schema.yml file, with an entry for 'modulename.config_prefix.*'.
* For example, for the Role entity, the file user.schema.yml has an entry * For example, for the Role entity, the file user.schema.yml has an entry
* user.role.*; see @ref sec_yaml above for more information. * user.role.*; see @ref sec_yaml above for more information.
* - Your module may also provide a few configuration items to be installed by * - Your module can provide default/optional configuration entities in YAML
* default, by adding configuration files to the module's config/install * files; see @ref sec_yaml above for more information.
* directory; see @ref sec_yaml above for more information.
* - Some configuration entities have dependencies on other configuration * - Some configuration entities have dependencies on other configuration
* entities, and module developers need to consider this so that configuration * entities, and module developers need to consider this so that configuration
* can be imported, uninstalled, and synchronized in the right order. For * can be imported, uninstalled, and synchronized in the right order. For
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment