[MGNLSTK-332] Supersonic bundle contains no installation instructions Created: 24/Mar/09 Updated: 23/Jan/13 Resolved: 20/Dec/10 |
|
| Status: | Closed |
| Project: | Magnolia Standard Templating Kit (closed) |
| Component/s: | None |
| Affects Version/s: | 1.0 |
| Fix Version/s: | 1.4.1 |
| Type: | Bug | Priority: | Major |
| Reporter: | Boris Kraft | Assignee: | Philipp Bärfuss |
| Resolution: | Fixed | Votes: | 0 |
| Labels: | None | ||
| Remaining Estimate: | Not Specified | ||
| Time Spent: | Not Specified | ||
| Original Estimate: | Not Specified | ||
| Template: |
|
| Acceptance criteria: |
Empty
|
| Date of First Response: |
| Description |
|
please add an install file to the bundle which states that how to install it |
| Comments |
| Comment by Magnolia International [ 24/Mar/09 ] |
|
For the record, like all other modules, the README.txt currently states: More information about this project can be found at :
http://stk.magnolia-cms.com
If an INSTALL.txt file is present in this package, it should
help you getting started.
Also http://documentation.magnolia.info/modules/standard-templating-kit.html provides (very basic) install instructions. We've gradually got rid of the INSTALL.txt files, to avoid having 2 places to maintain (files and docu site), so maybe the stk info page could link/reproduce the install instructions instead ? |
| Comment by Boris Kraft [ 24/Mar/09 ] |
|
Yes, I have read the README, and that is why I was missing specific instructions. I understand your reasoning, however right now it is hard for a novice user to get the STK installed, not because it is technically hard, but because quite a number of steps are needed that are not even well documented. May be can state in the README that the jars have to be dropped into the WEB-INF/lib folder and the app restarted? That would already be a big improvement. In any case, the official module docu has to be improved, such that a link from stk.m.com is justified. As a side note, the module store concept and standalone bundle would both provide a much better user experience, hence the current steps are temporal solutions - nonetheless, we should improve the current experience as much as we can. |
| Comment by Magnolia International [ 24/Mar/09 ] |
|
True, we could include the generic module installation procedure .. in all module READMEs in fact. (the drawback being that users probably won't check in the module's docu for extra notices) Totally agree on the side note, of course |
| Comment by Boris Kraft [ 24/Mar/09 ] |
|
Well, we could add the generic instructions, and point to the module installation page for more details - this way we have the best of both worlds. |
| Comment by Andreas Weder [ 20/Dec/10 ] |
|
We've reworked all README.txt file to contain proper links to installation instructions. For the Supersonic bundle/STK module, this link now points to the proper installation instructions at http://documentation.magnolia-cms.com/modules/standard-templating-kit.html |