Revamped installation instructions & Software Dependencies pages with Docker-first approach #2
Conversation
WalkthroughThe pull request revises the developer guide documentation. The installation instructions are now presented as a detailed, step-by-step guide organized into three sections: Software Dependencies, Infrastructure Setup, and Application Setup. Each section explains two installation paths—Dockerized and Manual—for clarity. Additionally, the software dependencies document has been reformatted with updated markdown header levels and newly added verification commands and details outlining optional tools. No changes were made to public entity declarations. 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 (
|
![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
🧹 Nitpick comments (1)
developer-guide/development-environment-setup/installation-instructions/for-api-repositories.md (1)
17-19: Adjust Unordered List Indentation to Resolve MD007The markdown linter reports that the unordered list items in this section are indented by 3 spaces, while the expected indent is 0. Removing the extra spaces will help maintain consistency and avoid linting warnings.
- * Navigate to your project directory using the `cd` command. - * Use the Maven command `mvn clean install` to build your project. - * To run your Java application, use `mvn spring-boot:run -DENV_VAR=local`. Ensure the Redis server is open during the run. +* Navigate to your project directory using the `cd` command. +* Use the Maven command `mvn clean install` to build your project. +* To run your Java application, use `mvn spring-boot:run -DENV_VAR=local`. Ensure the Redis server is open during the run.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
17-17: Unordered list indentation
Expected: 0; Actual: 3(MD007, ul-indent)
18-18: Unordered list indentation
Expected: 0; Actual: 3(MD007, ul-indent)
19-19: Unordered list indentation
Expected: 0; Actual: 3(MD007, ul-indent)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
developer-guide/development-environment-setup/installation-instructions/for-api-repositories.md(1 hunks)developer-guide/development-environment-setup/installation-instructions/for-ui-repositories.md(1 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
developer-guide/development-environment-setup/installation-instructions/for-api-repositories.md
17-17: Unordered list indentation
Expected: 0; Actual: 3
(MD007, ul-indent)
18-18: Unordered list indentation
Expected: 0; Actual: 3
(MD007, ul-indent)
19-19: Unordered list indentation
Expected: 0; Actual: 3
(MD007, ul-indent)
🔇 Additional comments (2)
developer-guide/development-environment-setup/installation-instructions/for-ui-repositories.md (1)
33-33: Flexible Port Instruction Enhances ClarityThe updated instruction now directs users to access the application using a placeholder for the port (
{PORT}), with a reference to the AMRIT documentation for the actual value. This improves flexibility over having a hardcoded URL and aligns well with the updated, Docker-first installation approach detailed in the overall documentation.developer-guide/development-environment-setup/installation-instructions/for-api-repositories.md (1)
15-20: New "Through CLI" Section AddedThe new section provides a clear, step-by-step procedure for building and running the Maven project via the command line. This addition nicely complements the existing IDE-centric instructions and enhances user flexibility.
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
17-17: Unordered list indentation
Expected: 0; Actual: 3(MD007, ul-indent)
18-18: Unordered list indentation
Expected: 0; Actual: 3(MD007, ul-indent)
19-19: Unordered list indentation
Expected: 0; Actual: 3(MD007, ul-indent)
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
developer-guide/development-environment-setup/installation-instructions/for-api-repositories.md (1)
47-47: Verify Consistency of Swagger UI Instructions in Run Configuration
The added instruction at line 47 to load the Swagger UI after running the configuration in STS/Eclipse reinforces user guidance. Please confirm that repeating this step in multiple sections (CLI and IDE configurations) is intentional and consistent with the overall documentation style.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
developer-guide/development-environment-setup/installation-instructions/for-api-repositories.md(3 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
developer-guide/development-environment-setup/installation-instructions/for-api-repositories.md
17-17: Unordered list indentation
Expected: 0; Actual: 3
(MD007, ul-indent)
18-18: Unordered list indentation
Expected: 0; Actual: 3
(MD007, ul-indent)
19-19: Unordered list indentation
Expected: 0; Actual: 3
(MD007, ul-indent)
20-20: Unordered list indentation
Expected: 0; Actual: 3
(MD007, ul-indent)
🔇 Additional comments (2)
developer-guide/development-environment-setup/installation-instructions/for-api-repositories.md (2)
15-21: Add "Through CLI" Section and Adjust Markdown List Indentation
The new "Through CLI" instructions are clear and provide a straightforward guide for CLI-based Maven builds and runs. However, the unordered list items (lines 17–20) are indented with three spaces, which triggers MD007 warnings in markdownlint. For consistency with the rest of the document—and to adhere to the lint rule—consider removing the extra indentation so that the bullet points align flush with the left margin.- * Navigate to your project directory using the `cd` command. - * Use the Maven command `mvn clean install` to build your project. - * To run your Java application, use `mvn spring-boot:run -DENV_VAR=local`. Ensure the Redis server is open during the run. - * Once the run is complete, load `http://localhost:{PORT}/swagger-ui.html#!/`, where PORT is defined in the [AMRIT documentation](https://github.com/PSMRI/AMRIT/blob/main/README.md). +* Navigate to your project directory using the `cd` command. +* Use the Maven command `mvn clean install` to build your project. +* To run your Java application, use `mvn spring-boot:run -DENV_VAR=local`. Ensure the Redis server is open during the run. +* Once the run is complete, load `http://localhost:{PORT}/swagger-ui.html#!/`, where PORT is defined in the [AMRIT documentation](https://github.com/PSMRI/AMRIT/blob/main/README.md).✅ Verification successful
Action: Adjust Markdown List Indentation in CLI Instructions
The diff provided is accurate—remove the extra three spaces before the bullet list items so they align flush with the left margin to prevent MD007 warnings.
- Update the file
developer-guide/development-environment-setup/installation-instructions/for-api-repositories.mdso that the list items start at the beginning of the line (no extra indentation).🏁 Scripts executed
The following scripts were executed for the analysis:
Error: No shell scripts found
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
17-17: Unordered list indentation
Expected: 0; Actual: 3(MD007, ul-indent)
18-18: Unordered list indentation
Expected: 0; Actual: 3(MD007, ul-indent)
19-19: Unordered list indentation
Expected: 0; Actual: 3(MD007, ul-indent)
20-20: Unordered list indentation
Expected: 0; Actual: 3(MD007, ul-indent)
66-66: Standardize Bullet List Formatting in VS Code Instructions
In the Visual Studio Code section, the bullet point at line 66 is indented with extra spaces. For consistency with the "Through CLI" section (after adjustment) and other parts of the document, consider removing the unnecessary indentation.- * Once the run is complete, load `http://localhost:{PORT}/swagger-ui.html#!/`, where PORT is defined in the [AMRIT documentation](https://github.com/PSMRI/AMRIT/blob/main/README.md). +* Once the run is complete, load `http://localhost:{PORT}/swagger-ui.html#!/`, where PORT is defined in the [AMRIT documentation](https://github.com/PSMRI/AMRIT/blob/main/README.md).✅ Verification successful
Standardize Bullet List Formatting in VS Code Instructions
I've reviewed the documentation file and confirmed that the Visual Studio Code section’s bullet at line 66 is indented with extra spaces compared to the "Through CLI" section. Removing the extra indentation—as suggested—will standardize the formatting across the document.🏁 Scripts executed
The following scripts were executed for the analysis:
Error: No shell scripts found
📋Changes made:
✅ Type of Change
Summary by CodeRabbit
http://localhost:{PORT}based on user-defined configurations.