[MGNLUI-5836] Reiterate over type aliases Created: 23/Apr/20  Updated: 17/Dec/21

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

Type: Task Priority: Neutral
Reporter: Roman Kovařík Assignee: Unassigned
Resolution: Unresolved Votes: 0
Labels: needs-discussion, ui-devx-impr
Remaining Estimate: 0.25d
Time Spent: 34m
Original Estimate: Not Specified

Issue Links:
Relates
relates to PAGES-548 Create $type annotation for SpaRender... Closed
relation
is related to MGNLREST-279 Create $type annotation for Delivery ... Closed
Template:
Acceptance criteria:
Empty
Task DoR:
Empty
Documentation update required:
Yes
Date of First Response:
Epic Link: Simplify YAML configuration

 Description   

A tech discussion can take place where to agree on the strategy to follow. This will affect the work that will need to be done. See options section

Problem statement

When documenting the type aliases, we've realised we have

  • missing aliases
  • inconsistent naming, such as prefixed aliases (e.g. contentDepedencies:field)
  • redundant aliases (classes which are just abstract classes, e.g. jcrNodeProvider)

Options

The aim was to simplify the configuration by easily remembering simply named aliases.
It makes it hard for the user to choose the correct one among huge number of aliases.

The DOCu point of view is that we should have aliases only for reusable definitions, typically generic JCR, JSON apps. Not for definitions scoped to custom apps - pages, tasks, notifications, definitions, addons...).

  • Considering covering the module-specific definitions with aliases as well - this would require name-spacing them.
    • pro: leaner, more declarative yamls, more freedom with renaming and moving around classes
    • con: some of these aliases won't be used anywhere - will they be documented? This creates overhead.


 Comments   
Comment by Christopher Zimmermann [ 19/Oct/20 ]

Adjacent but related to the description: All commonly used classes in the main definition types should have aliases. Such as SPARenderer in page definition. RestClients. RestEndpoints (and referenceResolvers), VirualURI etc.

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