[SEO-27] YAML includes un-editable via Resources app Created: 20/Apr/20  Updated: 11/May/22  Resolved: 23/Apr/20

Status: Closed
Project: Search Engine Optimization
Component/s: None
Affects Version/s: 6.1.1
Fix Version/s: 6.2

Type: Bug Priority: Medium
Reporter: Chris Jennings Assignee: Andrew Warinner
Resolution: Fixed Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Attachments: PNG File dot-yml.png    
Issue Links:
Relates
relates to SEO-29 Backport recent fixes Open
Template:
Acceptance criteria:
Empty
Task DoD:
[ ]* Doc/release notes changes? Comment present?
[ ]* Downstream builds green?
[ ]* Solution information and context easily available?
[ ]* Tests
[ ]* FixVersion filled and not yet released
[ ]  Architecture Decision Record (ADR)
Bug DoR:
[ ]* Steps to reproduce, expected, and actual results filled
[ ]* Affected version filled
Date of First Response:

 Description   

The module includes two YAML files with .yml extensions. This prevents them from being viewed or edited in the Resources app (see attached screenshot).

These should have .yaml extensions so they can be edited like any other YAML file.



 Comments   
Comment by Richard Gange [ 20/Apr/20 ]

Hey Chris-

They cannot use the .yaml extension as they are include files. If we use .yaml rather than .yml then the system will try and interpret them as definitions and not snippets. This will lead to errors in the definitions app. If we must make then .yaml then they will need to be moved to a new folder outside of apps.

HTH
Rich

Comment by Chris Jennings [ 20/Apr/20 ]

Cheers, Rich.

I'm just testing a move to /includes/apps. As you say, the Definitions app reports errors, but also the UI creates an icon and an app link for anything in /apps/*/.yaml.

Moving to a folder outside of the expected definitions folders is our recommended best practice so I've gone for that: https://documentation.magnolia-cms.com/display/DOCS61/YAML+inherit+and+include#YAMLinheritandinclude-YAMLinclude

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