[DOCU-127] ensure documentation makes it clear which modules are supported with EE Created: 17/Feb/11  Updated: 30/Dec/14  Resolved: 30/Dec/14

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

Type: Task Priority: Neutral
Reporter: Boris Kraft Assignee: Antti Hietala
Resolution: Fixed Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Issue Links:
dependency
depends upon STORE-27 Create a module list template for doc... Open
Template:
Acceptance criteria:
Empty
Task DoR:
Empty
Date of First Response:

 Description   

The modules overview http://documentation.magnolia-cms.com/modules.html lists some modules which are undocumented and some are apparently not even released (or only as snapshots). Case in point is NTLM; but also "portlet bridge" and "BDB persistence manager".

We need to make clear which modules are actually supported with the EE and which are only prototypes and are unsupported. Maybe we can link to the store or (better) display store contents on the module page and state clearly that the store is the master regarding support and release state?

As a first step I recommend to discuss the current state of all EE modules with Philipp and update the module overview page. Clearly state the modules which are not supported.



 Comments   
Comment by Antti Hietala [ 19/Apr/11 ]

Create a module table that has the columns and information we want to display. Do it manually first, then automate by pulling the information from the same source as Magnolia Store does.

Comment by Jan Haderka [ 24/May/11 ]

as i see it ...
supported:
imaging
magnolia-jndi
magnolia-ldap
magnolia-migrator (to migrate from 2.1 to 3.0)
magnolia-advanced-cache
magnolia-module-backup
magnolia-module-categorization
magnolia-module-commenting
magnolia-module-content-dependencies
magnolia-module-content-translation-support
magnolia-module-diff
magnolia-module-exchange-transactional (xa activation)
magnolia-module-extended-templating-kit
magnolia-module-ntlm
magnolia-module-packager
magnolia-module-soft-locking
magnolia-module-synchronization (NOT YET RELEASED, BUT SUPPORTED, RELEASE PENDING IN FEW WEEKS)
magnolia-module-translation-helper
magnolia-module-weblogic
magnolia-module-websphere
magnolia-tools
newsletter

not actively developed, (supported on older versions ... the developer should decide, how much effort it is to support it on latest)
magnolia-addressbook (developed by tom, last release against 3.6.1, current trunk against 4.3.1)
magnolia-module-cas (by greg, last release against 3.5.2, current trunk againsts 3.5.8)
magnolia-module-imagegallery (by greg, last release against 3.5.2, current trunk againsts 3.5.8)
magnolia-module-sitedesigner (by tom, last release & trunk against 4.1.1)

not supported since 4.0:
magnolia-bdb
magnolia-crx
magnolia-portlet-bridge

prototypes/samples (just one release or snapshot, not actively developed or maintained)
magnolia-integration-spring (snapshot against 3.5)
magnolia-integration-wicket (snapshot against 3.5)
magnolia-module-modifystream (snapshot against 3.6)
magnolia-module-shorturl (snapshot against 3.6)

Comment by Antti Hietala [ 24/May/11 ]

Synched EE module list on documentation site with Jan's remarks.

Outliers to check with Philipp:

  • Blog. No public release.
  • Excel renderer. Community module. Only snapshot.
  • Poll. Community module. Only snapshot.
  • Shell. Community module. Only snapshot.

We also need to define "Enterprise module". It does not mean "included in EE bundle" because not all modules are readily bundled (Blossom). It also does not mean "supported by Magnolia International" because not all modules are supported (CRX Connector) or they are not supported by us (SimpleMedia).

Comment by Jan Haderka [ 25/May/11 ]

Enterprise Module means module that needs Enterprise license to run. Any module that we do not give away for free.

Some modules like the CRX Connector, SiteDesigner we supported in the past, but due to lack of interest from customers or due to other reasons we decided not to support anymore. Still those were enterprise modules as they required EE license to run.

The blog module was written originally as PoC. We didn't pursue release of that module since we didn't win the project. However module is/was used by someone else in the past ... i remember seeing messages about it in the user list.

Comment by Antti Hietala [ 25/May/11 ]

Enterprise Module means module that needs Enterprise license to run. Any module that we do not give away for free.

This means I should remove all free modules from Enterprise modules. Blossom for example should go to a new "Free modules" list.

Comment by Jan Haderka [ 25/May/11 ]

yes, the only EE modules we have are those I listed above.

Comment by Boris Kraft [ 01/Jun/11 ]

I like the first table, very well done.
The second and third table all contain modules that may be run with CE or EE.
Ultimately, the store should be the resource for community-developed modules, as documentation will have no documentation about them anyways. So you could list in a second table all modules Magnolia has developed that are not EE only (they are in the first table); then state for each of these if it is supported with EE or not.
Finally, a third table could list community-developed modules or simply point to the store for further modules (which for the sake of maintenance ease is what I would suggest). Eventually Greg will define a view/query that returns this data from the store to be embedded directly.

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