[DOCU-1737] Refine "Configuring a custom bundle" Created: 19/Oct/18  Updated: 23/Jan/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: Unassigned
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-1712 Rewrite "Creating a custom bundle" tu... Closed
Template:
Acceptance criteria:
Empty
Epic Link: Tutorials-for-M.6.0

 Description   

"History"

Configuring a custom bundle (cacp) is the 2nd part of a bundle tutorial series - both part originate from blog posts from Grégory Joseph. (Blog post have ben deleted, I have been figured out recently).
This page (cacp) describes explains two "tricks":

"turning" a webapp into a Magnolia module

which can have a module version handler and a module descriptor.
I always liked that one.

However, the next one seems much more important, since people ask for it now and then.

usage of module version handler

It starts with the section Customizing configuration by code and explaining usage of module version handler class.
This section is most probably the only "useful" source concerning module version handling among the complete docs. It shows with minimal examples
how you can execute tasks (typically changing JCR config) 

  • during installation
  • during update

Tasks

Minimum

  • Write a new page Using module version handler
    • Reusing section Customizing configuration by code of the cacp page
    • Title, intro should contain terms module version handler, configure module to boost them for google search
    • rather not mentioning "turning" a webapp into a Magnolia module on this new page.

Open Question(s) 

  • Should we keep the above described 1st part?  Should we create a distinct page "Turning a webapp into a Magnolia module"?
  • Is the content of Customizing configuration by code of the cacp page enough for the new page Using module version handler?

..



 Comments   
Comment by Christoph Meier [ 19/Oct/18 ]

jschulte recently was asking for module version handler docs for Deutsche Bahn developers.
The only link I could offer was this:
https://documentation.magnolia-cms.com/display/DOCS57/Configuring+a+custom+bundle#Configuringacustombundle-InstallTask

Jan also said that these docs may be sufficient, and that the DB devs were not able to find docs for the topic. We will improve searchability with a new distinct page.

Jan, do you think we also should keep the part about  "Turning a webapp into a Magnolia module"?(see description of the ticket).

Comment by Christoph Meier [ 23/Jan/19 ]

This seems to superseed DOCU-1629.

 

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