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

Tip for developers that YAML include files should not have spaces at the front of the line

    XMLWordPrintable

Details

    • Task
    • Resolution: Done
    • Neutral
    • None
    • 5.6, 5.7, 6.1, 6.2
    • None
    • None

    Description

      A common pitfall for YAML include files is that they do not work because the lines have too many spaces in front of the first line.
      This is a micro "perfect storm"

      1. Developers are not used to indentation being so important.
      2. If you copy some lines out of an existing YAML defintion into a new file - unless you take care of it you will have some spaces (indentation) at the beginning of the lines.

      Therefore please provide a tip of some kind that the first line in an include file should not have any indentation. Or a note that this could be the problem if their include file is not working.

       

      On this page:

      https://documentation.magnolia-cms.com/display/DOCS61/YAML

      Checklists

        Acceptance criteria

        Attachments

          Activity

            People

              akhamis Ashraf Khamis
              czimmermann Christopher Zimmermann
              Votes:
              0 Vote for this issue
              Watchers:
              3 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved:

                Checklists

                  Task DoR