[DOCU-1751] Module page for the UI project Created: 01/Nov/18  Updated: 23/Nov/18  Resolved: 20/Nov/18

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

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

Template:
Acceptance criteria:
Empty
Task DoR:
Empty
Date of First Response:
Epic Link: UI-framework-6.0-developer-preview
Sprint: Docu Sprint 62, Docu Sprint 63
Story Points: 3

 Description   

Intro

Create a Module page for the UI project. 

The UI project contains a bunch of subreactors / submodules. In current docs below the List fo modules we a limited and arbitrary selection of a few submodules:

We should replace these 2 pages with one new UI module page.


Content

Minimum:

  • Installing
    • Note that the UI project is always part of all predefined mgnl webapps.
    • Show how to add the maven dependencies as it was done on the pom file of the empty-webapp to see how it must be added
  • List / table of submodules

NIce to have:

  • Using UI modules for custom modules
    • Provide a "short" list of use cases explaining which Magnolia UI submodule whould be used for what purpose. Possible examples:
      • custom content app
      • ...
    • Explain that custom module should declare both dependencies
      • for Maven modules in the pom file
      • For Magnolia modules in the module descriptor file
      • The fs-browser app is a first possible example to show snippets from the pom file and the module descriptor
        •  however, it is using the "old" ui framework
    •  This section does not have to show fully fledged examples. 

 



 Comments   
Comment by Christoph Meier [ 02/Nov/18 ]

Ongoing work: https://documentation.magnolia-cms.com/display/DOCS60/UI+module

Comment by Christoph Meier [ 20/Nov/18 ]

Mika has reviewed the (included) list of modules.

Comment by Christoph Meier [ 20/Nov/18 ]

I have moved two "old" ui module pages to cemetery. 

  1. https://documentation.magnolia-cms.com/display/DOCS60/UI+Admincentral+module
  2. https://documentation.magnolia-cms.com/display/DOCS60/UI+Framework+module 

(1) is old, and the info required is given on the new page https://documentation.magnolia-cms.com/display/DOCS60/UI+module 

(2) Contains only limited and slightly outdated info. Again, the necessary info is given on the new UI module page.

The also already existing page https://documentation.magnolia-cms.com/display/DOCS60/UI+Media+Editor+module is now a child page of the new UI module page.

I have created a follow-up - DOCU-1778 - for a more detailled page about the ui-framework module, which we can tackle once the development of ui-framework, ui-framework-JCR and ui-framework-REST is completely finished.

 

Comment by Christoph Meier [ 20/Nov/18 ]

The 2nd part mentioned in the description - Nice to have - of this ticket won't make it.

We do not have enough time, probably it is too early, and probably the module page is the wrong place for such hints / ideas / instructions.

Comment by Christoph Meier [ 22/Nov/18 ]

mdrapela - With one of yesterdays commits from Sasha , the media editor module also has been "ditched":

  • Maven wise it has become a Maven redirect
  • Its classes have been moved to the compatibility module.
    This said, I think about also ditching its module page.

However, I must analyze it a bit more and have a look at the latest bundle.
E.g. I wonder whether the config weorkspace still comes with the config as showed there => https://documentation.magnolia-cms.com/display/DOCS60/UI+Media+Editor+module#UIMediaEditormodule-Configuration

Comment by Martin Drápela [ 23/Nov/18 ]

It does come with the config ^^ as in 5.7, at least in yesterday's bundle.

Yes,  it does indeed.

Since it isn't anymore a Maven module, I'd like to ditch https://documentation.magnolia-cms.com/display/DOCS60/UI+Media+Editor+module. We have no module page for non Maven modules afaik.

But the config on that page seems still relevant. So I need to figure out where to move it to.

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