[DOCU-929] Rewrite or replace (old) 'Hello Magnolia' using CLI to full extent Created: 30/Jan/17  Updated: 03/Jul/17  Resolved: 15/Jun/17

Status: Closed
Project: Documentation
Component/s: None
Affects Version/s: None
Fix Version/s: None

Type: Story Priority: Neutral
Reporter: Julie Legendre Assignee: Martin Drápela
Resolution: Done Votes: 0
Labels: cli, core, tutorial
Σ Remaining Estimate: Not Specified Remaining Estimate: Not Specified
Σ Time Spent: Not Specified Time Spent: Not Specified
Σ Original Estimate: Not Specified Original Estimate: Not Specified

Sub-Tasks:
Key
Summary
Type
Status
Assignee
DOCU-1033 Planning rewriting "Hello Magnolia" Sub-task Closed Martin Drápela  
Template:
Acceptance criteria:
Empty
Date of First Response:
Sprint: Docu Sprint 26, Docu Sprint 27
Story Points: 13

 Description   

The tutorial should replace the current hello magnolia tutorial.
Hello Magnolia
has become old - it originates from the days of the 5.4 release.

Be aware that there is also another, smaller, newer version called
Hello Magnolia for front-end developers

Things which are clear so far

  • Use CLI wherever it makes sense
  • There is no more "If you use CLI, do it that way. If not using CLI, do it this way". Avoid explaining the same thing with 2 approaches.
  • Keep the existing example(s) whenever possible; there is no reason to figure out new ones.
  • Example wise the following things are clear:
    • Create a new light module
    • Create a new page template
    • Create a new component template - to be used on the new page template

Even if we will use CLI wherever possible - the main focus of this tutorial is

  • "Getting started with Magnolia"
  • Understanding some core principles of templating
  • Using CLI is not the main aim - CLI is just a means to an end.

Things which have not yet been decided:

  • Should we again use a static prototype file as a precursor of the new page template?
    • It is still a very valid use case.
    • It includes a lot of manual work - which is however helpful to learn magnolia
    • It is still possible to do the static prototype first ... then creating a page template via script ... but then adapting the per script generated files by copying parts of the static prototype file
  • How deep do we go in explaining things which are done via CLI commands, which we have explained "in detail" in the old version

Generated at Mon Feb 12 01:13:36 CET 2024 using Jira 9.4.2#940002-sha1:46d1a51de284217efdcb32434eab47a99af2938b.