updated java installation prerequisite #321
Conversation
WalkthroughThe documentation for the standalone installation process has been updated to specify the required Java version as 21.0.3-tem, replacing the previous version. New instructions have been added for users with non-root accounts to correctly set the Java directory, along with a note for server installations to manually set the Changes
Possibly related PRs
Poem
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
…n-Java-Prerequisites
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
Outside diff range and nitpick comments (1)
documentation/installation/standalone-installation.md (1)
33-35: Specify the language for the code block.For better formatting and syntax highlighting, please specify the language for the code block.
Apply this diff:
-``` +```bash source "/home/${USER}/.sdkman/candidates/java/current"<details> <summary>Tools</summary> <details> <summary>Markdownlint</summary><blockquote> 33-33: null Fenced code blocks should have a language specified (MD040, fenced-code-language) </blockquote></details> </details> </blockquote></details> </blockquote></details> <details> <summary>Review details</summary> **Configuration used: CodeRabbit UI** **Review profile: CHILL** <details> <summary>Commits</summary> Files that changed from the base of the PR and between c8028dcfde9d94fe6a5a3fdd8bfbbcb719ae681f and 0eafe7f52ea76c4c25f9026dbf8434453b12043f. </details> <details> <summary>Files selected for processing (1)</summary> * documentation/installation/standalone-installation.md (1 hunks) </details> <details> <summary>Additional context used</summary> <details> <summary>Markdownlint</summary><blockquote> <details> <summary>documentation/installation/standalone-installation.md</summary><blockquote> 33-33: null Fenced code blocks should have a language specified (MD040, fenced-code-language) </blockquote></details> </blockquote></details> </details> <details> <summary>Additional comments not posted (1)</summary><blockquote> <details> <summary>documentation/installation/standalone-installation.md (1)</summary><blockquote> `31-37`: **LGTM!** The added instruction for non-root users to source Java from their home directory is clear and helpful. <details> <summary>Tools</summary> <details> <summary>Markdownlint</summary><blockquote> 33-33: null Fenced code blocks should have a language specified (MD040, fenced-code-language) </blockquote></details> </details> </blockquote></details> </blockquote></details> </details> <!-- This is an auto-generated comment by CodeRabbit for review status -->
…n-Java-Prerequisites
…n-Java-Prerequisites
There was a problem hiding this comment.
Actionable comments posted: 0
Outside diff range and nitpick comments (3)
documentation/installation/standalone-installation.md (3)
41-45: Use a proper heading instead of emphasis.The added note with instructions for non-root users is a valuable addition to improve the clarity of the installation process. However, please use a proper Markdown heading (e.g.,
###) instead of emphasis for the note to adhere to Markdown best practices and address the static analysis hint.-**Note: when installing with a non-root user set java directory** +### Note: when installing with a non-root user set java directoryTools
Markdownlint
41-41: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
42-42: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
178-181: Use a proper heading instead of emphasis.The added note with instructions for server installations to set the
SERVER_IPenvironment variable is a valuable addition to improve the clarity of the installation process. However, please use a proper Markdown heading (e.g.,###) instead of emphasis for the note to adhere to Markdown best practices and address the static analysis hint.-**Note: for server installations, manually set SERVER_IP for environment variable before executing the script** +### Note: for server installations, manually set SERVER_IP for environment variable before executing the scriptTools
Markdownlint
178-178: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
42-42: Remove the empty code block or specify a language.The empty code block should either be removed or have a language specified (e.g.,
bash) if it's intended to showcase a command or code snippet. Specifying the language for code blocks is a Markdown best practice that enables syntax highlighting and improves readability.Tools
Markdownlint
42-42: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (1)
- documentation/installation/standalone-installation.md (3 hunks)
Additional context used
Markdownlint
documentation/installation/standalone-installation.md
41-41: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
42-42: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
178-178: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
Additional comments not posted (1)
documentation/installation/standalone-installation.md (1)
38-38: LGTM!The Java version has been correctly updated to 21.0.3-tem as per the PR objective.
There was a problem hiding this comment.
Actionable comments posted: 0
Outside diff range and nitpick comments (2)
documentation/installation/standalone-installation.md (2)
41-45: Improve the note formatting.The addition of the note with instructions for non-root users to set the Java directory is helpful and enhances clarity. The code block correctly sources the Java directory path using the user's home directory.
However, please consider converting the emphasized note text to a proper heading for better document structure:
-**Note: when installing with a non-root user set java directory** +#### Note: Set Java directory when installing with a non-root userTools
Markdownlint
41-41: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
42-42: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
178-181: Improve the note formatting.The addition of the note advising users to manually set the
SERVER_IPenvironment variable for server installations is helpful and aligns with the PR objective. The code block provides a clear example of how to set theREACT_APP_JEMPI_BASE_API_HOSTenvironment variable using theSERVER_IP.However, please consider converting the emphasized note text to a proper heading for better document structure:
-**Note: for server installations, manually set SERVER_IP for environment variable before executing the script** +#### Note: Set `SERVER_IP` environment variable for server installationsTools
LanguageTool
[uncategorized] ~178-~178: The preposition ‘as’ seems more likely in this position.
Context: ...r installations, manually set SERVER_IP for environment variable before executing t...(AI_HYDRA_LEO_REPLACE_FOR_AS)
Markdownlint
178-178: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (1)
- documentation/installation/standalone-installation.md (3 hunks)
Additional context used
Markdownlint
documentation/installation/standalone-installation.md
41-41: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
42-42: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
178-178: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
LanguageTool
documentation/installation/standalone-installation.md
[uncategorized] ~178-~178: The preposition ‘as’ seems more likely in this position.
Context: ...r installations, manually set SERVER_IP for environment variable before executing t...(AI_HYDRA_LEO_REPLACE_FOR_AS)
Additional comments not posted (1)
documentation/installation/standalone-installation.md (1)
38-38: LGTM!The Java installation command has been correctly updated to use version 21.0.3-tem, aligning with the PR objective.
MatthewErispe
deleted the
CU-86c089af1_Documentation-Update-Installation-Java-Prerequisites
branch
Summary by CodeRabbit
SERVER_IPenvironment variable before executing the installation script.