This repository was archived by the owner on Mar 5, 2025. It is now read-only.
Update config split documentation #1240
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
grasmash
suggested changes
Mar 22, 2017
| BLT recommends using the Config Split module to manage configuration on most projects. For a description of how to use Config Split, see this excellent [blog post by Jeff Geerling](https://www.jeffgeerling.com/blog/2017/adding-configuration-split-drupal-site-using-blt-and-acquia-cloud). | ||
| ### Overview | ||
|
|
||
| BLT recommends using the Config Split module to manage configuration on most projects. For an overview of how to use Config Split, see this excellent [blog post by Jeff Geerling](https://www.jeffgeerling.com/blog/2017/adding-configuration-split-drupal-site-using-blt-and-acquia-cloud). |
There was a problem hiding this comment.
For backwards compatibility, BLT currently defaults to using features. We could instead default to config split and introduce an update hook to set the cm.strategy to "features" for projects created before 8.7.*. Thoughts?
There was a problem hiding this comment.
Yeah I definitely think we should default to config_split. An update hook (or just a line in the release notes) for existing features-based projects sounds good to me.
readme/configuration-management.md
Outdated
|
|
||
| This section will guide you through initially setting up a Config Split workflow on your BLT based project. | ||
|
|
||
| 1. Ensure that you are using Drush version 8.1.10 or higher. |
There was a problem hiding this comment.
This is already required by BLT in 8.7.*.
readme/configuration-management.md
Outdated
| This section will guide you through initially setting up a Config Split workflow on your BLT based project. | ||
|
|
||
| 1. Ensure that you are using Drush version 8.1.10 or higher. | ||
| 2. Add Config Split version 8.x-1.0-beta4 or higher to your codebase: `composer require drupal/config_split` |
There was a problem hiding this comment.
This is already included in composer.required.json.
readme/configuration-management.md
Outdated
|
|
||
| 1. Ensure that you are using Drush version 8.1.10 or higher. | ||
| 2. Add Config Split version 8.x-1.0-beta4 or higher to your codebase: `composer require drupal/config_split` | ||
| 3. TODO: finish this section once the related functionality is stabilized in BLT core. |
There was a problem hiding this comment.
We also need to indicate that cm.strategy must be set to config-split in project.yml. We may make this the default.
| 4. Review the updated configuration in `config/default` using `git diff`. If you are satisfied with the changes, commit them and open a pull request. | ||
|
|
||
| Note that when you run `drush cex`, if the project has been configured correctly, some configuration that's specific to the development environment should automatically be excluded. Similarly, some configuration that's intended to be "unlocked" in production might also be excluded (such as webforms). If you need to customize this behavior, you can modify the blacklists or greylists by following the steps in the section above. | ||
|
|
||
| ## Features-based workflow | ||
|
|
||
| Features allows you to bundle related configuration files (such as a content type and its fields) into individual feature modules. Drupal treats features just like normal modules, but Features and its dependencies add some special sauce that allow features to not only provide default configuration (like normal modules), but to also update (track and import) changes to this configuration. |
There was a problem hiding this comment.
We need to indicate that cm.strategy must be set to features in project.yml.
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Starting to add documentation specifically targeted at TAs and developers.