- Issue created by @trackleft2
The current project page for the Config Distro module lacks clarity and simplicity, making it difficult for users to understand and utilize the module effectively. The language and structure can be improved to better describe its capabilities and benefits.
Update the project page with the following revised content or something similar:
Config Distro is a powerful module designed to assist in managing how the configuration bundled with modules, themes, or profiles is applied to a site over time. Because config_distro looks for differences between the site's active configuration in the database and all of the configuration stored as YAML files within each extension's config folder, it enables version control of configuration changes, making them easily deployable using tools like Git. Config Distro allows maintainers to manage configuration differences between a Drupal site and the upstream source via Drush Command Line Interface or Graphical User Interface. Each of these extension types can store configuration to be installed when the extension is installed.
Config Distro is intended for:
Config Distro comes with two sub-modules to enhance its functionality:
Config Filter is not a dependency of Config Distro itself, but it is required for both sub-modules (config_distro_filter and config_distro_ignore). Ensure that the Config Filter module is installed and enabled if you are using either sub-module.
Configuration Synchronizer (8.x-2.x branch): Provides filters that integrate with Config Distro, allowing it to import configuration updates from installed modules and themes.
config-distro-update to run imports.Config Distro should be installed and used at the base of your site's configuration management workflow. For instance:
Best Practice: If you're staging configuration updates, run your distro updates first, then stage them to other environments.
Import Configuration as Code: Config Distro allows you to import or merge configuration managed as code from a separately managed extension installation. This helps manage the configuration differences between a Drupal site and the upstream source.
Configuration Update Modes: Config Distro can use three different modes for updating configuration from the profile:
Configuration Storage: Config Distro provides a configuration storage for use with Config Filter, adding filters to the site's active configuration storage. This means changes are merged directly into the active configuration.
UI Integration: Config Distro provides a user interface parallel to core's Configuration Synchronization UI for managing distribution updates. It serves as the missing user interface for installation profiles.
User Flexibility: Allows users to choose how configuration for that extension is applied on a site-by-site basis.
No user interface changes within the module itself, but the project page on Drupal.org will be updated for better clarity and usability.
None.
None.
Active
2.0
Documentation