[MGNLUI-4986] DOC: SubAppDescriptor API Created: 01/Feb/19  Updated: 13/Jun/19  Resolved: 13/Jun/19

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

Type: Task Priority: Major
Reporter: Christoph Meier Assignee: Ashraf Khamis
Resolution: Done Votes: 0
Labels: app-configuration, content-app, new-UI-framework
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Issue Links:
Relates
relates to MGNLUI-4470 Allow definition of DataSource in Con... Closed
relates to MGNLUI-5067 DOC: How to define datasource for Con... Closed
Template:
Acceptance criteria:
Empty
Task DoR:
Empty
Date of First Response:
Epic Link: DOC: Documentation for Magnolia 6.1
Sprint: Foundation 12, 6.1 Release Sprint
Story Points: 3

 Description   

Overview

Create a new page for SubAppDescriptor for the new UI framework (and keep the one for the old framework). The Subapp descriptor page for Magnolia 5 UI can serve as an inspiration: https://documentation.magnolia-cms.com/display/DOCS61/Subapp+descriptor.

The biggest change is the use of the datasource (rather than the contentConnector) property.

Pages to create

  • Subapp descriptor

NOTE

Content editor subapp descriptor does not use the new framework, so it is irrelevant to cover it as part of Magnolia 6 UI.

New definition classes

  • BrowserDescriptor (info.magnolia.ui.contentapp.configuration.BrowserDescriptor)
  • DetailDescriptor (info.magnolia.ui.contentapp.detail.DetailDescriptor)

IMPORTANT NOTE

To define the datasource property with SubAppDescriptor, you have to use the info.magnolia.ui.contentapp.configuration.ContentSubAppDescriptor class.

For more context, see MGNLUI-4470.



 Comments   
Comment by Ashraf Khamis [ 13/Jun/19 ]

As agreed with Julie, a full general subapp descriptor page was created at https://documentation.magnolia-cms.com/display/DOCS61/Subapp+descriptor+-+6+UI despite the fact that there is no fundamental change to subapp descriptor in the Magnolia 6 UI framework as pointed out by Sasha. We decided to look past the 6.1 release and create a page that can be used to later replace the subapp descriptor page for the old framework (as this was to be done anyway). The page was reviewed by Robert and Adam.

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