Cu 86bzwgbye update installation section #295
Conversation
|
Task linked: CU-86bzwgbye Update Installation section |
WalkthroughThe recent changes to the JeMPI documentation focus on enhancing clarity and usability. Key updates include restructuring installation guides, updating software dependency versions, refining image captions, and improving the organization of documentation. These modifications aim to provide a clearer understanding of the setup process and the architecture of the JeMPI Client Registry, ultimately facilitating a better user experience. Changes
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 as PR comments)
Additionally, you can add CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
Outside diff range, codebase verification and nitpick comments (5)
documentation/installation/standalone-installation.md (5)
60-60: Add missing article for clarity.Consider adding "the" for improved readability: "Set the following variables".
- **Set following variables** + **Set the following variables**Tools
LanguageTool
[uncategorized] ~60-~60: You might be missing the article “the” here.
Context: ...ile Name** - local-deployment.sh Set following variables\ JAVA_VERSION=21.0.3-tem \ ...(AI_EN_LECTOR_MISSING_DETERMINER_THE)
115-115: Add missing article for clarity.Consider adding "the" for improved readability: "This process will remove the entire stack from the swarm".
- This process will remove all stack from swarm and leave the swarm. + This process will remove the entire stack from the swarm and leave the swarm.Tools
LanguageTool
[uncategorized] ~115-~115: You might be missing the article “the” here.
Context: ...This process will remove all stack from swarm and leave the swarm. - Remove all data ...(AI_EN_LECTOR_MISSING_DETERMINER_THE)
151-151: Correct punctuation for clarity.Remove the loose punctuation mark for improved readability.
- (e.g. `VIM`, `VI`, `Emacs`, `Helix`, etc.) : + (e.g. `VIM`, `VI`, `Emacs`, `Helix`, etc.):Tools
LanguageTool
[uncategorized] ~151-~151: Loose punctuation mark.
Context: ...g.VIM,VI,Emacs,Helix, etc.) :bash sudo vim /etc/hostsKeep ...(UNLIKELY_OPENING_PUNCTUATION)
66-66: Use consistent emphasis style.Replace asterisks with underscores for emphasis consistency.
- *This script must be run from the following path and will not work if executed from a different location* + _This script must be run from the following path and will not work if executed from a different location_Tools
Markdownlint
66-66: Expected: underscore; Actual: asterisk
Emphasis style(MD049, emphasis-style)
66-66: Expected: underscore; Actual: asterisk
Emphasis style(MD049, emphasis-style)
77-77: Use consistent emphasis style.Replace asterisks with underscores for emphasis consistency.
- *This Option used to install JeMPI from Scratch or Fresh setup* + _This Option used to install JeMPI from Scratch or Fresh setup_Tools
Markdownlint
77-77: Expected: underscore; Actual: asterisk
Emphasis style(MD049, emphasis-style)
77-77: Expected: underscore; Actual: asterisk
Emphasis style(MD049, emphasis-style)
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (2)
- documentation/architecture.md (2 hunks)
- documentation/installation/standalone-installation.md (6 hunks)
Additional context used
Markdownlint
documentation/architecture.md
11-11: Expected: h2; Actual: h3
Heading levels should only increment by one level at a time(MD001, heading-increment)
documentation/installation/standalone-installation.md
83-83: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
86-86: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
89-89: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
92-92: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
98-98: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
103-103: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
109-109: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
114-114: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
66-66: Expected: underscore; Actual: asterisk
Emphasis style(MD049, emphasis-style)
66-66: Expected: underscore; Actual: asterisk
Emphasis style(MD049, emphasis-style)
77-77: Expected: underscore; Actual: asterisk
Emphasis style(MD049, emphasis-style)
77-77: Expected: underscore; Actual: asterisk
Emphasis style(MD049, emphasis-style)
200-200: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
246-246: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
256-256: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
273-273: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
LanguageTool
documentation/installation/standalone-installation.md
[uncategorized] ~60-~60: You might be missing the article “the” here.
Context: ...ile Name** - local-deployment.sh Set following variables\ JAVA_VERSION=21.0.3-tem \ ...(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[uncategorized] ~115-~115: You might be missing the article “the” here.
Context: ...This process will remove all stack from swarm and leave the swarm. - Remove all data ...(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[uncategorized] ~151-~151: Loose punctuation mark.
Context: ...g.VIM,VI,Emacs,Helix, etc.) :bash sudo vim /etc/hostsKeep ...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~168-~168: Possible missing comma found.
Context: ...env ``` if you have less than 32Gbs of ram run the ./create-env-linux-low-1.sh. ...(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~168-~168: The grammatical number of this noun doesn’t look right. Consider replacing it.
Context: ...create-env-linux-high-1.sh_. both those script will create conf.env file that we wil...(AI_EN_LECTOR_REPLACEMENT_NOUN_NUMBER)
[uncategorized] ~168-~168: You might be missing the article “the” here.
Context: ...gh-1.sh_. both those script will create conf.env file that we will need. ```ba...(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[uncategorized] ~204-~204: A comma might be missing here.
Context: ...http and not https. To read more about it check this link: [Test an insecure regi...(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[uncategorized] ~208-~208: You might be missing the article “the” here.
Context: ...n.json_ and will restart docker to make changes take effect. NB: The script will edit ...(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[uncategorized] ~262-~262: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...r/helper/scripts and run d-stack-ps.sh and it will run:\ _docker stack ps <NAME_S...(COMMA_COMPOUND_SENTENCE)
Additional comments not posted (4)
documentation/architecture.md (1)
13-13: Improved image captions enhance clarity.The updated image captions provide better context and understanding for the diagrams, improving the documentation's usability.
Also applies to: 172-172
documentation/installation/standalone-installation.md (3)
36-39: Version updates are accurate and necessary.The updates to Maven and Java versions ensure compatibility with the latest features and security improvements.
58-58: Script name change is appropriate.The change to
local-deployment.shprovides a clearer indication of the script's purpose. Ensure all references to this script are updated consistently throughout the documentation.
165-165: Directory path change improves organization.Updating the directory path to
devops/linux/docker/conf/envreflects a more structured organization, which is beneficial for maintainability.
documentation/architecture.md
Outdated
| @@ -8,16 +8,17 @@ The JeMPI Client Registry is a system that incorporates a microservice architect | |||
|
|
|||
| **Below the synchronous and asynchronous flow diagram.** | |||
|
|
|||
| #### [Asynchronous flow](https://drive.google.com/file/d/1G3_-BZNwRSOeriad6IbR6rFERQUnx1AK/view?usp=sharing) <a href="#_2v012h2bohjt" id="_2v012h2bohjt"></a> | |||
| ### [Asynchronous flow](https://drive.google.com/file/d/1G3_-BZNwRSOeriad6IbR6rFERQUnx1AK/view?usp=sharing) <a href="#_2v012h2bohjt" id="_2v012h2bohjt"></a> | |||
There was a problem hiding this comment.
Adjust heading levels for consistency.
The heading "Asynchronous flow" has been changed to a level 3 heading, which may cause inconsistency as per markdownlint hint (MD001). Ensure heading levels increment by one level at a time.
- ### [Asynchronous flow](https://drive.google.com/file/d/1G3_-BZNwRSOeriad6IbR6rFERQUnx1AK/view?usp=sharing) <a href="#_2v012h2bohjt" id="_2v012h2bohjt"></a>
+ #### [Asynchronous flow](https://drive.google.com/file/d/1G3_-BZNwRSOeriad6IbR6rFERQUnx1AK/view?usp=sharing) <a href="#_2v012h2bohjt" id="_2v012h2bohjt"></a>Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| ### [Asynchronous flow](https://drive.google.com/file/d/1G3_-BZNwRSOeriad6IbR6rFERQUnx1AK/view?usp=sharing) <a href="#_2v012h2bohjt" id="_2v012h2bohjt"></a> | |
| #### [Asynchronous flow](https://drive.google.com/file/d/1G3_-BZNwRSOeriad6IbR6rFERQUnx1AK/view?usp=sharing) <a href="#_2v012h2bohjt" id="_2v012h2bohjt"></a> |
Tools
Markdownlint
11-11: Expected: h2; Actual: h3
Heading levels should only increment by one level at a time(MD001, heading-increment)
There was a problem hiding this comment.
Actionable comments posted: 0
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (1)
- documentation/architecture.md (2 hunks)
Files skipped from review as they are similar to previous changes (1)
- documentation/architecture.md
Summary by CodeRabbit