Update INSTALLATION.md #2734
Update INSTALLATION.md #2734
Conversation
WalkthroughThe changes in this pull request focus on enhancing the Changes
Assessment against linked issues
Possibly related issues
Possibly related PRs
Suggested labels
Suggested reviewers
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
Documentation and Community
|
Our Pull Request Approval ProcessThanks for contributing! Testing Your CodeRemember, your PRs won't be reviewed until these criteria are met:
Our policies make our code better. ReviewersDo not assign reviewers. Our Queue Monitors will review your PR and assign them.
Reviewing Your CodeYour reviewer(s) will have the following roles:
CONTRIBUTING.mdRead our CONTRIBUTING.md file. Most importantly:
Other
|
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
There was a problem hiding this comment.
Congratulations on making your first PR! 🎊 If you haven't already, check out our Contributing Guidelines and PR Reporting Guidelines to ensure that you are following our guidelines for contributing and creating PR.
![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 (2)
INSTALLATION.md (2)
Line range hint
333-355: LGTM! The Docker setup instructions address the PWD variable issue.The added note about
PWD=.requirement and port conflict resolution steps directly address the issues reported in #2598. This will help users avoid common setup problems.Consider adding a brief explanation of why the
PWD=.setting is required, to help users understand its importance. For example:-`Note`: Make sure `PWD=.` is there in `.env` file. +`Note`: Make sure `PWD=.` is set in your `.env` file. This environment variable is required for proper container path mapping in Docker Compose.🧰 Tools
🪛 LanguageTool
[style] ~352-~352: Consider shortening or rephrasing this to strengthen your wording.
Context: ... development environment, where you can make changes to the code, and the server will automatic...(MAKE_CHANGES)
[uncategorized] ~355-~355: The abbreviation “e.g.” (= for example) requires two periods.
Context: ...e ports mentioned in the error are free(eg. Ports- 80, 0, 4000). Refer `sudo lsof ...(E_G)
[uncategorized] ~355-~355: Possible missing comma found.
Context: ...T}. To kill the process running on the port usekill {PID}`. 2. Accessing the Deve...(AI_HYDRA_LEO_MISSING_COMMA)
🪛 Markdownlint (0.35.0)
358-358: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
201-201: Fix minor grammatical and formatting issues.There are a few minor issues to address:
- Line 201: Add a hyphen in "open-source contribution"
- Line 355: Use "e.g." instead of "eg."
- Line 355: Add a comma before "use"
Apply these changes:
-Basic `git` knowledge is required for open source contribution +Basic `git` knowledge is required for open-source contribution -(eg. Ports- 80, 0, 4000) +(e.g., Ports- 80, 0, 4000) -To kill the process running on the port use +To kill the process running on the port, useAlso applies to: 355-355
🧰 Tools
🪛 LanguageTool
[uncategorized] ~201-~201: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: .... Basicgitknowledge is required for open source contribution so make sure you're comfor...(EN_COMPOUND_ADJECTIVE_INTERNAL)
[uncategorized] ~201-~201: Possible missing comma found.
Context: ...` knowledge is required for open source contribution so make sure you're comfortable with it...(AI_HYDRA_LEO_MISSING_COMMA)
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
📒 Files selected for processing (1)
INSTALLATION.md(3 hunks)
🧰 Additional context used
🪛 LanguageTool
INSTALLATION.md
[uncategorized] ~201-~201: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: .... Basic git knowledge is required for open source contribution so make sure you're comfor...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[uncategorized] ~201-~201: Possible missing comma found.
Context: ...` knowledge is required for open source contribution so make sure you're comfortable with it...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~333-~333: Loose punctuation mark.
Context: ...oftware development environment. Note: Make sure PWD=. is there in .env fi...
(UNLIKELY_OPENING_PUNCTUATION)
[style] ~352-~352: Consider shortening or rephrasing this to strengthen your wording.
Context: ... development environment, where you can make changes to the code, and the server will automatic...
(MAKE_CHANGES)
[uncategorized] ~355-~355: The abbreviation “e.g.” (= for example) requires two periods.
Context: ...e ports mentioned in the error are free (eg. Ports- 80, 0, 4000). Refer `sudo lsof ...
(E_G)
[uncategorized] ~355-~355: Possible missing comma found.
Context: ...T}. To kill the process running on the port use kill {PID}`. 2. Accessing the Deve...
(AI_HYDRA_LEO_MISSING_COMMA)
|
@Shriya-Chauhan Thanks for the PR, however:
|
What kind of change does this PR introduce?
Changes in installation.md.
Issue Number:
Fixes #2598
If relevant, did you update the documentation?
Yes ,documentation for installation on linux systems has been updated.
Summary
Contributors were running through multiple errors while building the project using docker. This pull request
suggests changes in the documentation to install and take care of the errors faced by multiple contributers.
Link to the issue
Other information
Have you read the contributing guide?
Yes.
Summary by CodeRabbit
.envfile.