Skip to content

Commit e0eb236

Browse files
fix for comments. standardize where necessary
1 parent ce6705f commit e0eb236

File tree

11 files changed

+30
-30
lines changed

11 files changed

+30
-30
lines changed

documentation/2.0/content/userguide/tools/compare.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -297,6 +297,6 @@ Comparing the new and old models:
297297

298298
| Parameter | Definition | Default |
299299
| --- | --- | --- |
300-
| -oracle_home | Home directory of the Oracle installation. Required if ORACLE_HOME environment variable is not set | |
301-
| -output_directory | (Required) Directory in which to store the output. | |
300+
| -oracle_home | Home directory of the Oracle installation. Required if ORACLE_HOME environment variable is not set. | |
301+
| -output_dir | (Required) Directory in which to store the output. | |
302302
| -variable_file | Variable file used for token substitution. | |

documentation/2.0/content/userguide/tools/create.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -64,10 +64,10 @@ topology:
6464
| -archive_file | The path to the archive file to use. If the -model_file argument is not specified, the model file in this archive will be used. This can also be specified as a comma-separated list of archive files. The overlapping contents in each archive take precedence over previous archives in the list. | |
6565
| -domain_home | Required if -domain_parent is not used. The full directory and name where the domain should be created.
6666
| -domain_parent | Required if -domain_home is not used. The parent directory where the domain should be created. The name is the domain name in the model. | |
67-
| -domain_type | The type of domain (e.g., WLS, JRF). This controls the domain templates and template resource targeting. | WLS |
67+
| -domain_type | The type of domain (e.g., WLS, JRF). | WLS |
6868
| -java_home | The Java Home to use for the new domain. If not specified, it defaults to the value of the JAVA_HOME environment variable. | |
69-
| -model_file | The location of the model file to use. This can also be specified as a comma-separated list of model locations, where each successive model layers on top of the previous ones. | |
70-
| -oracle_home | The existing Oracle Home directory for the domain. This is required unless the ORACLE_HOME environment variable is set. | |
69+
| -model_file | The location of the model file. This can also be specified as a comma-separated list of model locations, where each successive model layers on top of the previous ones. | |
70+
| -oracle_home | Home directory of the Oracle WebLogic Installation. Required if ORACLE_HOME environment variable is not set.| |
7171
| -opss_wallet_passphrase_env | An alternative to entering the OPSS wallet passphrase at a prompt. The value is an ENVIRONMENT VARIABLE name that WDT will use to retrieve the passphrase. | |
7272
| -opss_wallet_passphrase_file | An alternative to entering the OPSS wallet passphrase at a prompt. The value is the name of a file with a string value which WDT will read to retrieve the passphrase.
7373
| -passphrase_env | An alternative to entering the encryption passphrase at a prompt. The value is an ENVIRONMENT VARIABLE name that WDT will use to retrieve the passphrase. | |

documentation/2.0/content/userguide/tools/deploy.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -52,11 +52,11 @@ The Deploy Applications Tool supports the use of multiple models, as described i
5252
| -admin_user | The admin username used for online deploy. | |
5353
| -archive_file | The path to the archive file. If the model_file argument is not used, the model file in this file will be used. This can also be specified as a comma-separated list of archive files. The overlapping contents in each archive take precedence over previous archives in the list. | |
5454
| -cancel_changes_if_restart_required | Cancel the changes if the update requires domain restart. | |
55-
| -discard_current_edit | Discard all current edits before starting update. | |
56-
| -domain_home | (Required). The domain home directory. | |
57-
| -domain_type | The type of domain. | WLS |
55+
| -discard_current_edit | Discard all current domain edits before starting update. | |
56+
| -domain_home | (Required). The location of the existing domain home. | |
57+
| -domain_type | The type of domain. (e.g., WLS, JRF) | WLS |
5858
| -model_file | The location of the model file. This can also be specified as a comma-separated list of model locations, where each successive model layers on top of the previous ones. | |
59-
| -oracle_home | The location of the existing oracle home directory. Required if ORACLE_HOME environment variable is not set. | |
59+
| -oracle_home | Home directory of the Oracle WebLogic Installation. Required if ORACLE_HOME environment variable is not set.| |
6060
| -output_dir | If present, write restart information to this directory as restart.file, or, if cancel_changes_if_restart_required used, write non dynamic changes information to file. | |
6161
| -passphrase_env | An alternative to entering the encryption passphrase at a prompt. The value is an ENVIRONMENT VARIABLE name that WDT will use to retrieve the passphrase. | |
6262
| -passphrase_file | An alternative to entering the encryption passphrase at a prompt. The value is the name of a file with a string value which WDT will read to retrieve the passphrase. | |

documentation/2.0/content/userguide/tools/discover.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -81,16 +81,16 @@ Please provide the `STDOUT` and `STDERR` log streams in the GitHub Issue. If the
8181

8282
| Parameter | Definition | Default |
8383
| ---- | ---- | ---- |
84-
| -archive_file | The path to the archive file | |
84+
| -archive_file | The path to the archive file. | |
8585
| -admin_pass_env | An alternative to entering the admin password at a prompt. The value is a ENVIRONMENT VARIABLE name that WDT will use to retrieve the password. | |
86-
| -admin_pass_file | An alternative to entering the admin password at a prompt. The value is a ENVIRONMENT VARIABLE name that WDT will use to retrieve the password. | |
86+
| -admin_pass_file | An alternative to entering the admin password at a prompt. The value is a the name of a file that contains a password string that the tool will read to retrieve the password. | |
8787
| -admin_url | The admin server URL used for online discovery. | |
8888
| -admin_user | The admin user used for online discovery. | |
89-
| -domain_home | (Required). The domain home directory to discover. | |
90-
| -domain_type | The domain type. | WLS |
89+
| -domain_home | (Required). The location of the existing domain home. | |
90+
| -domain_type | The type of domain. (e.g., WLS, JRF) | WLS |
9191
| -java_home | Overrides the JAVA_HOME value when discovering domain values to be replaced with the java home global token. | |
92-
| -model_file | Location and name to write the model file to archive. | |
93-
| -oracle_home | The existing Oracle Home directory for the domain. This is required unless the ORACLE_HOME environment variable is set. | |
92+
| -model_file | The path to the model file. If not present, model file will be stored in archive file. | |
93+
| -oracle_home | Home directory of the Oracle WebLogic Installation. Required if ORACLE_HOME environment variable is not set. | |
9494
| -output_dir | Output directory required for -target. | |
9595
| -skip_archive | Do not generate an archive file. The archive_file option will be ignored. | |
9696
| -target | Targeting platform - k8s, wko, vz. | |

documentation/2.0/content/userguide/tools/encrypt.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -225,8 +225,8 @@ The variable file will now look something like the following:
225225
| Parameter | Definition | Default |
226226
| ---- | ---- | ---- |
227227
| -manual | Run without a model and get an encrypted value for a single password. | |
228-
| -model_file | The location of a model file or a set of model files. | |
229-
| -oracle_home | The existing Oracle Home directory for the domain. This is required unless the ORACLE_HOME environment variable is set.| |
228+
| -model_file | The location of the model file or a set of model files. | |
229+
| -oracle_home | Home directory of the Oracle WebLogic Installation. Required if ORACLE_HOME environment variable is not set. | |
230230
| -passphrase_env | An alternative to entering the encryption passphrase at a prompt. The value is a ENVIRONMENT VARIABLE name that WDT will use to retrieve the passphrase. | |
231231
| -passphrase_file | An alternative to entering the encryption passphrase at a prompt. The value is a the name of a file with a string value which WDT will read to retrieve the passphrase. | |
232232
| -variable_file | The location and name of the property file containing the variable values for all variables used in the model(s). | |

documentation/2.0/content/userguide/tools/kubernetes.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -132,5 +132,5 @@ The content in the `kubernetes` section is not generated when a model is discove
132132
| -domain_home | (Required) The domain home directory. | |
133133
| -domain_resource_file | (Required) The location of the extracted domain resource file. | |
134134
| -model_file | The location of the model file. This can also be specified as a comma-separated list of model locations, where each successive model layers on top of the previous ones. | |
135-
| -oracle_home | The existing Oracle Home directory for the domain. This is required unless the ORACLE_HOME environment variable is set. | |
135+
| -oracle_home | Home directory of the Oracle WebLogic Installation. Required if ORACLE_HOME environment variable is not set. | |
136136
| -variable_file | The location of the property file containing the values for variables used in the model. This can also be specified as a comma-separated list of property files, where each successive set of properties layers on top of the previous ones. | |

documentation/2.0/content/userguide/tools/model_help.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -130,5 +130,5 @@ resources:
130130
131131
| Parameter | Definition | Default |
132132
| ---- | ---- | ---- |
133-
| -model_path | The path to the model element to be examined. The format is [^<section^>:][/^<folder^>]... | |
134-
| -oracle_home | An existing Oracle Home directory. This is required unless the ORACLE_HOME environment variable is set. | |
133+
| -oracle_home | Home directory of the Oracle WebLogic Installation. Required if ORACLE_HOME environment variable is not set. | |
134+
| <model_path> | The path to the model element to be examined. The format is [^<section^>:][/^<folder^>]... | |

documentation/2.0/content/userguide/tools/prepare.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ For more information about additional target environments and options, see [Targ
4343
| Parameter | Definition | Default |
4444
| ---- | ---- | ---- |
4545
| -model_file | (Required). Location of the model file. This can also be specified as a comma-separated list of models, where each successive model layers on top of the previous ones. | |
46-
| -oracle_home | An existing Oracle home. This is required unless the ORACLE_HOME ENVIRONMENT is set' | |
46+
| -oracle_home | Home directory of the Oracle WebLogic Installation. Required if ORACLE_HOME environment variable is not set. | |
4747
| -output_dir | (Required) Location where to write the output files. | |
4848
| -target | (Required) Name of the target configuration such as wko, vz, k8s. | |
4949
| -variable_file | The location of the property file containing the values for variables used in the model. This can also be specified as a comma-separated list of property files, where each successive set of properties layers on top of the previous ones. | |

documentation/2.0/content/userguide/tools/update.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -46,13 +46,13 @@ The Update Domain Tool supports the use of multiple models, as described in [Usi
4646
| -admin_pass_file | An alternative to entering the admin password at a prompt. The value is a the name of a file that contains a password string that the tool will read to retrieve the password. | |
4747
| -admin_url | The admin server URL for online update. | |
4848
| -admin_user | The admin username for online update. | |
49-
| -archive_file | The path to the archive file to use. If the -model_file argument is not specified, the model file in this archive will be used. This can also be specified as a comma-separated list of archive files. The overlapping contents in each archive take precedence over previous archives in the list. | |
49+
| -archive_file | The path to the archive file to use. If the -model_file argument is not specified, the model file in this archive will be used. This can also be specified as a comma-separated list of archive files. The overlapping contents in each archive take precedence over previous archives in the list. | |
5050
| -cancel_changes_if_restart_required | Cancel the changes if the update requires domain restart. | |
51-
| -discard_current_edit | Discard all existing edits before the update. | |
51+
| -discard_current_edit | Discard all existing domain edits before the update. | |
5252
| -domain_home | (Required) The location of the existing domain home. | |
53-
| -domain_type | The type of domain to update. | WLS |
53+
| -domain_type | The type of domain. (e.g., WLS, JRF) | WLS |
5454
| -model_file | The location of the model file. This can also be specified as a comma-separated list of model locations, where each successive model layers on top of the previous ones. | |
55-
| -oracle_home | The existing Oracle Home directory for the domain. This is required unless the ORACLE_HOME environment variable is set. | |
55+
| -oracle_home | Home directory of the Oracle WebLogic Installation. Required if ORACLE_HOME environment variable is not set. | |
5656
| -passphrase_env | An alternative to entering the encryption passphrase at a prompt. The value is a ENVIRONMENT VARIABLE name that WDT will use to retrieve the passphrase. | |
5757
| -passphrase_file | An alternative to entering the encryption passphrase at a prompt. The value is a the name of a file with a string value which WDT will read to retrieve the passphrase. | |
5858
| -update_dir | If present, write restart information to this directory as restart.file, or if cancel_changes_if_restart_required used, write non dynamic changes information to non_dynamic_changes file. | |

documentation/2.0/content/userguide/tools/validate.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -105,9 +105,9 @@ The Validate Model Tool supports the use of multiple models, as described in [Us
105105
| Parameter | Definition | Default |
106106
| ---- | ---- | ---- |
107107
| -archive_file | The path to the archive file to use. If the archive file is not provided, validation will only validate the artifacts provided. This can also be specified as a comma-separated list of archive files. The overlapping contents in each archive take precedence over previous archives in the list. | |
108-
| -domain_type | The type of domain. | WLS |
108+
| -domain_type | The type of domain. (e.g., WLS, JRF) | WLS |
109109
| -model_file | The location of the model file to use. This can also be specified as a comma-separated list of model locations, where each successive model layers on top of the previous ones. If not specified, the tool will look for the model in the archive. If the model is not found, validation will only validate the artifacts provided. | |
110-
| -oracle_home | The existing Oracle Home directory for the domain. This is required unless the ORACLE_HOME environment variable is set. | |
110+
| -oracle_home | Home directory of the Oracle WebLogic Installation. Required if ORACLE_HOME environment variable is not set. | |
111111
| -target_mode | The target WLST mode that the tool should use to validate the model content. The only valid values are online or offline. | offline |
112-
| -target_version | The target version of WebLogic Server the tool should use to validate the model content. This version number can be different than the version being used to run the tool. If not specified, the tool will validate against the version being used to run the tool. | |
112+
| -target_version | The target version of WebLogic Server the tool should use to validate the model content. This version number can be different than the version being used to run the tool. | Oracle home version |
113113
| -variable_file | The location of the property file containing the variable values for all variables used in the model. If the variable file is not provided, validation will only validate the artifacts provided. | |

0 commit comments

Comments
 (0)