add command prompt (#272)

rosemarymarano · web-flow · commit 2138a698392d · 2021-05-11T08:19:44.000-05:00
diff --git a/documentation/1.9/content/_index.md b/documentation/1.9/content/_index.md
@@ -37,7 +37,8 @@ See the [Release Notes]({{< relref "/release-notes.md" >}}) for issues and impor
 * Use the [Quick Start]({{< relref "/quickstart/quickstart.md" >}}) guide to create a Linux based WebLogic Docker image.
 * The [User Guide]({{< relref "/userguide/" >}}) contains detailed usage information, including command options and usage scenarios.
 * The [Samples]({{< relref "/samples/" >}}) provide typical and informative use cases.
-* The [Developer Guide]({{< relref "/developer/" >}}) provides details for people who want to understand how WIT is built.
+* The [Developer Guide]({{< relref "/developer/" >}}) provides details for people who want to understand how WIT is built. Those
+who wish to contribute to the WebLogic Image Tool code will find useful information [here]({{< relref "/developer/contribute.md" >}}).
 
 
 ### Related projects
@@ -47,6 +48,3 @@ See the [Release Notes]({{< relref "/release-notes.md" >}}) for issues and impor
 * [WebLogic Monitoring Exporter](https://github.com/oracle/weblogic-monitoring-exporter)
 * [WebLogic Logging Exporter](https://github.com/oracle/weblogic-logging-exporter)
 * [WebLogic Remote Console](https://github.com/oracle/weblogic-remote-console)
-
-### Contributing
-Those who wish to contribute to the WebLogic Image Tool code will find useful information [here](https://github.com/oracle/weblogic-image-tool/blob/main/CONTRIBUTING.md).
diff --git a/documentation/1.9/content/developer/contribute.md b/documentation/1.9/content/developer/contribute.md
@@ -0,0 +1,54 @@
+---
+title: "Contribute to WIT"
+date: 2019-02-23T17:19:24-05:00
+draft: false
+weight: 2
+---
+
+Oracle welcomes contributions to this repository from anyone.
+
+If you want to submit a pull request to fix a bug or enhance an existing
+feature, please first open an issue and link to that issue when you
+submit your pull request.
+
+If you have any questions about a possible submission, feel free to open
+an issue too.
+
+### Contributing to the WebLogic Image Tool repository
+
+Pull requests can be made under
+[The Oracle Contributor Agreement](https://www.oracle.com/technetwork/community/oca-486395.html) (OCA).
+
+For pull requests to be accepted, the bottom of your commit message must have
+the following line using your name and e-mail address as it appears in the
+OCA Signatories list.
+
+```
+Signed-off-by: Your Name <you@example.org>
+```
+
+This can be automatically added to pull requests by committing with:
+
+```
+$  git commit --signoff
+```
+
+Only pull requests from committers that can be verified as having
+signed the OCA can be accepted.
+
+### Pull request process
+
+1. Fork this repository.
+2. Create a branch in your fork to implement the changes. We recommend using the issue number as part of your branch name, for example, 1234-fixes.
+3. Ensure that any documentation is updated with the changes that are required by your fix.
+4. Ensure that any samples are updated if the base image has been changed.
+5. Squash your branch changes into a single commit.
+6. Submit the pull request.
+
+    a. Do not leave the pull request blank.
+
+    b. Explain exactly what your changes are meant to do and provide simple steps on how to validate your changes.
+
+    c. Ensure that you reference the issue you created as well.
+
+7. We will assign the pull request to 2-3 people for review before it is merged.
diff --git a/documentation/1.9/content/developer/source.md b/documentation/1.9/content/developer/source.md
@@ -34,12 +34,12 @@ patches can be found.  The files required in the `STAGING_DIR` depend on which t
 
 **Example**: Run a set of integration tests (available groups are `cache`, `gate`, and `nightly`:
 ```shell script
-mvn verify -Dtest.groups=cache
+$ mvn verify -Dtest.groups=cache
 ```
 
 **Example**: Run a single integration test:
 ```shell script
-mvn verify -Dtest.groups=gate,nightly -Dit.test=ITImagetool#createWlsImg
+$ mvn verify -Dtest.groups=gate,nightly -Dit.test=ITImagetool#createWlsImg
 ```
 
 Integration Test groups:
diff --git a/documentation/1.9/content/quickstart/quickstart.md b/documentation/1.9/content/quickstart/quickstart.md
@@ -30,17 +30,17 @@ and save them in a directory of your choice, for example, `/home/acmeuser/wls-in
 2. Use the [Cache Tool]({{< relref "/userguide/tools/cache.md" >}}) to add the installers:
 
     ```bash
-    imagetool cache addInstaller --type jdk --version 8u202 --path /home/acmeuser/wls-installers/jdk-8u202-linux-x64.tar.gz
+    $ imagetool cache addInstaller --type jdk --version 8u202 --path /home/acmeuser/wls-installers/jdk-8u202-linux-x64.tar.gz
     ```
 
     ```bash
-    imagetool cache addInstaller --type wls --version 12.2.1.3.0 --path /home/acmeuser/wls-installers/fmw_12.2.1.3.0_wls_Disk1_1of1.zip
+    $ imagetool cache addInstaller --type wls --version 12.2.1.3.0 --path /home/acmeuser/wls-installers/fmw_12.2.1.3.0_wls_Disk1_1of1.zip
     ```
 
     You can verify the cache entries by:
 
     ```bash
-    imagetool cache listItems
+    $ imagetool cache listItems
     ```
 
     ```bash
@@ -52,7 +52,7 @@ and save them in a directory of your choice, for example, `/home/acmeuser/wls-in
 3. Run the [`imagetool create`]({{< relref "/userguide/tools/create-image.md" >}}) command:
 
    ```bash
-   imagetool create --tag wls:12.2.1.3.0
+   $ imagetool create --tag wls:12.2.1.3.0
    ```
 
 The final image will have the following structure:
diff --git a/documentation/1.9/content/samples/create-image-no-internet.md b/documentation/1.9/content/samples/create-image-no-internet.md
@@ -26,33 +26,33 @@ and save them in a directory of your choice, for example, `/home/acmeuser/wls-in
 2. Use the [Cache Tool]({{< relref "/userguide/tools/cache.md" >}}) to add the installers:
 
     ```bash
-    imagetool cache addInstaller --type jdk --version 8u202 --path /home/acmeuser/wls-installers/jdk-8u202-linux-x64.tar.gz
+    $ imagetool cache addInstaller --type jdk --version 8u202 --path /home/acmeuser/wls-installers/jdk-8u202-linux-x64.tar.gz
     ```
 
     ```bash
-    imagetool cache addInstaller --type wls --version 12.2.1.3.0 --path /home/acmeuser/wls-installers/fmw_12.2.1.3.0_wls_Disk1_1of1.zip
+    $ imagetool cache addInstaller --type wls --version 12.2.1.3.0 --path /home/acmeuser/wls-installers/fmw_12.2.1.3.0_wls_Disk1_1of1.zip
     ```
 
 3. For each WebLogic patch, download it from [Oracle Support](https://support.oracle.com/) and set up the cache.
 
     For example, if you download patch number `27342434` for WebLogic Server version 12.2.1.3.0:
 
    ```bash
-   imagetool cache addPatch --patchId 27342434_12.2.1.3.0 --path /home/acmeuser/cache/p27342434_122130_Generic.zip
+   $ imagetool cache addPatch --patchId 27342434_12.2.1.3.0 --path /home/acmeuser/cache/p27342434_122130_Generic.zip
    ```
 
    **Note**: Refer to the [Cache]({{< relref "/userguide/tools/cache.md" >}}) commands for the format of ```patchId```.
 
 4. Then, run the command to create the image:
 
    ```bash
-   imagetool create --fromImage myosimg:latest --tag wls:12.2.1.3.0 --patches 27342434 --version 12.2.1.3.0
+   $ imagetool create --fromImage myosimg:latest --tag wls:12.2.1.3.0 --patches 27342434 --version 12.2.1.3.0
    ```
 
 5. Occasionally, a WebLogic Server patch will require patching the OPatch binaries before applying them.  We recommend downloading the latest OPatch patch and setting up the cache.  
 
     For example, if the latest OPatch patch is `28186730`, `13.9.4.0.0`.  After downloading it from Oracle Support, you can use this command to set up the cache:
 
   ```bash
-  imagetool cache addPatch --patchId 28186730_13.9.4.0.0 --path /home/acmeuser/cache/p28186730_139400_Generic.zip
+  $ imagetool cache addPatch --patchId 28186730_13.9.4.0.0 --path /home/acmeuser/cache/p28186730_139400_Generic.zip
   ```
diff --git a/documentation/1.9/content/samples/create-image-wdt.md b/documentation/1.9/content/samples/create-image-wdt.md
@@ -14,13 +14,13 @@ The Image Tool lets you create a customized WebLogic domain in the image using t
 2. Download the [WebLogic Deploy Tool](https://github.com/oracle/weblogic-deploy-tooling/releases), and then add it to the cache store:
 
 ```bash
-imagetool cache addInstaller --type wdt --version 0.22 --path /home/acmeuser/cache/weblogic-deploy.zip
+$ imagetool cache addInstaller --type wdt --version 0.22 --path /home/acmeuser/cache/weblogic-deploy.zip
 ```
 
 3. Provide the command-line options for the WebLogic Deploy Tool:
 
 ```bash
-imagetool create --fromImage myosimg:latest --tag wls:12.2.1.3.0  --version 12.2.1.3.0  --wdtVersion 1.4.0 --wdtArchive /home/acmeuser/wdt/domain1.zip --wdtDomainHome /u01/domains/simple_domain
+$ imagetool create --fromImage myosimg:latest --tag wls:12.2.1.3.0  --version 12.2.1.3.0  --wdtVersion 1.4.0 --wdtArchive /home/acmeuser/wdt/domain1.zip --wdtDomainHome /u01/domains/simple_domain
 ```
 
 The parameter mappings between the Image Tool and the WebLogic Deploy Tool are:
diff --git a/documentation/1.9/content/samples/create-image-with-internet.md b/documentation/1.9/content/samples/create-image-with-internet.md
@@ -26,19 +26,19 @@ and save them in a directory of your choice, for example, `/home/acmeuser/wls-in
 2. Use the [Cache Tool]({{< relref "/userguide/tools/cache.md" >}}) to add the installers:
 
     ```bash
-    imagetool cache addInstaller --type jdk --version 8u202 --path /home/acmeuser/wls-installers/jdk-8u202-linux-x64.tar.gz
+    $ imagetool cache addInstaller --type jdk --version 8u202 --path /home/acmeuser/wls-installers/jdk-8u202-linux-x64.tar.gz
     ```
 
     ```bash
-    imagetool cache addInstaller --type wls --version 12.2.1.3.0 --path /home/acmeuser/wls-installers/fmw_12.2.1.3.0_wls_Disk1_1of1.zip
+    $ imagetool cache addInstaller --type wls --version 12.2.1.3.0 --path /home/acmeuser/wls-installers/fmw_12.2.1.3.0_wls_Disk1_1of1.zip
     ```
 
     **Note**:  The value of the version must be a valid WebLogic Server version number. This version number is used to verify and find the correct patch file to download from Oracle Support.  The format of the version is a 5 digits tuple, separated by period.  For example,  ```12.2.1.3.0``` ```12.1.3.0.0```
 
 3. Create the image using the [Create Tool]({{< relref "/userguide/tools/create-image.md" >}}) commands. For example:
 
   ```bash
-  imagetool create --tag wls:12.2.1.3.0 --latestPSU --version 12.2.1.3.0 --user  username@mycompany.com --passwordEnv MYPWD  
+  $ imagetool create --tag wls:12.2.1.3.0 --latestPSU --version 12.2.1.3.0 --user  username@mycompany.com --passwordEnv MYPWD  
   ```
 
    Where ```--user --passwordEnv``` provides the credentials for a user who is entitled to download patches from Oracle Support.
@@ -72,7 +72,7 @@ Successfully tagged wls:12.2.1.3.0
 3. To verify that the image was created, use the `docker images` command:
 
 ```bash
-docker images
+$ docker images
 
 REPOSITORY                    TAG                 IMAGE ID            CREATED              SIZE
 wls                           12.2.1.3.0          18d366fc3da4        About a minute ago   1.41GB
diff --git a/documentation/1.9/content/samples/patching-image.md b/documentation/1.9/content/samples/patching-image.md
@@ -17,13 +17,13 @@ You can download patches using the Image Tool or by manually downloading them.
     For example, to download patch number `27342434` for WebLogic Server version 12.2.1.3.0:
 
    ```bash
-   imagetool cache addPatch --patchId 27342434_12.2.1.3.0 --path /home/acmeuser/cache/p27342434_122130_Generic.zip
+   $ imagetool cache addPatch --patchId 27342434_12.2.1.3.0 --path /home/acmeuser/cache/p27342434_122130_Generic.zip
    ```
 
    **Note**: Refer to the [Cache]({{< relref "/userguide/tools/cache.md" >}}) commands for the format of ```patchId```.
 
 3. Use the [`imagetool update`]({{< relref "/userguide/tools/update-image.md" >}}) command to update the image:
 
    ```bash
-   imagetool update --fromImage wls:12.2.1.3.0 --tag wls:12.2.1.3.4 --patches 27342434
+   $ imagetool update --fromImage wls:12.2.1.3.0 --tag wls:12.2.1.3.4 --patches 27342434
    ```
diff --git a/documentation/1.9/content/userguide/cleanup.md b/documentation/1.9/content/userguide/cleanup.md
@@ -14,15 +14,15 @@ By default, the Image Tool creates the Docker context directory under the user's
 If you prefer to use a different directory for the temporary context, set the environment variable `WLSIMG_BLDDIR`.
 
  ```bash
-export WLSIMG_BLDDIR="/path/to/dir"
+$ export WLSIMG_BLDDIR="/path/to/dir"
 ```
 
 
 The Image Tool will try to prune intermediate images from the Docker multi-stage build after the build step.
 If you see dangling images after the build (images labeled as `<none>`), use the following command to remove them:
 
 ```bash
-docker rmi $(docker images --filter "dangling=true" -q --no-trunc)
+$ docker rmi $(docker images --filter "dangling=true" -q --no-trunc)
 ```
 
 If you wish to keep the Docker context directory and/or the intermediate images, using the `--skipcleanup` flag will
diff --git a/documentation/1.9/content/userguide/logging.md b/documentation/1.9/content/userguide/logging.md
@@ -13,7 +13,7 @@ In `logging.properties`, comment the existing `handlers` property and uncomment
 line that you just commented.  This should make the `logging.properties` file look something like this:
 ```properties
 #handlers=java.util.logging.ConsoleHandler
-handlers=java.util.logging.FileHandler, java.util.logging.ConsoleHandler
+$ handlers=java.util.logging.FileHandler, java.util.logging.ConsoleHandler
 ```
 Then, change level to `FINE` or `FINER`.
 ```properties
diff --git a/documentation/1.9/content/userguide/tools/cache.md b/documentation/1.9/content/userguide/tools/cache.md
@@ -13,7 +13,7 @@ By default, the cache store is located in the user's ```$HOME/cache``` directory
 You can change the default cache store location by setting the environment variable `WLSIMG_CACHEDIR`:
 
 ```bash
-export WLSIMG_CACHEDIR="/path/to/cachedir"
+$ export WLSIMG_CACHEDIR="/path/to/cachedir"
 ```
 
 You use the `cache` command to manipulate the local file cache. There are several subcommands for the cache feature.
@@ -48,13 +48,13 @@ List and set cache options
     ```
 
 - `addInstaller`: Add an installer to the cache, for example, JDK.
-    ```
-    imagetool cache addInstaller --type jdk --version 8u202 --path /path/to/local/jdk.tar.gz
+    ```bash
+    $ imagetool cache addInstaller --type jdk --version 8u202 --path /path/to/local/jdk.tar.gz
     ```
 
 - `addPatch`: Add a patch to the cache.
-    ```
-    imagetool cache addPatch --patchId 12345678_12.2.1.3.0 --path /path/to/patch.zip
+    ```bash
+    $ imagetool cache addPatch --patchId 12345678_12.2.1.3.0 --path /path/to/patch.zip
     ```
     **Note**:  When adding a patch to the cache store, the `patchId` should be in the following format:  `99999999_9.9.9.9.99999`  The first 8 digits is the patch ID, followed by an underscore, and then the release number to identify the patch between different patch versions.  
 
@@ -69,11 +69,11 @@ List and set cache options
 If you downloaded the release version ```12.2.1.3.190416``` of the patch, then you should use the argument ```--patchId 29135930_12.2.1.3.190416```.
 
 - `addEntry`: Consider this an expert mode where you can add key value pairs to the cache without any validation.
-    ```
-    imagetool cache addEntry --key xyz_123 --value /path/to/file
+    ```bash
+    $ imagetool cache addEntry --key xyz_123 --value /path/to/file
     ```
 
 - `deleteEntry`: Delete an entry from the cache for a given key. **Note**: This command does not delete files from the disk.
-    ```
-    imagetool cache deleteEntry --key xyz_123
+    ```bash
+    $ imagetool cache deleteEntry --key xyz_123
     ```
diff --git a/documentation/1.9/content/userguide/tools/create-image.md b/documentation/1.9/content/userguide/tools/create-image.md
@@ -143,7 +143,7 @@ create
 Use it on the command line, as follows:
 
 ```bash
-imagetool @/path/to/build_args
+$ imagetool @/path/to/build_args
 ```
 
 
@@ -155,18 +155,18 @@ The commands below assume that all the required JDK, WLS, or FMW (WebLogic infra
  to the cache directory. Use the [cache]({{< relref "/userguide/tools/cache.md" >}}) command to set it up.
 
 - Create an image named `sample:wls` with the WebLogic installer 12.2.1.3.0, server JDK 8u202, and latest PSU applied.
-    ```
-    imagetool create --tag sample:wls --latestPSU --user testuser@xyz.com --password hello
+    ```bash
+    $ imagetool create --tag sample:wls --latestPSU --user testuser@xyz.com --password hello
     ```
 
 - Create an image named `sample:wdt` with the same options as above and create a domain with [WebLogic Deploy Tooling](https://oracle.github.io/weblogic-deploy-tooling/).
-    ```
-    imagetool create --tag sample:wdt --latestPSU --user testuser@xyz.com --password hello --wdtModel /path/to/model.json --wdtVariables /path/to/variables.json --wdtVersion 0.16
+    ```bash
+    $ imagetool create --tag sample:wdt --latestPSU --user testuser@xyz.com --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.
 
 - Create an image named `sample:patch` with the selected patches applied.
-    ```
-    imagetool create --tag sample:patch --user testuser@xyz.com --password hello --patches 12345678,p87654321
+    ```bash
+    $ imagetool create --tag sample:patch --user testuser@xyz.com --password hello --patches 12345678,p87654321
     ```
     The patch numbers may or may not start with '`p`'.
diff --git a/documentation/1.9/content/userguide/tools/rebase-image.md b/documentation/1.9/content/userguide/tools/rebase-image.md
@@ -110,7 +110,7 @@ rebase
 Use it on the command line, as follows:
 
 ```bash
-imagetool @/path/to/build_args
+$ imagetool @/path/to/build_args
 ```
 
 
@@ -124,20 +124,20 @@ The commands below assume that all the required JDK, WLS, or FMW (WebLogic infra
 
 - Update the JDK for an existing domain.  Copy the existing domain from `sample:v1` where the JDK was 8u202 to a new
 image called `sample:v2` and install the newer JDK 8u221 with WebLogic Server 12.2.1.3.0.
-    ```
-    imagetool rebase --tag sample:v2 --sourceImage sample:v1 --version 12.2.1.3.0 --jdkVersion 8u221
+    ```bash
+    $ imagetool rebase --tag sample:v2 --sourceImage sample:v1 --version 12.2.1.3.0 --jdkVersion 8u221
     ```
 
 - Update the Oracle Home for an existing domain with a newer WebLogic version.  Copy a domain from an existing image to
 a new image with a new install of WebLogic Server 12.2.1.4.0.  Copy the domain
 from `sample:v1` and select the desired WebLogic installer using the `--version` argument.  
-    ```
-    imagetool rebase --tag sample:v2 --sourceImage sample:v1 --version 12.2.1.4.0 --jdkVersion 8u221
+    ```bash
+    $ imagetool rebase --tag sample:v2 --sourceImage sample:v1 --version 12.2.1.4.0 --jdkVersion 8u221
     ```
 
 - Update the JDK and/or Oracle Home for an existing domain using another image with pre-installed binaries.
 Copy the domain from the source image named `sample:v1` to a new image called `sample:v2` based on a target image
 named `fmw:12214`.  **Note**: The Oracle Home and JDK must be installed in the same same folders on each image.
-    ```
-    imagetool rebase --tag sample:v2 --sourceImage sample:v1 --targetImage fmw:12214
+    ```bash
+    $ imagetool rebase --tag sample:v2 --sourceImage sample:v1 --targetImage fmw:12214
     ```
diff --git a/documentation/1.9/content/userguide/tools/update-image.md b/documentation/1.9/content/userguide/tools/update-image.md
