[CORE-8] Suggestions for improvements to installation documents Created: 21/May/09 Updated: 05/Jun/14 Resolved: 23/May/14 |
|
| Status: | Closed |
| Project: | i2b2 Core Software |
| Component/s: | Documentation, Install |
| Affects Version/s: | 1.3.00 |
| Fix Version/s: | 1.7.00 |
| Type: | Documentation | Priority: | Major |
| Reporter: | D Ahn | Assignee: | Janice Donahoe |
| Resolution: | Completed | Votes: | 1 |
| Labels: | None | ||
| Remaining Estimate: | Not Specified | ||
| Time Spent: | Not Specified | ||
| Original Estimate: | Not Specified | ||
| Rank: | 0|i001fb: |
| Participant/s: |
| Description |
|
In the process of installing i2b2 from the source distributions, I have compiled a few suggestions for improving the installation documentation. 1. The "Required Software" section of the "Prerequisites" chapter in each of the Cell installation guides should be deleted and replaced simply with "This Application Cell requires that the Hive be installed according to the Hive Installation Guide." Currently, the reiteration of the JDK/Jboss/Tomcat/etc installation process could confuse the less informed user. 2. In the aforementioned "Required Software" sections, some guides refer to a CVS source code repository. This information should be added to the Hive Installation along with details about the CVSROOT, CVS_RSH and other CVS client configuration and credentials to actually access the CVS repository. As it stands, the information is incomplete. 3. Most documents contain inconsistencies in the example web service URL, datastore configuration or other property settings which can confuse the less informed user. For example, the Data Installation Guide initially suggests the database user "i2b2demodata" and password "i2b2demodata" in section 2, but subsequently shows password "i2b2demodata_pswd" in section 2.4, and actually uses "i2b2demodata_pswd" in the i2b2demodata-13.zip distribution. These inconsistencies should be corrected. 4. Related to #3, the source distribution should work "out of the box" if the installation instructions are followed to the letter with no changes to the defaults (assuming ports are available, Jboss/Tomcat are installed into the suggested directories, etc.). |
| Comments |
| Comment by Tony Black [ 16/Jun/09 ] |
| I am adding to list what appears to be a documentation error. In document "Data_Installation_Guide_1-3.pdf" on page 3 the database name to be created and associated with user "i2b2hive" is listed as "i2behive", which we believe to be an error (Tony Black, University of Washington, tblack@u.washington.edu) |
| Comment by D Ahn [ 09/Jul/09 ] |
|
Additionally, the i2b2core-doc-13.zip contains the following duplicates: i2b2core-doc-13/CRC Installation Guide_1_3.pdf and i2b2core-doc-13/CRC_Installation Guide_1_3.pdf. i2b2core-doc-13/Ontology Installation Guide_1-3.pdf, i2b2core-doc-13/Ontology_Installation Guide_1-3.pdf and i2b2core-doc-13/Ontology_Installation_Guide_1-3.pdf. i2b2core-doc-13/Workplace Installation Guide_1-0.pdf and i2b2core-doc-13/Workplace_Installation_Guide_1-0.pdf. Also, the file i2b2core-doc-13/PFT_Architecture_1-0.pdf is outdated; a newer PFT_Architecture_1-2.pdf is available for direct download. Finally, the i2b2core-doc-13.zip contains some documents that are named differently from the direct downloads (e.g. i2b2core-doc-13/PM_Architecture_1.0.pdf vs. Project_Management_Architecture_10.pdf). For consistency, it would be best to have the same name so that unzipping i2b2core-doc-13.zip into the same directory as direct downloaded files will not cause duplicate files with different names. |
| Comment by Mike Mendis [ 12/May/14 ] |
| install docs now part of the wiki |
| Comment by Janice Donahoe [ 23/May/14 ] |
| New installation document has been added to the i2b2 Community Wiki page. |