improve clarity on setup and prerequisites documentation #335
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
| - OPTIONALLY: Podman 3.x may be used in place of Docker. | ||
| - Installers for WebLogic Server and JDK from the [Oracle Software Delivery Cloud](https://edelivery.oracle.com). | ||
| - A container image client on the build machine, such as Docker or Podman. | ||
| - For Docker a minimum version of 18.03.1.ce is required. |
There was a problem hiding this comment.
For Docker -> For Docker, (comma)
For Podman -> For Podman, (comma)
| - A container image client on the build machine, such as Docker or Podman. | ||
| - For Docker a minimum version of 18.03.1.ce is required. | ||
| - For Podman a minimum version of 3.0.1 is required. | ||
| - An installed version of Java to run ImageTool, version 8+. |
| - Download and unzip the WIT release ZIP file to a desired location. | ||
| - OPTIONALLY: You may build the project (`mvn clean package`) to create the ZIP installer in `./imagetool/target`. | ||
| - Download the WIT release ZIP file to a desired location. | ||
| - The latest ZIP can be found on the project [releases](https://github.com/oracle/weblogic-image-tool/releases) page. |
There was a problem hiding this comment.
latest ZIP -> latest ZIP file
| - OPTIONALLY: You may build the project (`mvn clean package`) to create the ZIP installer in `./imagetool/target`. | ||
| - Download the WIT release ZIP file to a desired location. | ||
| - The latest ZIP can be found on the project [releases](https://github.com/oracle/weblogic-image-tool/releases) page. | ||
| - Alternatively, you can download the ZIP with cUrl. |
There was a problem hiding this comment.
ZIP -> ZIP file (please fix globally)
cUrl -> cURL
tbarnes-us
reviewed
Dec 10, 2021
| - Download and unzip the WIT release ZIP file to a desired location. | ||
| - OPTIONALLY: You may build the project (`mvn clean package`) to create the ZIP installer in `./imagetool/target`. | ||
| - Download the WIT release ZIP file to a desired location. | ||
| - The latest ZIP file can be found on the project [releases](https://github.com/oracle/weblogic-image-tool/releases) page. |
There was a problem hiding this comment.
The latest ZIP file --> The latest release Zip file and Zip files for earlier releases
tbarnes-us
reviewed
Dec 10, 2021
| - Alternatively, you can download the ZIP file with cURL. | ||
| ```shell | ||
| curl -m 120 -fL https://github.com/oracle/weblogic-image-tool/releases/latest/download/imagetool.zip -o ./imagetool.zip | ||
| ``` |
There was a problem hiding this comment.
- "the ZIP file" --> the latest ZIP file
- it'd be helpful IMO to also teach how to get a specific version (assuming that is straight forward)
- would it help if the non-quickstart samples could point to quick start? (for help with download/install)
There was a problem hiding this comment.
- the sample assumes image tool bin is in the PATH, but has no instructions for setting same
There was a problem hiding this comment.
- the sample assumes image tool bin is in the PATH, but has no instructions for setting same
I think we can assume that the user knows how to add a directory to the PATH.
robertpatrick
approved these changes
Dec 10, 2021
ddsharpe
changed the title
tbarnes-us
approved these changes
Dec 10, 2021
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 #333. Minor updates to Build from Source, Setup, and Prerequisite documentation pages.