[DOCU-1091] Reflect latest changes on YAML Created: 28/Jul/17  Updated: 07/Sep/17  Resolved: 21/Aug/17

Status: Closed
Project: Documentation
Component/s: None
Affects Version/s: None
Fix Version/s: 5.5.6

Type: Task Priority: Neutral
Reporter: Christoph Meier Assignee: Christoph Meier
Resolution: Done Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Issue Links:
dependency
relation
is related to DOCU-757 Explain YAML extends Closed
is related to DOCU-842 Document Yaml equivalent of extends i... Closed
Template:
Acceptance criteria:
Empty
Task DoR:
Empty
Date of First Response:
Sprint: Docu Sprint 31, Docu Sprint 32
Story Points: 5

 Description   

Overview

With 5.5.6 abilities to reuse YAML based configuration has been drastically expanded.
JCR extends stays exactly the same as it was before. This all concerns YAML only!

The existing !include has been refined and extended. The include mechanism how it was known before 5.5.6 still exists but is deprecated.
Magnolia now provides for YAML:

I inheritance + !override
as known from the JCR inherits
Related PR (pull request): https://git.magnolia-cms.com/projects/PLATFORM/repos/main/pull-requests/462/commits

II uber-include = include + !override
File include & override
… include a file plus override some of its properties
_Related PR: https://git.magnolia-cms.com/projects/PLATFORM/repos/main/pull-requests/471/commits

III allow !override + uber-inlcude in decoration
_ decorate plus_
Related PR: https://git.magnolia-cms.com/projects/PLATFORM/repos/main/pull-requests/474/commits

Related JIRA tickets:

Docs to update

Reusing configuration
=> Make a short "overview page" (which keeps the title), then splitting up the two topics into two separate pages.
New structure:
Reusing configuration

YAML
=> Make sure the new directives !includes and !inherits are properly mentioned and quickly explained plus add cross links

Definition decoration
=> since 5.5.6, in decoration you can use !override and "uber-include"

Maybe update

Examples

From Philip:
https://git.magnolia-cms.com/users/pmundt/repos/the-test-project/commits

Others

Please check DOCU-842, DOCU-757 too (and delete 842 if it is not needed anymore).



 Comments   
Comment by Christoph Meier [ 15/Aug/17 ]

New or updated pages:

Page state tech. review linguistic review
https://documentation.magnolia-cms.com/display/DOCS/Reusing+configuration+-+5.5.6 ready for review not required required and done
https://documentation.magnolia-cms.com/display/DOCS/JCR+extends done not required not required
https://documentation.magnolia-cms.com/display/DOCS/YAML+inherit+and+include ready for review required required and done
https://documentation.magnolia-cms.com/display/DOCS/YAML+5.5.6 ready for review required required and done
Comment by Christoph Meier [ 06/Sep/17 ]

DEV review is done.
I have applied changes accordingly.

I would like Martin to ask for a final "check" at the section https://documentation.magnolia-cms.com/display/DOCS/YAML+inherit+and+include#YAMLinheritandinclude-YAMLoverride
I wonder whether the "format" (with the tables) is fine, and - more interesting - whether the message is understandable.

Generated at Mon Feb 12 01:15:03 CET 2024 using Jira 9.4.2#940002-sha1:46d1a51de284217efdcb32434eab47a99af2938b.