Improve readability of INSTALLATION.md file #3311
Conversation
- improve readability of INSTALLATION.md file Signed-off-by: Bhudeo Krit <[email protected]>
WalkthroughThe pull request enhances the Changes
Possibly related PRs
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 comments (1)
INSTALLATION.md (1)
Line range hint
1-376: Add required label for protected file modificationThis file is protected and requires the 'ignore-sensitive-files-pr' label to be modified. Please add this label to the PR.
🧰 Tools
🪛 LanguageTool
[duplication] ~28-~28: Possible typo: you repeated a word.
Context: ...](#running-talawa-admin) - Accessing Talawa-Admin - [Talawa-Admin Registration](#talawa-admin-registratio...(ENGLISH_WORD_REPEAT_RULE)
🪛 Markdownlint (0.37.0)
36-36: Expected: 4; Actual: 6
Unordered list indentation(MD007, ul-indent)
37-37: Expected: 4; Actual: 6
Unordered list indentation(MD007, ul-indent)
🪛 GitHub Actions: PR Workflow
[error] Unauthorized file modification. This file is protected and requires the 'ignore-sensitive-files-pr' label to modify or delete.
🧹 Nitpick comments (5)
INSTALLATION.md (5)
35-37: Fix indentation in Table of ContentsThe Git hooks subsections are incorrectly indented with 6 spaces instead of 4 spaces.
- [Husky for Git Hooks](#husky-for-git-hooks) - - [pre-commit hook](#pre-commit-hook) - - [post-merge hook](#post-merge-hook) + [Husky for Git Hooks](#husky-for-git-hooks) + - [pre-commit hook](#pre-commit-hook) + - [post-merge hook](#post-merge-hook)🧰 Tools
🪛 Markdownlint (0.37.0)
36-36: Expected: 4; Actual: 6
Unordered list indentation(MD007, ul-indent)
37-37: Expected: 4; Actual: 6
Unordered list indentation(MD007, ul-indent)
🪛 GitHub Actions: PR Workflow
[error] Unauthorized file modification. This file is protected and requires the 'ignore-sensitive-files-pr' label to modify or delete.
170-179: Use environment variable for Docker port mappingThe Docker run command hardcodes port 4321, but it should use the PORT from .env file for consistency with the rest of the documentation.
- docker run -p 4321:4321 talawa-admin + docker run -p ${PORT}:${PORT} talawa-admin🧰 Tools
🪛 GitHub Actions: PR Workflow
[error] Unauthorized file modification. This file is protected and requires the 'ignore-sensitive-files-pr' label to modify or delete.
199-199: Add language specification to code blockFor consistency with other code blocks, specify the language.
- ``` + ```bash cp .env.example .env🧰 Tools
🪛 Markdownlint (0.37.0)
199-199: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
🪛 GitHub Actions: PR Workflow
[error] Unauthorized file modification. This file is protected and requires the 'ignore-sensitive-files-pr' label to modify or delete.
199-199: Add missing environment variable to the tableThe environment variables table is missing
REACT_APP_USE_RECAPTCHAwhich is mentioned later in the document.Add this row to the environment variables table:
| REACT_APP_BACKEND_WEBSOCKET_URL | URL endpoint for websocket end point | +| REACT_APP_USE_RECAPTCHA | Whether you want to use reCAPTCHA or not | | REACT_APP_RECAPTCHA_SITE_KEY | Site key for authentication using reCAPTCHA |🧰 Tools
🪛 Markdownlint (0.37.0)
199-199: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
🪛 GitHub Actions: PR Workflow
[error] Unauthorized file modification. This file is protected and requires the 'ignore-sensitive-files-pr' label to modify or delete.
362-364: Add language specification to git command blocksFor consistency with other code blocks, specify the language.
- ``` + ```bash git commit -m "commit message" --no-verify- ``` + ```bash git pull --no-verifyAlso applies to: 373-374
🧰 Tools
🪛 Markdownlint (0.37.0)
362-362: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
🪛 GitHub Actions: PR Workflow
[error] Unauthorized file modification. This file is protected and requires the 'ignore-sensitive-files-pr' label to modify or delete.
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
INSTALLATION.md(4 hunks)
🧰 Additional context used
🪛 LanguageTool
INSTALLATION.md
[duplication] ~28-~28: Possible typo: you repeated a word.
Context: ...](#running-talawa-admin) - Accessing Talawa-Admin - [Talawa-Admin Registration](#talawa-admin-registratio...
(ENGLISH_WORD_REPEAT_RULE)
[uncategorized] ~197-~197: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...at runtime. It is not a part of the repo and you will have to create it. For a sampl...
(COMMA_COMPOUND_SENTENCE)
🪛 Markdownlint (0.37.0)
INSTALLATION.md
36-36: Expected: 4; Actual: 6
Unordered list indentation
(MD007, ul-indent)
37-37: Expected: 4; Actual: 6
Unordered list indentation
(MD007, ul-indent)
199-199: null
Fenced code blocks should have a language specified
(MD040, fenced-code-language)
362-362: null
Fenced code blocks should have a language specified
(MD040, fenced-code-language)
372-372: null
Fenced code blocks should have a language specified
(MD040, fenced-code-language)
🪛 GitHub Actions: PR Workflow
INSTALLATION.md
[error] Unauthorized file modification. This file is protected and requires the 'ignore-sensitive-files-pr' label to modify or delete.
⏰ Context from checks skipped due to timeout of 90000ms (1)
- GitHub Check: Analyse Code With CodeQL (javascript)
|
Closing. There is no issue assigned to this PR. |
This pull request updates the INSTALLATION.md file to improve readability and fix some errors.
before
After
The formatting Development Setup section in INSTALLATION.md file was incorrect which was affecting its readability.
Checklist
CodeRabbit AI Review
Test Coverage
Other information
Increases Readability of INSTALLATION.md
Have you read the contributing guide?
Yes
Summary by CodeRabbit