first pass review and edit

Author: rosemarymarano

README.md

@@ -1,54 +1,52 @@
-# Oracle WebLogic ImageBuilder Tool
+# Oracle WebLogic Image Builder Tool
 
 Containerization is taking over the software world. In this modern age of software development, Docker and Kubernetes
-have become the gold standard. To help customers stay at the forefront of this, Oracle released the
+have become the gold standard. To help customers stay at the forefront of this, Oracle has released the
 [WebLogic Server Kubernetes Operator](https://github.com/oracle/weblogic-kubernetes-operator). The operator helps
-customers move their workloads to the cloud via the kubernetes (cloud neutral) route. It was left to the customers how
-to create the docker images and apply patches to these images deployed by the kubernetes operator. To help customers
-with this effort, We created the [WebLogic ImageBuilder Tool](https://github.com/oracle/weblogic-imagebuilder-tool).
+customers move their workloads to the cloud via the Kubernetes (cloud neutral) route. Customers get to decide how
+to create the Docker images and apply patches to these images deployed by the Kubernetes operator. To help them
+with this effort, we have created the [WebLogic Image Builder Tool](https://github.com/oracle/weblogic-imagebuilder-tool).
 
 ## Table of Contents
 
 - [Features](#features-of-the-imagebuilder-tool)
+- [Prerequisites](#prerequisites)
+- [Setup](#setup)
   - [Create Image](site/create-image.md)
   - [Update Image](site/update-image.md)
   - [Cache](site/cache.md)
 
-## Features of the Oracle WebLogic ImageBuilder Tool
+## Features of the Oracle WebLogic Image Builder Tool
 
-The tool can create a WebLogic docker image from any base image (ex: oraclelinux, ubuntu), install a given version of
-WebLogic (ex: 12.2.1.3.0), install a given jdk (ex: 8u202), apply selected patches and create a domain with a given
-version of [WDT](https://github.com/oracle/weblogic-deploy-tooling). The tool can also update a docker image either
-created using this tool or a docker image built by the user (should have an ORACLE_HOME env variable defined) by
-applying selected patches.
+The Image Builder Tool can create a WebLogic Docker image from any base image (for example, Oracle Linux, Ubuntu), install a given version of
+WebLogic (for example, 12.2.1.3.0), install a given JDK (for example, 8u202), apply selected patches, and create a domain with a given
+version of [WDT](https://github.com/oracle/weblogic-deploy-tooling). The tool can also update a Docker image either
+created using this tool or a Docker image built by the user (you should have an `ORACLE_HOME` `env` variable defined by
+applying selected patches).
 
 ## Prerequisites
 
-- Active internet connection
-  - The tool needs to communicate with Oracle support system.
-- Oracle support credentials
-  - Oracle support credentials are used to validate and download patches.
-- WebLogic and JDK installers from OTN / e-delivery
-  - WebLogic and JDK installers should be available on local disk.
-- Docker client and daemon on the build machine
-  - Experimental features should be turned on to support docker build --squash option. Refer to [Docker squash](https://docs.docker.com/engine/reference/commandline/build/#squash-an-images-layers---squash-experimental)
+- Active Internet connection. The tool needs to communicate with Oracle support system.
+- Oracle support credentials. These are used to validate and download patches.
+- WebLogic and JDK installers from OTN / e-delivery. These should be available on local disk.
+- Docker client and daemon on the build machine. Experimental features should be turned on to support the `docker build --squash` option. Refer to [Docker squash](https://docs.docker.com/engine/reference/commandline/build/#squash-an-images-layers---squash-experimental)
 
 ## Setup
 
-- Build the project (`mvn clean package`) to generate artifacts imagebuilder-0.1-SNAPSHOT.jar and imagebuilder_completion.sh
-- The jar is an uber-jar containing all the required packages to run the tool.
-- If running an os with bash, Use the below commands to setup the tool with tab complete feature.
+- Build the project (`mvn clean package`) to generate artifacts `imagebuilder-0.1-SNAPSHOT.jar` and `imagebuilder_completion.sh`.
+- The JAR is an uber-JAR containing all the required packages to run the tool.
+- If running an OS with bash, then use the commands below to set up the tool with the tab complete feature:
    ```bash
    #!/usr/bin/env bash
    unalias imagebuilder 2> /dev/null
    alias imagebuilder='java -cp "./imagebuilder-0.1-SNAPSHOT.jar" com.oracle.weblogicx.imagebuilder.cli.CLIDriver'
    source ./imagebuilder_completion.sh
    ```
-- On Windows, setup imagebuilder.cmd or imagebuilder.bat script
+- On Windows, set up with `imagebuilder.cmd` or the `imagebuilder.bat` script:
     ```cmd
     @ECHO OFF
     java -cp "./imagebuilder-0.1-SNAPSHOT.jar" com.oracle.weblogicx.imagebuilder.cli.CLIDriver %*
     ```
-- Then, execute "imagebuilder help" to get the help screen
-- The jar can be executed directly using command java -cp "./imagebuilder-0.1-SNAPSHOT.jar" com.oracle.weblogicx.imagebuilder.cli.CLIDriver help
-- Once familiar with the commands, you should be able to create and update WebLogic docker images
+- Then, execute `imagebuilder help` to get the help screen.
+- You can execute the JAR directly using the command `java -cp "./imagebuilder-0.1-SNAPSHOT.jar" com.oracle.weblogicx.imagebuilder.cli.CLIDriver help`.
+- After you are familiar with the commands, you will be able to create and update WebLogic Docker images.

site/cache.md

@@ -1,8 +1,7 @@
 # Cache
 
-The cache command is used to add / edit the required metadata for the tool. Cache helps the tool to identify where the 
-required installers (wls, fmw, jdk) are located and where to download the patches to. There are several subcommands to 
-aid the user.
+Use the `cache` command to add or edit the required metadata for the tool. Cache helps the tool to identify where the
+required installers (WLS, FMW, JDK) are located and where to download the patches. There are several subcommands:
 
 ```
 Usage: imagebuilder cache [COMMAND]
@@ -22,7 +21,7 @@ Commands:
 
 ## Usage scenarios
 
-- listItems: Display the contents of cache. Displays key value pairs of the installers, patches.
+- `listItems`: Display the contents of the cache. Displays key value pairs of the installers and patches.
     ```
     imagebuilder cache listItems
 
@@ -34,28 +33,28 @@ Commands:
     cache.dir=/Users/xyz/Downloads/cache
     ```
 
-- addInstaller: Add installer to cache, ex: jdk
+- `addInstaller`: Add an installer to the cache, for example, JDK.
     ```
     imagebuilder cache addInstaller --type jdk --version 8u202 --path /path/to/local/jdk.tar.gz
     ```
 
-- addPatch: Add patch to cache. This command verifies if the path points to a valid patch by querying Oracle support portal
+- `addPatch`: Add a patch to the cache. This command verifies if the path points to a valid patch by querying the Oracle support portal.
     ```
     imagebuilder cache addPatch --type wls --version 12.2.1.3.0 --user [email protected] --passwordEnv MYVAR --patchId 12345678 --path /path/to/patch.zip
     ```
 
-- getCacheDir and setCacheDir: Get/Set cache directory. Used to display or set the directory where patches will be downloaded to by the tool.
+- `getCacheDir` and `setCacheDir`: Get or set the cache directory. Used to display or set the directory where patches will be downloaded.
     ```
     imagebuilder cache getCacheDir
     imagebuilder cache setCacheDir /path/to/dir
     ```
-    
-- addEntry: Consider this as an expert mode where you can add key value pairs to cache without any validation.
+
+- `addEntry`: Consider this an expert mode where you can add key value pairs to the cache without any validation.
     ```
     imagebuilder cache addEntry --key xyz_123 --value /path/to/file
     ```
 
-- deleteEntry: Delete a entry from cache for a given key. _Note: This command does not delete files from disk._ 
+- `deleteEntry`: Delete an entry from the cache for a given key. **Note**: This command does not delete files from the disk.
     ```
     imagebuilder cache deleteEntry --key xyz_123
-    ```
+    ```

site/create-image.md

@@ -1,10 +1,11 @@
 # Create Image
 
-The create command helps build a WebLogic docker image from a given base os image. The required options for the command 
-are marked with asterisk (*). Password can be provided in one of the three ways. 
-1) Plain Text
-2) Environment Variable
-3) File containing the password
+The `create` command helps build a WebLogic Docker image from a given base OS image. The required options for the command
+are marked with an asterisk (*). You can provide the password in one of the three ways:
+
+* Plain text
+* Environment variable
+* File containing the password
 
 ```
 Usage: imagebuilder create [OPTIONS]
@@ -49,32 +50,34 @@ Build WebLogic docker image
 
 ## Usage scenarios
 
-**_Note: Use --passwordEnv or --passwordFile instead of --password_**
+**Note**: Use `--passwordEnv` or `--passwordFile` instead of `--password`.
 
-The commands below assume that all the required jdk, wls or fmw (WebLogic infrastructure installer) have been downloaded
- to the cache dir. Use the [cache](cache.md) command to set it up.
+The commands below assume that all the required JDK, WLS or FMW (WebLogic infrastructure installers) have been downloaded
+ to the cache directory. Use the [cache](cache.md) command to set it up.
 
-- Create an image named sample:wls with WebLogic installer 12.2.1.3.0, server jdk 8u202, latest psu applied.
+- Create an image named `sample:wls` with the WebLogic installer 12.2.1.3.0, server JDK 8u202, and latest PSU applied.
     ```
     imagebuilder create --tag sample:wls --latestPSU --user [email protected] --password hello
     ```
 
-- Create an image named sample:wdt with same options as above and create a domain with [WebLogic Deploy Tooling](https://github.com/oracle/weblogic-deploy-tooling)
+- Create an image named `sample:wdt` with the same options as above and create a domain with [WebLogic Deploy Tooling](https://github.com/oracle/weblogic-deploy-tooling).
     ```
     imagebuilder create --tag sample:wdt --latestPSU --user [email protected] --password hello --wdtModel /path/to/model.json --wdtVariables /path/to/variables.json --wdtVersion 0.16
     ```
-    If wdtVersion is not provided, the tool uses the latest release.
+    If `wdtVersion` is not provided, the tool uses the latest release.
 
-- Create an image name sample:patch with selected patches applied.
+- Create an image named `sample:patch` with the selected patches applied.
     ```
     imagebuilder create --tag sample:patch --user [email protected] --password hello --patches 12345678,p87654321
     ```
-    The patch numbers may or may not start with 'p'.
-    
+    The patch numbers may or may not start with '`p`'.
+
 ## Errors
 
-- CachePolicy prohibits download. Please add cache entry for key: jdk_8u202
-    - This implies that the tool could not find the jdk installer in its cache. Use the [cache](cache.md) command to fix it.
+- `CachePolicy prohibits download. Please add cache entry for key: jdk_8u202`
+
+   - This implies that the tool could not find the JDK installer in its cache.
+   - Use the [cache](cache.md) command to fix it:
     ```
     imagebuilder cache addInstaller --type jdk --version 8u202 --path /local/path/to/jdk.gz
-    ```
+    ```

site/update-image.md

@@ -1,11 +1,11 @@
 # Update Image
 
-The update command is used to apply patches to an existing WebLogic docker image. The required options for the command 
-are marked with asterisk (*). Password can be provided in one of the three ways.
- 
-1) Plain Text
-2) Environment Variable
-3) File containing the password
+Use the `update` command to apply patches to an existing WebLogic Docker image. The required options for the command
+are marked with asterisk (*). The password can be provided in one of the three ways:
+
+* Plain text
+* Environment variable
+* File containing the password
 
 ```
 Usage: imagebuilder update [OPTIONS]
@@ -36,15 +36,15 @@ Update WebLogic docker image with selected patches
 
 ## Usage scenarios
 
-**_Note: Use --passwordEnv or --passwordFile instead of --password_**
+**Note**: Use `--passwordEnv` or `--passwordFile` instead of `--password`.
 
-- Update an image named sample:1.0 by applying the latest psu and tag it as sample:1.1.
+- Update an image named `sample:1.0` by applying the latest PSU and tag it as `sample:1.1`:
     ```
     imagebuilder update --fromImage sample:1.0 --tag sample:1.1 --latestPSU --user [email protected] --passwordEnv MYVAR
     ```
 
-- Update an image named sample:1.0 with selected patches applied.
+- Update an image named `sample:1.0` with the selected patches applied.
     ```
     imagebuilder update --fromImage sample:1.0 --tag sample:1.1 --user [email protected] --password hello --patches 12345678,p87654321
     ```
-    The patch numbers may or may not start with 'p'.
+    The patch numbers may or may not start with '`p`'.