[DOCU-1676] Rewrite "My first content app" tutorial Created: 31/Aug/18 Updated: 23/Nov/18 Resolved: 12/Oct/18 |
|
| Status: | Closed |
| Project: | Documentation |
| Component/s: | None |
| Affects Version/s: | None |
| Fix Version/s: | 6.0 |
| Type: | Story | Priority: | Major |
| Reporter: | Christoph Meier | Assignee: | Martin Drápela |
| Resolution: | Done | Votes: | 0 |
| Labels: | None | ||
| Remaining Estimate: | Not Specified | ||
| Time Spent: | Not Specified | ||
| Original Estimate: | Not Specified | ||
| Issue Links: |
|
||||||||||||||||||||||||||||
| Template: |
|
||||||||||||||||||||||||||||
| Acceptance criteria: |
Empty
|
||||||||||||||||||||||||||||
| Date of First Response: | |||||||||||||||||||||||||||||
| Epic Link: | UI-framework-6.0-developer-preview | ||||||||||||||||||||||||||||
| Sprint: | Docu Sprint 59, Docu Sprint 60, Docu Sprint 61, Docu Sprint 62, Docu Sprint 63 | ||||||||||||||||||||||||||||
| Story Points: | 13 | ||||||||||||||||||||||||||||
| Description |
|
Rewrite the tutorial "My first content app". Compared to the old version - which is done with a Magnolia Maven module, the new tutorial will be rather different. Here are some key points of the new approach:
|
| Comments |
| Comment by Christoph Meier [ 03/Sep/18 ] |
|
Currently the examples used among Content types (CT) ref. pages are there: The repo content-type-examples contains 4 content type definition, and for all of them there is an app definition too.
|
| Comment by Julie Legendre [ 16/Oct/18 ] |
|
JL review paused. My main concern is the structure: for a beginner's tutorial, i find there is a too much reading to do before actually doing something. Commented with suggestions on the tutorial pages. Will pick up the review if / when the structure is changed. |
| Comment by Christoph Meier [ 24/Oct/18 ] |
|
I have read again the tutorial and also have tried it out following the instructions. I have added a few inline comments, but these are basically minor things. I like it! When it comes to tailoring the app: A few things could have been done on the CT def. instead of doing it in the app descriptor. However, the focus here is the app, thus fine. One remark concerning the provided content: Thinking about reusing the outcome of this example which may become the base for other tutorials (as mentioned in the description of the ticket): |
| Comment by Christoph Meier [ 25/Oct/18 ] |
|
Concerning the content structure. Have a look at the assets app. There we have something like: It is not starting with: Every JCR workspace has indeed a root node - it is just never displayed. Data wise I see no good reason to have the My-Good-Reads But fine. Let's see what Julie means. |
| Comment by Julie Legendre [ 31/Oct/18 ] |
|
Language review done. A few outstanding comments in the pages (mdrapela). I "unhid" some of the explanation expandables. I think they are essential for the user to understand the tutorial. |