[MGNLUI-6207] Simplify YAML configuration Created: 11/Sep/20  Updated: 10/Mar/21

Status: Accepted
Project: Magnolia UI
Component/s: None
Affects Version/s: None
Fix Version/s: None

Type: Epic Priority: Neutral
Reporter: Roman Kovařík Assignee: Unassigned
Resolution: Unresolved Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Attachments: PDF File YAML_simplification.pdf    
Issue Links:
dependency
depends upon MGNLUI-4949 Datasource should not mean different ... Closed
duplicate
duplicates MAGNOLIA-7429 Simpler YAML Configurations Closed
supersession
supersedes MGNLUI-5789 Simpler app descriptors Closed
Template:
Epic Name: Simplify YAML configuration
Acceptance criteria:
Empty

 Description   

Goals and Benefits:

  • Less boilerplate; some of our definitions inherently require too much boilerplate to get started.
  • Easier onboarding with YAML configuration
  • Easier to remember snippets to achieve common tasks
  • Less overhead to learn about Magnolia-specific app components

Discussions:

We need to revisit the idea for whom we are trying to simplify the config. Depending on who the users are and what are their common use case they may never need the aliases we planned to create for them.

  • E.g. when using content types, aliases like those in MGNLUI-5945 wouldn't bring benefit.
  • We might also want to change one of our apps to a content type app so we give a better example to follow.
  • We can discuss also with PM what are the use cases we want to help out with for users
    • non-content type based apps are still going to be here for the next 3 years or so along content-type apps, so we can adjust
  • Sang mentioned we'd want to rather try to simplify e.g. action bars definitions (permutations of action bar views based on state)  [file ticket] which might be too complex and lengthy at the moment 
    • Sang: I prefer keeping explicit definition/class in Yaml, developer/user can easier and faster find the implementation, or know which class/definition are using

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