Uploaded image for project: 'Documentation'
  1. Documentation
  2. DOCU-1091

Reflect latest changes on YAML

XMLWordPrintable

    • Icon: Task Task
    • Resolution: Done
    • Icon: Neutral Neutral
    • 5.5.6
    • None
    • None
    • None
    • Docu Sprint 31, Docu Sprint 32
    • 5

      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).

        Acceptance criteria

              cmeier Christoph Meier
              cmeier Christoph Meier
              Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

                Created:
                Updated:
                Resolved:

                  Task DoR