Merge lp:~mbruzek/charms/trusty/was-base/readme-suggestions into lp:~ibmcharmers/charms/trusty/was-base/trunk

[Matt Bruzek]

These are my suggestions on how to make the was-base README better. I fixed the markdown errors and spelling problems, and added more information where needed.

This is not a complete fix! Please review the README for completeness and pretend someone knows nothing about WebSphere when reading the document.

Unmerged revisions

33. By Matt Bruzek on 2015-09-25

Suggestions for the readme.

=== modified file 'README.md'
--- README.md	2015-07-24 10:20:52 +0000
+++ README.md	2015-09-25 21:05:45 +0000
@@ -2,68 +2,75 @@
 
 WebSphere Application Server Base
 
-WebSphere Application Server is a proven, high-performance transaction engine that can help build, run, integrate, and manage dynamic web applications.
-Details on IBM Websphere Application Server and WAS Base Prduct Page available [here] [WAS-product-page].
+WebSphere Application Server (WAS) is a proven, high-performance transaction engine that can help build, run, integrate, and manage dynamic web applications.
+Details on IBM WebSphere Application Server and WAS Base Product Page available [here] [WAS-product-page].
 
 
 # Usage
 
-Download your licensed IBM Installation Manager software version 1.5 and above for 'x86_64' based machine. And version 1.8 and above for 'ppc64le' based machine and upload to your apache repository.
-
-Download your licensed IBM Websphere Base software 8.5.5.0 version and upload to your apache repository.
-
-Download your licensed IBM Websphere Base software WAS fixpack version 8.5.5.4 and upload to your apache repository.
-
-For 'ppc64le' based machines, Download your licensed IBM Websphere Base software WAS fixpack version 8.5.5.6 and upload to your apache repository.
-
-Put up all the downloaded contents on the web server like Apache and configure apache to serve these packages. These packages can be accessed using a URL from the web server.
-
-
-#Creating the repositories in Apache
+To deploy this charm successfully you must have the IBM software downloaded and
+hosted on an HTTP server (such as Apache) that is accessible to the Juju network.  
+
+Download your licensed IBM Installation Manager (IM) software version 1.5 and above for 'x86_64' based machine. And version 1.8 and above for 'ppc64le' based machine and upload to your Apache repository.
+
+Download your licensed IBM WebSphere Base software 8.5.5.0 version and upload to your Apache repository.
+
+Download your licensed IBM WebSphere Base software WAS fixpack version 8.5.5.4 and upload to your Apache repository.
+
+For 'ppc64le' based machines, Download your licensed IBM WebSphere Base software WAS fixpack version 8.5.5.6 and upload to your Apache repository.
+
+Put up all the downloaded contents on the web server like Apache and configure Apache to serve these packages. Ensure these packages can be accessed using a URL from the web server
+before deploying the charm.
+
+
+# Creating the repository in Apache
 
 Run steps below with admin access
 
-Install needed packages
+Install needed packages  
+
     apt-get install dpkg-dev apache2
 
-Create the repository on apache server Under your apache repository directory.
-Configure apache server to allow access to the repository.
-
-To install IBM Websphere Application Server Base you need to install IBM Installation Manager software as prerequisite.
-To install IBM Installation Manager you need to get the packages for ubuntu, for information about the software and builds please visit (http://www-01.ibm.com/software/passportadvantage/).
-
-To install the downloaded binaries you must agree to the IBM license. You can view the full license for IBM Installation Manager and IBM WebSphere Application Server Base by visiting the [Software license agreements search website][License] Search for "IBM Installation Manager" and "IBM Websphere Application Server" and choose the license that applies to the version you are using.
+Create the repository on Apache server Under your Apache repository directory.
+Configure Apache server to allow access to the repository.
+
+To install IBM WebSphere Application Server Base you need to install IBM Installation Manager software as prerequisite.
+To install IBM Installation Manager you need to get the packages for Ubuntu, for information about the software and builds please visit (http://www-01.ibm.com/software/passportadvantage/).
+
+To install the downloaded binaries you must agree to the IBM license. You can view the full license for IBM Installation Manager and IBM WebSphere Application Server Base by visiting the [Software license agreements search website][License] Search for "IBM Installation Manager" and "IBM WebSphere Application Server" and choose the license that applies to the version you are using.
 
 
 Run the following to deploy this charm:
 
     juju deploy was-base
 
-At this point the charm will wait until the user accepts the license.  If you 
-agree to the license, run the following command:
-
-If the was_url and im_filename is configured in the config.yaml:
+At this point the charm will wait until the user accepts the license.  If you
+agree to the license, run the following command:  
 
     juju set was-base accept-ibm-im-license=True accept-ibm-websphere-license=True
 
-If not,
-
-    juju set was-base accept-ibm-im-license=True accept-ibm-websphere-license=True was_url=<Web server URL> im_file_name=<IM package name> im_install_path=<IM Installation Path>
-
-
-You can then browse to "http://was-base unit's ip-address:9060/ibm/cinsole" to view WAS Console. 
+Next the charm needs the url and the name of the software to download:
+
+    juju set was-base was_url=<Web server URL> im_file_name=<IM package name> sha_im=<IM sha1sum>
+
+Note: All these configuration values can be set in a yaml file for repeated or future deployments.
+
+After the software installs and is configured, you can then browse to the Integrated Solutions Console "http://was-base unit's ip-address:9060/ibm/console".
+
+
+(Describe how to log in and and get started using WAS base here!)
 
 
 # Configuration
 
 `accept-ibm-im-license`  
 The IBM Installation Manager software comes with special terms and conditions from IBM.
-The IBM Installation Manager software can only be used by accepting the terms and 
+The IBM Installation Manager software can only be used by accepting the terms and
 conditions found in the IBM-Installation-Manager-license.txt file.  
 
-Setting this option to True indicates that you have read and accept the 
+Setting this option to True indicates that you have read and accept the
 IBM  Installation Manager terms and conditions found in the license file.  
-The license file(s) can be found in the product binaries you downloaded. 
+The license file(s) can be found in the product binaries you downloaded.
 
 `accept-ibm-websphere-license`
 Before you can use, extract, or install IBM WebSphere Application Server
@@ -82,7 +89,7 @@
 
 `im_install_path`
 Install Location for Installation Manager. Ex : "/opt/IBM/InstallationManager". Here IM will install at this location, It can be changed if IM needs to be installed at some other place.
- 
+
 
 `im_file_name`
 The IBM Installation Manager Package name. If not set, It will assign the value "Install_Mgr_v1.6.2_Lnx_WASv8.5.5.zip" for x86_64 based machine and "agent.installer.linux.gtk.ppc64le_1.8.1000.20141126_2002.zip" for ppc64le based machine.
@@ -92,29 +99,44 @@
 
 #IBM WAS Base Information
 
-(1) General Information 
+(1) General Information
 Information on IBM WAS available [here] [WAS-Infocenter]
 
 (2) Download Information
 
-Downloadable Package Names for 'x86_64' based machine:
-WAS_V8.5.5_1_OF_3.zip
-WAS_V8.5.5_2_OF_3.zip
-WAS_V8.5.5_3_OF_3.zip
-8.5.5-WS-WAS-FP0000004-part1.zip
-8.5.5-WS-WAS-FP0000004-part2.zip
-
-Downloadable Package Names for 'ppc64le' based machine:
-WAS_V8.5.5_FOR_POWERLE_ML.zip
-WAS_V8.5.5_2_OF_2_FOR_POWERLE_ML.zip
-8.5.5-WS-WAS-LE-FP0000006-part1.zip
-8.5.5-WS-WAS-LE-FP0000006-part2.zip
+This charm attempts to download the IBM software from an HTTP repository
+designated by the `was_url` configuration option.  Make sure that url is
+accessible on the Juju network and contains the following files in the root
+directory.
+
+The downloadble package name for IBM Installation Manager (IM) on 'x86_64':
+
+    Install_Mgr_v1.6.2_Lnx_WASv8.5.5.zip
+
+The downloadable package name for IBM Installation Manager (IM) on 'ppc64le':
+
+    agent.installer.linux.gtk.ppc64le_1.8.1000.20141126_2002.zip
+
+Downloadable package names for WAS base on 'x86_64' based machines:  
+
+    WAS_V8.5.5_1_OF_3.zip
+    WAS_V8.5.5_2_OF_3.zip
+    WAS_V8.5.5_3_OF_3.zip
+    8.5.5-WS-WAS-FP0000004-part1.zip
+    8.5.5-WS-WAS-FP0000004-part2.zip
+
+Downloadable package names for WAS base on 'ppc64le' based machines:  
+
+    WAS_V8.5.5_FOR_POWERLE_ML.zip
+    WAS_V8.5.5_2_OF_2_FOR_POWERLE_ML.zip
+    8.5.5-WS-WAS-LE-FP0000006-part1.zip
+    8.5.5-WS-WAS-LE-FP0000006-part2.zip
 
 Information on procuring WAS product is available at the [Passport Advantage site] [Passport-Advantage]
 
-Details about WAS 8.5.5.0 download available [here] [[WAS-8.5.5.0-download]
+Details about WAS 8.5.5.0 download available [here] [WAS-8.5.5.0-download]
 
-Information about insatllation of WAS Base on 'ppc64le' based machine available [here] [WAS-for-ppc64le]  
+Information about installation of WAS Base on 'ppc64le' based machine available [here] [WAS-for-ppc64le]  
 
 Details about WAS 8.5.5.4 fixpack download available [here] [WAS-8.5.5.4-fixpack-download].
 
@@ -124,7 +146,7 @@
 
 (3) Contact Information
 
-For issues with this charm, please contact [e-mail]
+For issues with this charm, please contact The IBM Support team <[e-mail]>
 
 <!-- Links -->
 
@@ -149,4 +171,3 @@
 [WAS-ppc64le-fixpack-info]: http://www-01.ibm.com/support/docview.wss?uid=swg24040035
 
 [License]: http://www-03.ibm.com/software/sla/sladb.nsf/search
-