Commit 76031257 authored by nord102's avatar nord102

Updating README.txt to be up-to-date with the module page description

parent 436567b6
......@@ -3,17 +3,19 @@ Config Ignore
INTRODUCTION
------------
Ever experienced that your sites configuration was overridden by the configuration on the filesystem, when doing a
`drush cim`?
Ever experienced that your site's configuration was overridden,
by the configuration on the file system, when running a `drush cim`?
Not anymore!
This modules is a tool to let you keep the configuration you want, in place.
Lets say that you do would like the `system.site` configuration (which contains that sites name, slogan, email, etc) to
remain untouched, on your live site, no matter what the configuration, in the export folder says.
Let's say that you do would like the `system.site` configuration
(which contains that sites name, slogan, email, etc.) to remain untouched,
on your live site, no matter what the configuration in the config folder is.
Or maybe you are getting tired of having the `devel.settings` changed every time you import configuration?
Or maybe you are getting tired of having the `devel.settings`
changed every time you import configuration?
Then this module is what you are looking for.
......@@ -28,12 +30,23 @@ to see how to install and manage modules in Drupal 8.
CONFIGURATION
-------------
Go to `admin/config/development/configuration/ignore` to set what configuration you want to ignore upon import.
If you go to `admin/config/development/configuration/ignore`
you will see a fairly simple interface.
Do not ignore the `core.extension` configuration as it will prevent you from enabling new modules with a config import.
Use the `config_split` module for environment specific modules.
Add the name of the configuration that you want to ignore upon import.
(e.g. `system.site` to ignore site name, slogan and email site email address.)
Click the "Save configuration" button and you are good to go.
To deactivate `config_ignore`, include `$settings['config_ignore_deactivate'] = TRUE;` in your settings.php file.
Do not ignore the `core.extension` configuration as it will prevent you
from enabling new modules with a config import. Use the `config_split` module
for environment specific modules.
If you need to bypass Config Ignore you can update/create a single configuration
by using the "Single import" feature found at
`admin/config/development/configuration/single/import`.
To deactivate `config_ignore`, include
`$settings['config_ignore_deactivate'] = TRUE;` in your settings.php file.
MAINTAINERS
-----------
......@@ -41,3 +54,4 @@ Current maintainers:
* Tommy Lynge Jørgensen (TLyngeJ) - https://www.drupal.org/u/tlyngej
* Fabian Bircher (bircher) - https://www.drupal.org/u/bircher
* Jordan Thompson (nord102) - https://www.drupal.org/u/nord102
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