Uploaded image for project: 'Magnolia UI'
  1. Magnolia UI
  2. MGNLUI-5836

Reiterate over type aliases

    XMLWordPrintable

Details

    • Task
    • Resolution: Unresolved
    • Neutral
    • None
    • None
    • None

    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.

      Checklists

        Acceptance criteria

        Attachments

          Issue Links

            Activity

              People

                Unassigned Unassigned
                rkovarik Roman Kovařík
                Votes:
                0 Vote for this issue
                Watchers:
                2 Start watching this issue

                Dates

                  Created:
                  Updated:

                  Checklists

                    Task DoR

                    Time Tracking

                      Estimated:
                      Original Estimate - Not Specified
                      Not Specified
                      Remaining:
                      Time Spent - 34m Remaining Estimate - 0.25d
                      0.25d
                      Logged:
                      Time Spent - 34m Remaining Estimate - 0.25d
                      34m