Uploaded image for project: 'Documentation'
  1. Documentation
  2. DOCU-1629

Trim the "Configuring a custom bundle" tutorial to focus on version handlers

    XMLWordPrintable

Details

    • Task
    • Resolution: Unresolved
    • Neutral
    • None
    • None
    • None

    Description

      I think we should rename the “Configuring a custom bundle” page. For example to:  “Managing configuration with Version handlers and update tasks”

      https://documentation.magnolia-cms.com/display/DOCS57/Configuring+a+custom+bundle

       

      I think it would be helpful to split the tutorial, or remove some information of the tutorial to another document. This would make the tutorial shorter and more focussed on one topic, the version handler.

      Most important to remove:

      The intro of "Convert your project module into a Magnolia module."

      Create a module descriptor

      (They are not that relevant to the new topic focus - and therefore add weight and complexity)

       

      Possibly also remove:

      "Terminology: module" box.

      (Not that relevant)

      "Adding fs-browser-app"

      The tutorial is now about the version handlers - we could just give them a starter bundle with the fs-browser-app already in it. It would make the tutorials more independent. It would make the tutorial shorter and less complex.

      (The information of how to add modules to a bundle is already covered in: "Creating a custom bundle" https://documentation.magnolia-cms.com/display/DOCS57/Creating+a+custom+bundle)

       

      Using the removed content

      I could see a new tutorial "Create a magnolia maven module" or "Create a Magnolia Java-based module". Which could include some or all of this content.

      Currently in the documentation I only see this section on the "Module Structure" page. 

      https://documentation.magnolia-cms.com/display/DOCS57/Module+structure#Modulestructure-CreatingaMagnoliaMavenmodulewithMavenarchetypes

      This topic would deserve a page or tutorial of its own.

       

       

       

       

       

       

      Checklists

        Acceptance criteria

        Attachments

          Issue Links

            Activity

              People

                Unassigned Unassigned
                czimmermann Christopher Zimmermann
                Votes:
                0 Vote for this issue
                Watchers:
                3 Start watching this issue

                Dates

                  Created:
                  Updated:

                  Checklists

                    Task DoR