Improve create -o documentation

Author: moreaut

site/creating-domain.md

@@ -89,7 +89,7 @@ For other providers, consult the documentation for the provider for instructions
 
 ## Customizing the domain parameters file
 
-The domain is created with the provided installation script (`create-weblogic-domain.sh`).  The input to this script is the file `create-weblogic-domain-inputs.yaml`, which needs to be updated to reflect the target environment.  
+The domain is created with the provided installation script (`create-weblogic-domain.sh`).  The input to this script is the file `create-weblogic-domain-inputs.yaml`, which must be copied and updated to reflect the target environment.  
 
 The following parameters must be provided in the input file:
 
@@ -125,6 +125,8 @@ The following parameters must be provided in the input file:
 | weblogicDomainStorageNFSServer| The name of ip address of the NFS server for the weblogic domain's storage. | no default |
 | weblogicImagePullSecretName | Name of the Kubernetes secret for the Docker Store, used to pull the WebLogic Server image. | docker-store-secret |
 
+You must uncomment and customize `domainUID` and `weblogicDomainStoratePath`.
+
 ## Limitations of the create domain script
 
 This technology preview release has some limitations in the create domain script that users should be aware of.
@@ -136,11 +138,11 @@ Oracle intends to remove these limitations in a future release.
 
 ## Using the script to create a domain
 
-To execute the script and create a domain, issue the following command:
+At this point, you've created a customized copy of the inputs file.
 
-```
-# Choose and create a directory that generated weblogic operator related files will be stored in,
-# e.g. /path/to/weblogic-operator-output-directory
+Next, choose and create a directory that generated weblogic operator related files will be stored in, e.g. /path/to/weblogic-operator-output-directory.
+
+Finally, run the create script, pointing it at your inputs file and output directory:
 
 ./create-weblogic-domain.sh \
   –i create-domain-job-inputs.yaml \
@@ -151,7 +153,7 @@ To execute the script and create a domain, issue the following command:
 
 The script will perform the following steps:
 
-*	Create a directory for the generated Kubernetes YAML files for this domain.  The pathname is /path/to/weblogic-operator-output-directory/weblogic-domains/<domainUID parameter from create-weblogic-domain-inputs.yaml.
+*	Create a directory for the generated Kubernetes YAML files for this domain.  The pathname is /path/to/weblogic-operator-output-directory/weblogic-domains/<domainUID>.
 *	Create Kubernetes YAML files based on the provided inputs.
 *	Create a persistent volume for the shared state.
 *	Create a persistent volume claim for that volume.

site/developer.md

@@ -73,12 +73,15 @@ To run the tests, uncomment the following `execution` element in the `pom.xml` f
 -->
 ```
 
-These tests assume that the RBAC definitions exist on the Kubernetes cluster.  To create them, update the inputs file and run the operator installation script with the "generate only" option as shown below (see the [installation](installation.md) page for details about this script and the inputs):
+These tests assume that the RBAC definitions exist on the Kubernetes cluster.
 
-```
-# Choose and create a directory that generated weblogic operator related files will be stored in,
-# e.g. /path/to/weblogic-operator-output-directory
+To create them, first, make a copy of the inputs file (`create-weblogic-operator-inputs.yaml`) and update it.
+
+Next, choose and create a directory that generated weblogic operator related files will be stored in, e.g. /path/to/weblogic-operator-output-directory.
 
+Finally, run the operator installation script with the "generate only" option as shown below, pointing it at your inputs file and your output directory.  (see the [installation](installation.md) page for details about this script and the inputs):
+
+```
 ./create-weblogic-operator.sh -g \
   -i create-weblogic-operator-inputs.yaml \
   -o /path/to/weblogic-operator-output-directory
@@ -124,14 +127,15 @@ docker load < /some/path/operator.tar
 
 Verify that you have the right image by running `docker images | grep webloogic-kubernetes-operator` on both machines and comparing the image ID.
 
-To create the Kuberentes YAML file to deploy the operator, update the inputs file (`create-weblogic-operator-inputs.yaml`) and make sure the `imagePullPolicy` is set to `Never` and the `image` matches the name you used in your `docker build` command.  Then run the operator installation script to deploy the operator:
+To create and deploy the operator, first, make a copy of the inputs file (`create-weblogic-operator-inputs.yaml`) and update it, making sure that `weblogicOperatorImagePullPolicy` is set to `Never` and `weblogicOperatorImage` matches the name you used in your `docker build` command.
 
-```
-# Choose and create a directory that generated weblogic operator related files will be stored in,
-# e.g. /path/to/weblogic-operator-output-directory
+Next, choose and create a directory that generated weblogic operator related files will be stored in, e.g. /path/to/weblogic-operator-output-directory.
+
+Finally, run the operator installation script to deploy the operator, pointing it at your inputs file and your output directory:
 
+```
 ./create-weblogic-operator.sh \
-  -i create-weblogic-operator-inputs.yaml \
+  -i /path/to/create-weblogic-operator-inputs.yaml \
   -o /path/to/weblogic-operator-output-directory
 ```
 

site/installation.md

@@ -62,9 +62,7 @@ Verify that you have the right image by running `docker images | grep webloogic-
 
 ## Customizing the operator parameters file
 
-The operator is deployed with the provided installation script (`create-weblogic-operator.sh`).  The input to this script is the file `create-weblogic-operator-inputs.yaml`, which needs to updated to reflect the target environment.
-
-The following parameters must be provided in the input file:
+The operator is deployed with the provided installation script (`create-weblogic-operator.sh`).  The default input to this script is the file `create-weblogic-operator-inputs.yaml`.  It contains the following parameters:
 
 ### CONFIGURATION PARAMETERS FOR THE OPERATOR
 
@@ -87,6 +85,8 @@ The following parameters must be provided in the input file:
 | weblogicOperatorImagePullPolicy | The image pull policy for the operator docker image.  Allowed values are 'Always', 'Never' and 'IfNotPresent' | IfNotPresent |
 | weblogicOperatorImagePullSecretName | Name of the Kubernetes secret to access the Docker Store to pull the WebLogic Server Docker image.  The presence of the secret will be validated when this parameter is enabled. | |
 
+Review the default values to see if any need to be updated to reflect the target environment.  If so, then make a copy of the input file and modify it.  Otherwise, you can use the default input file.
+
 ## Decide which REST configuration to use
 
 The operator provides three REST certificate options:
@@ -119,14 +119,15 @@ To enable the ELK integration, set the `elkIntegrationEnabled` option to `true`.
 
 ## Deploying the operator to a Kubernetes cluster
 
-To deploy the operator, run the deployment script and give it the location of your inputs file:
+At this point, you've created a custom inputs file, or you've decided to use the default one.
 
-```
-# Choose and create a directory that generated weblogic operator related files will be stored in,
-# e.g. /path/to/weblogic-operator-output-directory
+Next, choose and create a directory that generated weblogic operator related files will be stored in, e.g. /path/to/weblogic-operator-output-directory.
 
+Finally, run the operator installation script to deploy the operator, pointing it at your inputs file and your output directory:
+
+```
 ./create-weblogic-operator.sh \
-  –i /path/to/create-weblogic-operator-inputs.yaml \
+  -i /path/to/create-weblogic-operator-inputs.yaml \
   -o /path/to/weblogic-operator-output-directory
 ```
 

site/manually-creating-domain.md

@@ -11,12 +11,15 @@ If creating the domain manually, using a WLST script for example, the domain mus
 
 ## Use the scripts to create the sample YAML files
 
-The `create-weblogic-domain.sh` script described in the previous section can be executed with the “-g” option, which will cause it to generate the YAML files but take no action at all against the Kubernetes environment.  This is a useful way to create the sample YAML files needed to manually create a domain.  Execute the script as follows:
+The `create-weblogic-domain.sh` script described in the previous section can be executed with the “-g” option, which will cause it to generate the YAML files but take no action at all against the Kubernetes environment.  This is a useful way to create the sample YAML files needed to manually create a domain.
 
-```
-# Choose and create a directory that generated weblogic operator related files will be stored in,
-# e.g. /path/to/weblogic-operator-output-directory
+First, make a copy of `create-weblogic-domain-inputs.yaml` and customize it.
+
+Next, choose and create a directory that generated weblogic operator related files will be stored in, e.g. /path/to/weblogic-operator-output-directory
 
+Then, execute the script, pointing it at your inputs file and output directory:
+
+```
 ./create-weblogic-domain.sh –g \
   –i create-weblogic-domain-inputs.yaml \
   -o /path/to/weblogic-operator-output-directory