[MGNLUI-5945] Omit the most typical app/sub-app class references in configuration Created: 10/Jun/20  Updated: 19/Feb/21

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

Type: Improvement Priority: Neutral
Reporter: Šimon Demočko Assignee: Unassigned
Resolution: Unresolved Votes: 0
Labels: ui-devx-impr
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

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)
Epic Link: Simplify YAML configuration
Story Points: 3

 Description   

We still need to specify the usually same sub-app/app classes, can we fallback to defaults there? Aliases could be introduced to simplify this too.

Examples.

Typical content app def/app class:
class: info.magnolia.ui.contentapp.configuration.ContentAppDescriptor
appClass: info.magnolia.ui.framework.app.BaseApp
Browser sub-app
  browser:
    class: info.magnolia.ui.contentapp.configuration.BrowserDescriptor
Detail sub-app:
    class: info.magnolia.ui.contentapp.detail.DetailDescriptor

Those show up in 90% (if not more) app descriptors and are usually the same.

Acceptance criteria

Put also to

  • personas
  • segments
  • pages
  • assets
  • definitions
  • resources

Discussion points

These aliases would not be useful probably because the content type app already has it preconfigured and you would use it only in custom apps which are written by Java developers anyway, who would benefit from using the class names more than arbitrary aliases. These could even introduce inconsistency in configuration.

We were motivated because we saw it in our own defs, but we'd better start using content-type apps with decorations instead.

PM input: We still have a lot of users who write content apps not using content type app generation, so this would still be beneficial


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