[DOCU-1712] Rewrite "Creating a custom bundle" tutorial Created: 25/Sep/18  Updated: 14/Feb/19  Resolved: 23/Jan/19

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

Type: Story Priority: Neutral
Reporter: Christoph Meier Assignee: Christoph Meier
Resolution: Done Votes: 0
Labels: tutorial
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Issue Links:
relation
is related to DOCU-1737 Refine "Configuring a custom bundle" Closed
is related to DOCU-1629 Trim the "Configuring a custom bundle... Open
Template:
Acceptance criteria:
Empty
Date of First Response:
Epic Link: Tutorials-for-M.6.0
Sprint: Docu Sprint 66, Docu Sprint 67, Docu Sprint 68
Story Points: 5

 Description   

current version: https://documentation.magnolia-cms.com/display/DOCS60/Creating+a+custom+bundle
=> The version is not wrong or super outdated, but there are a few things which we should change when compared to the current 6.0 version and all older versions which are similar:

  • It proposes to take the empty-webapp as base. That's sometimes fine but rather as an exception.
    Instead we the first choices should be magnolia-community-webapp or magnolia-enterprise-pro-webapp
    • Generally we should explain all possibilities as proposed by the created pom files, which are:
      • magnolia-empty-webapp
      • magnolia-community-webapp
      • magnolia-enterprise-standard-webapp
      • magnolia-enterprise-pro-webapp
  • No more screenshots from IDE windows
  • Show better ways how to start the custom webapp

 Exact structure to be further defined



 Comments   
Comment by Christoph Meier [ 23/Jan/19 ]

Result:

https://documentation.magnolia-cms.com/display/DOCS60/Creating+a+custom+webapp+with+Maven

Ready for reviews. 

DEV-1117 has been created for the tech. review.

Comment by Christoph Meier [ 23/Jan/19 ]

As commented already on DOCU-1629:

When https://documentation.magnolia-cms.com/display/DOCS60/Creating+a+custom+webapp+with+Maven will be public; I will hide (send to cemetery) https://documentation.magnolia-cms.com/display/DOCS60/Configuring+a+custom+bundle - which is a follow-up pf the "old" Creating a custom bundle , which is the predecessor of Creating a custom webapp with Maven.

Configuring a custom bundle needs an overhaul too, which will be tackled with DOCU-1629

Comment by Martin Drápela [ 01/Feb/19 ]

Reviewed.

Main change - the original page seemed too long to me so I broke it down to three pages, a main page and two example pages:

https://documentation.magnolia-cms.com/display/DOCS60/Creating+a+custom+webapp+with+Maven

Comment by Christoph Meier [ 13/Feb/19 ]

mdrapela - F.Y.I.

Thanks again for the review.
I rename
Creating a minimal headless webapp with Maven to
Creating a minimal webapp with Maven.
The headless thingy here is just an example use case without having properly researched whether my proposed list of modules is fine for headless. The topic is the minimal webapp w/ Maven.

Comment by Christoph Meier [ 13/Feb/19 ]

Finalizing tasks:

On DOCS60

  • deleted old "Creating a custom bundle"
  • fixed Links; pointing to the new page
  • Deleted "Configuring a custom bundle" (reason: see above, 2nd comment)

On DOCS61: copy the new pages; then the same link edits and deletions as on DOCS60

Comment by Christoph Meier [ 14/Feb/19 ]

Finally closing this one.

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