[MGNLUI-4989] DOC: JcrDatasourceDefinition API Created: 01/Feb/19  Updated: 26/Sep/19  Resolved: 03/Apr/19

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

Type: Task Priority: Neutral
Reporter: Christoph Meier Assignee: Christoph Meier
Resolution: Fixed Votes: 0
Labels: Datasource, content-app, new-UI-framework, new-data-binding
Remaining Estimate: 0d
Time Spent: 1h
Original Estimate: Not Specified

Issue Links:
Relates
relates to MGNLUI-5098 DOC: previewDefinition property of Jc... Closed
relates to MGNLUI-5396 DOC: JSON data source Closed
relation
is related to MGNLUI-4988 DOC: datasource (API) Closed
is related to DOCU-1875 LANG: review "JcrDatasourceDefinition... Closed
Template:
Acceptance criteria:
Empty
Task DoR:
Empty
Date of First Response:
Epic Link: DOC: Documentation for Magnolia 6.1
Sprint: Foundation 7
Story Points: 2

 Description   

Write an API page / aka reference page for the "most prominent" example of DatasSource bundle - the JcrDatasourceDefinition.

Definition tem class info.magnolia.ui.datasource.jcr.JcrDatasourceDefinition.

 


Note:
I see this as the most urgent DOC topic in the context of data-binding and new ui framework.

At some point we also need docs about the data source generally:

  • reference page for the DataSource API, MGNLUI-4988
  • A key concept page explaining the data source concept , MGNLUI-4987
  • But, yeah, the JcrDatasourceDefinition API imho is most urgent, since this will be required in the most use cases.

 

Edit: previewDefinition is excluded now from this ticket - will be tackled as a follow-up, see MGNLUI-5098

 



 Comments   
Comment by Saimir Gasa [ 11/Feb/19 ]

cmeier - the reason why I removed the 6.1 fix version is because this task is not in the backlog and I don't know if it's in the scope of 6.1 yet. If/once it is determined to be included in the 6.1 release then the fix version would be added.

Comment by Christoph Meier [ 25/Mar/19 ]

rsiska - I see that the ticket has the value Foundation 7 on the field Sprint  ... but I still cannot see it on the sprint.
I guess it must be SELECTED? I have clicked the ACCPETD button ... but now it it not selected but accepted.

Who must set it to selected? Does somebody disagree that I work on this?

Comment by Christoph Meier [ 25/Mar/19 ]

It turned out that the preview property of the JcrPreviewDefinition currently is not working.
Hence i leave out the part for preview and create a follow-up DOC:ticket.
According to Roman, MGNLUI-5060 should fix the issue with the currently not working preview.
And besides that, there is also a certain chance, that the preview definition becomes more simply (currently it is mandatory).

Comment by Christoph Meier [ 26/Mar/19 ]

RESULT:
https://documentation.magnolia-cms.com/display/DOCS61/JCR+data+source+definition
Ready for a technical review.

Comment by Christoph Meier [ 03/Apr/19 ]

Tech. review done by Robert.
Lang. review will be tackled in the context of the DOCU board, see DOCU-1875. Hence I close this one.

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