[DOCU-74] Consolidate module installation instructions Created: 18/Nov/10  Updated: 05/Nov/12  Resolved: 24/Feb/12

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

Type: Improvement Priority: Major
Reporter: Andreas Weder Assignee: Antti Hietala
Resolution: Fixed Votes: 0
Labels: documentation
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Attachments: Microsoft Word EnterpriseCommunity-compariosn.xlsx    

 Description   

There's currently module installation instructions in several places and of differing levels of details. While the STK installation instructions for the bundle distribution are very detailed, but target only Tomcat, the generic module instructions could be more specific depending on which platform and app server you install on.

While working on MAGNOLIA-3387, we've added a specific installation link to every README for of a module, pointing to the module description in the reference section of the Magnolia documentation site I'm thus assigning this issue a somewhat high priority since these README files already create some visibility.

We discussed the following improvements:

  • create a more detailed, generic module installation description, similar to STK installation instructions, but targeting all typical platforms and app servers
  • reference this description from all installation instructions of every individual module
  • remove all inaccurate and no longer applicable instructions at the same time.

References:



 Comments   
Comment by Ruth Stocks [ 02/Jan/11 ]

I have done the following:

  1. standardized the Installing, Uninstalling and Download paragraphs on all pages (except Sitedesigner and In-stream modification). I also did a bit of editing in the introductory paragraphs.
  2. You may find the attached spreadsheet useful. Please see summaries at line 60 and 75 re possible missing pages, pages that are no longer relevant and a few anomalies that I picked up
  3. added main module pages for the Content Dependencies, Content Translation Support, Diff and Soft-locking modules. All I added was Installing, Uninstalling, Download paragraphs and an edited version from Magnolia store for the introduction.
  4. I moved the synchronization page content into a single paragraph, but have left the original paragraphs in case you prefer the pages sub-divided.
  5. Blossom - reformatted and restructured the contents to bring into line with the others
  6. Shell - changed the page name to Groovy Shell.
  7. Magnolia Tools - changed the page name to Tools

Questions and observations:

  1. JNDI - are the standard Uninstalling instructions relevant. Seems it may be more complex than this?
  2. In-place Templating - refers to Intro to templating page - not sure of the relevance?
  3. In-stream modification - has this been replaced by URI mapping?
  4. LDAP - refers to two other modules in ‘Available LDAP modules’ section that are not available on installation - may be a bit confusing?
  5. observation - module is not in the /lib folders like all the others, but it is installed in my installation -(Config /modules/observation) - is it installed in the same way as the other modules? Is it part of CE - have assumed it is but not sure
  6. shell(groovy) - this is the only non-Magnolia module for which there is a modules page
  7. sitedesigner - do we still offer this module
  8. tools - refers to a collection of tools but describes only one
  9. transactional activation - there is no modules page for simple activation - magnolia-module-exchange-simple-4.4.1
Generated at Mon Feb 12 01:05:40 CET 2024 using Jira 9.4.2#940002-sha1:46d1a51de284217efdcb32434eab47a99af2938b.