diff --git a/docs/en/basic_configuration.md b/docs/en/basic_configuration.md index 881b6d70..0bf0005f 100644 --- a/docs/en/basic_configuration.md +++ b/docs/en/basic_configuration.md @@ -61,12 +61,20 @@ There are two configurations available, and they can both be set to one of three * `direct`: Regenerate only one level above (the direct parent) * `recursive`: Regenerate all parents recursively (up to the top of the SiteTree) +EG: + +```yaml +SilverStripe\CMS\Model\SiteTree: + regenerate_children: recursive + regenerate_parents: recursive +``` + **Please note:** There are times when these configurations are ignored. For example, if you use Silverstripe's default behaviour and have `SiteTree::enforce_strict_hierarchy = true`, then this means that parent pages must be published for anyone to be able to view child pages. If you were to unpublish a parent page in the CMS, then default CMS behaviour -would be for all child pages to also become unavailable to your users. As such, if you unpublish a page, then regardless -of what your `regenerate_children` configuration is, we will always remove the cache of all of the child pages - as this -matches the behaviour that the CMS follows. +would be for all child pages to also become unavailable to your users. As such, if you unpublish a page and you have +`enforce_strict_hierarchy = true`, then regardless of what your `regenerate_children` configuration is, we will always +remove the cache of all of the child pages - as this matches the behaviour of the CMS. ## Available interfaces