Add parameter tables to 2.0 documentation #1062
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
CarolynRountree
requested review from
jshum2479,
robertpatrick,
ddsharpe and
rakillen
ddsharpe
reviewed
Jan 26, 2022
|
|
||
| | Parameter | Definition | Default | | ||
| | --- | --- | --- | | ||
| | -oracle_home | Home directory of the Oracle installation. Required if ORACLE_HOME environment variable is not set | | |
There was a problem hiding this comment.
Missing period at the end of the sentence. Change "Oracle installation" to be more specific for middleware, like "Oracle WebLogic installation" .
| | -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. | | | ||
| | -domain_type | The type of domain (e.g., WLS, JRF). This controls the domain templates and template resource targeting. | WLS | | ||
| | -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. | | | ||
| | -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. | | |
There was a problem hiding this comment.
Shouldn't this be marked as "(Required)"?
There was a problem hiding this comment.
-model_file is optional, if the model is in the archive (see -archive_file above).
Could be clearer here though.
documentation/2.0/content/userguide/tools/variable_injection.md
Outdated
Show resolved
Hide resolved
documentation/2.0/content/userguide/tools/variable_injection.md
Outdated
Show resolved
Hide resolved
documentation/2.0/content/userguide/tools/variable_injection.md
Outdated
Show resolved
Hide resolved
rakillen
reviewed
Jan 27, 2022
| | Parameter | Definition | Default | | ||
| | ---- | ---- | ---- | | ||
| | -model_path | The path to the model element to be examined. The format is [^<section^>:][/^<folder^>]... | | | ||
| | -oracle_home | An existing Oracle Home directory. This is required unless the ORACLE_HOME environment variable is set. | | |
There was a problem hiding this comment.
modelHelp also has -attributes_only, -folders_only, and -recursive. They have descriptions further down in the modelHelp.cmd and .sh comments.
robertpatrick
requested changes
Feb 2, 2022
There was a problem hiding this comment.
There are a couple of things to consider here:
- To get the tables to render correctly, we should add back-ticks around all parameter names like
-model_file. - With the new YAML parser, many fields that are currently quoted are no longer required to be quoted to pass through the parser. Should we clean up the examples to remove quotes where they are no longer required?
robertpatrick
approved these changes
Feb 4, 2022
ddsharpe
approved these changes
Feb 4, 2022
rakillen
approved these changes
Feb 4, 2022
ddsharpe
deleted the
WDT-444-add-parameter-tables-to-documentation-for-commnds
branch
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes Jira #444