-
Task
-
Resolution: Done
-
Neutral
-
None
-
None
-
None
-
-
Empty show more show less
-
Empty show more show less
-
Docu Sprint 62, Docu Sprint 63
-
3
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:
- https://documentation.magnolia-cms.com/display/DOCS60/UI+Admincentral+module
- https://documentation.magnolia-cms.com/display/DOCS60/UI+Framework+module
- https://documentation.magnolia-cms.com/display/DOCS60/UI+Media+Editor+module
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
- parent reactor with gruouId and artifactId
- List all Maven subreactors with
- artifactId
- Short description (one sentence) of the subreactor.
- Magnolia module(s) (names) which are wrapped by the given maven subreactor
- Mark subreactors which belong to "old" or to the "new" UI framework (introduced with version 6.0)
- Write the table in an includable page to be reused within https://documentation.magnolia-cms.com/display/DOCS60/Changes+on+the+Magnolia+UI+framework+6.0
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.
- Provide a "short" list of use cases explaining which Magnolia UI submodule whould be used for what purpose. Possible examples:
Acceptance criteria