Updating installation.md #2865
Updating installation.md #2865
Conversation
WalkthroughThe pull request updates the Changes
Assessment against linked issues
Possibly related PRs
Suggested reviewers
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: 5
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro
⛔ Files ignored due to path filters (2)
public/markdown/images/install1.pngis excluded by!**/*.pngpublic/markdown/images/install2.pngis excluded by!**/*.png
📒 Files selected for processing (1)
INSTALLATION.md(2 hunks)
🧰 Additional context used
🪛 LanguageTool
INSTALLATION.md
[typographical] ~33-~33: Usually, there’s no comma before “if”.
Context: ...uction server after closing the terminal, if docker containers are running.](#comman...
(IF_NO_COMMA)
[uncategorized] ~54-~54: This expression is usually spelled with a hyphen.
Context: ...ironment setup ## Our recommendations Linux based distributions are simply the best platf...
(BASED_HYPHEN)
[style] ~57-~57: Consider replacing ‘only’ with a different word to let your writing stand out.
Context: ... linux, on non-linux platforms they can only be used by emulating linux where they a...
(ONLY_EXCLUSIVELY_STYLE)
[grammar] ~57-~57: Consider using either the past participle “run” or the present participle “running” here.
Context: ... used by emulating linux where they are ran inside linux based virtual machines. So...
(BEEN_PART_AGREEMENT)
[grammar] ~59-~59: “Windows” (operating system by Microsoft) is a proper noun and needs to be capitalized.
Context: ...enalties and limitations don't apply to windows subsystem for linux. So, if you plan on...
(A_WINDOWS)
[style] ~59-~59: Try using a more formal synonym here to elevate your writing.
Context: ...windows subsystem for linux. So, if you plan on using windows, at the very least make use of ...
(PLAN_ON_INTEND)
[grammar] ~59-~59: “Windows” (operating system by Microsoft) is a proper noun and needs to be capitalized.
Context: ... windows, at the very least make use of windows subsystem for linux. ## Prerequisites ...
(A_WINDOWS)
[typographical] ~74-~74: It appears that a comma is missing.
Context: ...iners 7. Typescript 8. Node.js In this section we'll explain how to set up all the pre...
(DURING_THAT_TIME_COMMA)
[uncategorized] ~80-~80: 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] ~89-~89: This expression is usually spelled with a hyphen.
Context: ... Settings. - Check Use the WSL 2 based engine. - Verify your distribution...
(BASED_HYPHEN)
[uncategorized] ~100-~100: Use a comma before ‘so’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...r $USER` - Sign out and back in again so your changes take effect. ### Install ...
(COMMA_COMPOUND_SENTENCE_2)
[style] ~114-~114: As an alternative to the over-used intensifier ‘very’, consider replacing this phrase.
Context: ...ote.remote-containers ``` 3. It is very important that you go through [this](https://code...
(EN_WEAK_ADJECTIVE)
[grammar] ~120-~120: The operating system from Apple is written “macOS”.
Context: ...node.jspackages in Windows, Linux and MacOS. 1. For Windows: 1. first install...
(MAC_OS)
[duplication] ~134-~134: Possible typo: you repeated a word.
Context: ... 5. Save the document. 6. Exit notepad 7. Exit PowerShell 8. This will ensure...
(ENGLISH_WORD_REPEAT_RULE)
[grammar] ~137-~137: The operating system from Apple is written “macOS”.
Context: ...t version of node.js 2. For Linux and MacOS, use the terminal window. 1. install...
(MAC_OS)
[grammar] ~141-~141: The word “setup” is a noun. The verb is spelled with a white space.
Context: ... the respective recommended commands to setup your node environment 3. This wil...
(NOUN_VERB_CONFUSION)
[grammar] ~191-~191: The word “setup” is a noun. The verb is spelled with a space.
Context: ...avigate to the folder where you want to setup the repository. 2. Open a cmd (Window...
(NOUN_VERB_CONFUSION)
[grammar] ~192-~192: The operating system from Apple is written “macOS”.
Context: ...cmd (Windows) or terminal (Linux or MacOS) session in this folder. 1. An easy ...
(MAC_OS)
[uncategorized] ~194-~194: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...e option based on your OS. 3. For Our Open Source Contributor Software Developers: ...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[style] ~220-~220: Consider using the more formal “until”.
Context: ...take a few minutes to complete. 4. Wait till the process is complete and you see por...
(TILL)
[uncategorized] ~220-~220: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...te. 4. Wait till the process is complete and you see ports being forwarded in the te...
(COMMA_COMPOUND_SENTENCE)
[duplication] ~255-~255: Possible typo: you repeated a word.
Context: ...ent of talawa api: 1. Git 2. Github 3. Docker 4. Docker compose In this section we'll explain ...
(ENGLISH_WORD_REPEAT_RULE)
[typographical] ~258-~258: It appears that a comma is missing.
Context: ...ub 3. Docker 4. Docker compose In this section we'll explain how to set up all the pre...
(DURING_THAT_TIME_COMMA)
[uncategorized] ~264-~264: 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] ~273-~273: This expression is usually spelled with a hyphen.
Context: ... Settings. - Check Use the WSL 2 based engine. - Verify your distribution...
(BASED_HYPHEN)
[uncategorized] ~284-~284: Use a comma before ‘so’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...r $USER` - Sign out and back in again so your changes take effect. ## Setup usi...
(COMMA_COMPOUND_SENTENCE_2)
[grammar] ~314-~314: The operating system from Apple is written “macOS”.
Context: ...s) or terminal (terminal for Linux or MacOS) session in this folder. - You can u...
(MAC_OS)
[typographical] ~367-~367: Usually, there’s no comma before “if”.
Context: ...uction server after closing the terminal, if docker containers are running. - for n...
(IF_NO_COMMA)
[uncategorized] ~391-~391: Did you mean: “By default,”?
Context: ...Ls for coding and troubleshooting : 1. By default talawa-api runs on port 4000 on your ...
(BY_DEFAULT_COMMA)
🪛 Markdownlint (0.37.0)
INSTALLATION.md
47-47: null
Multiple top-level headings in the same document
(MD025, single-title, single-h1)
51-51: null
Multiple top-level headings in the same document
(MD025, single-title, single-h1)
247-247: null
Multiple top-level headings in the same document
(MD025, single-title, single-h1)
383-383: null
Multiple top-level headings in the same document
(MD025, single-title, single-h1)
448-448: null
Multiple top-level headings in the same document
(MD025, single-title, single-h1)
495-495: null
Multiple top-level headings in the same document
(MD025, single-title, single-h1)
507-507: null
Multiple top-level headings in the same document
(MD025, single-title, single-h1)
519-519: null
Multiple top-level headings in the same document
(MD025, single-title, single-h1)
84-84: Punctuation: ':'
Trailing punctuation in heading
(MD026, no-trailing-punctuation)
92-92: Punctuation: ':'
Trailing punctuation in heading
(MD026, no-trailing-punctuation)
231-231: Punctuation: '.'
Trailing punctuation in heading
(MD026, no-trailing-punctuation)
268-268: Punctuation: ':'
Trailing punctuation in heading
(MD026, no-trailing-punctuation)
276-276: Punctuation: ':'
Trailing punctuation in heading
(MD026, no-trailing-punctuation)
367-367: Punctuation: '.'
Trailing punctuation in heading
(MD026, no-trailing-punctuation)
111-111: null
Fenced code blocks should be surrounded by blank lines
(MD031, blanks-around-fences)
113-113: null
Fenced code blocks should be surrounded by blank lines
(MD031, blanks-around-fences)
206-206: null
Fenced code blocks should be surrounded by blank lines
(MD031, blanks-around-fences)
210-210: null
Fenced code blocks should be surrounded by blank lines
(MD031, blanks-around-fences)
317-317: null
Fenced code blocks should be surrounded by blank lines
(MD031, blanks-around-fences)
321-321: null
Fenced code blocks should be surrounded by blank lines
(MD031, blanks-around-fences)
333-333: null
Fenced code blocks should be surrounded by blank lines
(MD031, blanks-around-fences)
358-358: null
Fenced code blocks should be surrounded by blank lines
(MD031, blanks-around-fences)
360-360: null
Fenced code blocks should be surrounded by blank lines
(MD031, blanks-around-fences)
404-404: null
Fenced code blocks should be surrounded by blank lines
(MD031, blanks-around-fences)
451-451: null
Fenced code blocks should be surrounded by blank lines
(MD031, blanks-around-fences)
453-453: null
Fenced code blocks should be surrounded by blank lines
(MD031, blanks-around-fences)
498-498: null
Fenced code blocks should be surrounded by blank lines
(MD031, blanks-around-fences)
500-500: null
Fenced code blocks should be surrounded by blank lines
(MD031, blanks-around-fences)
510-510: null
Fenced code blocks should be surrounded by blank lines
(MD031, blanks-around-fences)
512-512: null
Fenced code blocks should be surrounded by blank lines
(MD031, blanks-around-fences)
605-605: null
Lists should be surrounded by blank lines
(MD032, blanks-around-lists)
123-123: null
Bare URL used
(MD034, no-bare-urls)
525-525: null
Bare URL used
(MD034, no-bare-urls)
569-569: null
Bare URL used
(MD034, no-bare-urls)
393-393: null
Fenced code blocks should have a language specified
(MD040, fenced-code-language)
399-399: null
Fenced code blocks should have a language specified
(MD040, fenced-code-language)
416-416: null
Fenced code blocks should have a language specified
(MD040, fenced-code-language)
430-430: null
Fenced code blocks should have a language specified
(MD040, fenced-code-language)
436-436: null
Fenced code blocks should have a language specified
(MD040, fenced-code-language)
444-444: null
Fenced code blocks should have a language specified
(MD040, fenced-code-language)
166-166: Expected: fenced; Actual: indented
Code block style
(MD046, code-block-style)
296-296: Expected: fenced; Actual: indented
Code block style
(MD046, code-block-style)
343-343: Expected: fenced; Actual: indented
Code block style
(MD046, code-block-style)
⏰ Context from checks skipped due to timeout of 90000ms (2)
- GitHub Check: Test Deployment to https://docs-api.talawa.io
- GitHub Check: Analyse Code With CodeQL (typescript)
|
@coderabbitai full review |
✅ Actions performedFull review triggered. |
There was a problem hiding this comment.
Actionable comments posted: 1
🔭 Outside diff range comments (1)
INSTALLATION.md (1)
Line range hint
1-605: Address pipeline failure for sensitive file changes.The pipeline indicates that this file is considered sensitive and requires special handling. Changes to this file require the 'ignore-sensitive-files-pr' label to proceed.
Please:
- Add the 'ignore-sensitive-files-pr' label to this PR
- Review the changes thoroughly for any security implications
- Ensure all sensitive information is replaced with placeholders
🧰 Tools
🪛 LanguageTool
[typographical] ~74-~74: It appears that a comma is missing.
Context: ...iners 7. Typescript 8. Node.js In this section we'll explain how to set up all the pre...(DURING_THAT_TIME_COMMA)
[uncategorized] ~80-~80: 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] ~89-~89: This expression is usually spelled with a hyphen.
Context: ... Settings. - Check Use the WSL 2 based engine. - Verify your distribution...(BASED_HYPHEN)
[uncategorized] ~100-~100: Use a comma before ‘so’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...r $USER` - Sign out and back in again so your changes take effect. ### Install ...(COMMA_COMPOUND_SENTENCE_2)
[style] ~114-~114: As an alternative to the over-used intensifier ‘very’, consider replacing this phrase.
Context: ...ote.remote-containers ``` 3. It is very important that you go through [this](https://code...(EN_WEAK_ADJECTIVE)
[grammar] ~120-~120: The operating system from Apple is written “macOS”.
Context: ...node.jspackages in Windows, Linux and MacOS. 1. For Windows: 1. first install...(MAC_OS)
[duplication] ~134-~134: Possible typo: you repeated a word.
Context: ... 5. Save the document. 6. Exitnotepad7. Exit PowerShell 8. This will ensure...(ENGLISH_WORD_REPEAT_RULE)
[grammar] ~137-~137: The operating system from Apple is written “macOS”.
Context: ...t version ofnode.js2. For Linux and MacOS, use the terminal window. 1. install...(MAC_OS)
[grammar] ~141-~141: The word “setup” is a noun. The verb is spelled with a white space.
Context: ... the respective recommended commands to setup your node environment 3. This wil...(NOUN_VERB_CONFUSION)
[grammar] ~191-~191: The word “setup” is a noun. The verb is spelled with a space.
Context: ...avigate to the folder where you want to setup the repository. 2. Open acmd(Window...(NOUN_VERB_CONFUSION)
[grammar] ~192-~192: The operating system from Apple is written “macOS”.
Context: ...cmd(Windows) orterminal(Linux or MacOS) session in this folder. 1. An easy ...(MAC_OS)
[uncategorized] ~194-~194: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...e option based on your OS. 3. For Our Open Source Contributor Software Developers: ...(EN_COMPOUND_ADJECTIVE_INTERNAL)
[style] ~220-~220: Consider using the more formal “until”.
Context: ...take a few minutes to complete. 4. Wait till the process is complete and you see por...(TILL)
[uncategorized] ~220-~220: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...te. 4. Wait till the process is complete and you see ports being forwarded in the te...(COMMA_COMPOUND_SENTENCE)
[duplication] ~255-~255: Possible typo: you repeated a word.
Context: ...ent of talawa api: 1. Git 2. Github 3. Docker 4. Docker compose In this section we'll explain ...(ENGLISH_WORD_REPEAT_RULE)
[typographical] ~258-~258: It appears that a comma is missing.
Context: ...ub 3. Docker 4. Docker compose In this section we'll explain how to set up all the pre...(DURING_THAT_TIME_COMMA)
[uncategorized] ~264-~264: 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] ~273-~273: This expression is usually spelled with a hyphen.
Context: ... Settings. - Check Use the WSL 2 based engine. - Verify your distribution...(BASED_HYPHEN)
[uncategorized] ~284-~284: Use a comma before ‘so’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...r $USER` - Sign out and back in again so your changes take effect. ## Setup usi...(COMMA_COMPOUND_SENTENCE_2)
[grammar] ~314-~314: The operating system from Apple is written “macOS”.
Context: ...s) or terminal (terminalfor Linux or MacOS) session in this folder. - You can u...(MAC_OS)
[typographical] ~367-~367: Usually, there’s no comma before “if”.
Context: ...uction server after closing the terminal, if docker containers are running. - for n...(IF_NO_COMMA)
[uncategorized] ~391-~391: Did you mean: “By default,”?
Context: ...Ls for coding and troubleshooting : 1. By default talawa-api runs onport 4000on your ...(BY_DEFAULT_COMMA)
🪛 Markdownlint (0.37.0)
247-247: null
Multiple top-level headings in the same document(MD025, single-title, single-h1)
383-383: null
Multiple top-level headings in the same document(MD025, single-title, single-h1)
448-448: null
Multiple top-level headings in the same document(MD025, single-title, single-h1)
495-495: null
Multiple top-level headings in the same document(MD025, single-title, single-h1)
507-507: null
Multiple top-level headings in the same document(MD025, single-title, single-h1)
519-519: null
Multiple top-level headings in the same document(MD025, single-title, single-h1)
84-84: Punctuation: ':'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
92-92: Punctuation: ':'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
231-231: Punctuation: '.'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
268-268: Punctuation: ':'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
276-276: Punctuation: ':'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
367-367: Punctuation: '.'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
111-111: null
Fenced code blocks should be surrounded by blank lines(MD031, blanks-around-fences)
113-113: null
Fenced code blocks should be surrounded by blank lines(MD031, blanks-around-fences)
206-206: null
Fenced code blocks should be surrounded by blank lines(MD031, blanks-around-fences)
210-210: null
Fenced code blocks should be surrounded by blank lines(MD031, blanks-around-fences)
317-317: null
Fenced code blocks should be surrounded by blank lines(MD031, blanks-around-fences)
321-321: null
Fenced code blocks should be surrounded by blank lines(MD031, blanks-around-fences)
333-333: null
Fenced code blocks should be surrounded by blank lines(MD031, blanks-around-fences)
358-358: null
Fenced code blocks should be surrounded by blank lines(MD031, blanks-around-fences)
360-360: null
Fenced code blocks should be surrounded by blank lines(MD031, blanks-around-fences)
404-404: null
Fenced code blocks should be surrounded by blank lines(MD031, blanks-around-fences)
451-451: null
Fenced code blocks should be surrounded by blank lines(MD031, blanks-around-fences)
453-453: null
Fenced code blocks should be surrounded by blank lines(MD031, blanks-around-fences)
498-498: null
Fenced code blocks should be surrounded by blank lines(MD031, blanks-around-fences)
500-500: null
Fenced code blocks should be surrounded by blank lines(MD031, blanks-around-fences)
510-510: null
Fenced code blocks should be surrounded by blank lines(MD031, blanks-around-fences)
512-512: null
Fenced code blocks should be surrounded by blank lines(MD031, blanks-around-fences)
605-605: null
Lists should be surrounded by blank lines(MD032, blanks-around-lists)
123-123: null
Bare URL used(MD034, no-bare-urls)
525-525: null
Bare URL used(MD034, no-bare-urls)
569-569: null
Bare URL used(MD034, no-bare-urls)
393-393: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
399-399: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
416-416: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
430-430: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
436-436: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
444-444: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
166-166: Expected: fenced; Actual: indented
Code block style(MD046, code-block-style)
296-296: Expected: fenced; Actual: indented
Code block style(MD046, code-block-style)
343-343: Expected: fenced; Actual: indented
Code block style(MD046, code-block-style)
🪛 GitHub Actions: Pull request workflow
[error] Unauthorized changes detected in sensitive file. Changes to this file require the 'ignore-sensitive-files-pr' label to proceed.
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro
⛔ Files ignored due to path filters (2)
public/markdown/images/install1.pngis excluded by!**/*.pngpublic/markdown/images/install2.pngis excluded by!**/*.png
📒 Files selected for processing (1)
INSTALLATION.md(2 hunks)
🧰 Additional context used
🪛 LanguageTool
INSTALLATION.md
[typographical] ~33-~33: Usually, there’s no comma before “if”.
Context: ...uction server after closing the terminal, if docker containers are running.](#comman...
(IF_NO_COMMA)
[uncategorized] ~54-~54: This expression is usually spelled with a hyphen.
Context: ...ironment setup ## Our recommendations Linux based distributions are simply the best platf...
(BASED_HYPHEN)
[style] ~57-~57: Consider replacing ‘only’ with a different word to let your writing stand out.
Context: ... linux, on non-linux platforms they can only be used by emulating linux where they a...
(ONLY_EXCLUSIVELY_STYLE)
[grammar] ~57-~57: Consider using either the past participle “run” or the present participle “running” here.
Context: ... used by emulating linux where they are ran inside linux based virtual machines. So...
(BEEN_PART_AGREEMENT)
[grammar] ~59-~59: “Windows” (operating system by Microsoft) is a proper noun and needs to be capitalized.
Context: ...enalties and limitations don't apply to windows subsystem for linux. So, if you plan on...
(A_WINDOWS)
[style] ~59-~59: Try using a more formal synonym here to elevate your writing.
Context: ...windows subsystem for linux. So, if you plan on using windows, at the very least make use of ...
(PLAN_ON_INTEND)
[grammar] ~59-~59: “Windows” (operating system by Microsoft) is a proper noun and needs to be capitalized.
Context: ... windows, at the very least make use of windows subsystem for linux. ## Prerequisites ...
(A_WINDOWS)
[typographical] ~74-~74: It appears that a comma is missing.
Context: ...iners 7. Typescript 8. Node.js In this section we'll explain how to set up all the pre...
(DURING_THAT_TIME_COMMA)
[uncategorized] ~80-~80: 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] ~89-~89: This expression is usually spelled with a hyphen.
Context: ... Settings. - Check Use the WSL 2 based engine. - Verify your distribution...
(BASED_HYPHEN)
[uncategorized] ~100-~100: Use a comma before ‘so’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...r $USER` - Sign out and back in again so your changes take effect. ### Install ...
(COMMA_COMPOUND_SENTENCE_2)
[style] ~114-~114: As an alternative to the over-used intensifier ‘very’, consider replacing this phrase.
Context: ...ote.remote-containers ``` 3. It is very important that you go through [this](https://code...
(EN_WEAK_ADJECTIVE)
[grammar] ~120-~120: The operating system from Apple is written “macOS”.
Context: ...node.jspackages in Windows, Linux and MacOS. 1. For Windows: 1. first install...
(MAC_OS)
[duplication] ~134-~134: Possible typo: you repeated a word.
Context: ... 5. Save the document. 6. Exit notepad 7. Exit PowerShell 8. This will ensure...
(ENGLISH_WORD_REPEAT_RULE)
[grammar] ~137-~137: The operating system from Apple is written “macOS”.
Context: ...t version of node.js 2. For Linux and MacOS, use the terminal window. 1. install...
(MAC_OS)
[grammar] ~141-~141: The word “setup” is a noun. The verb is spelled with a white space.
Context: ... the respective recommended commands to setup your node environment 3. This wil...
(NOUN_VERB_CONFUSION)
[grammar] ~191-~191: The word “setup” is a noun. The verb is spelled with a space.
Context: ...avigate to the folder where you want to setup the repository. 2. Open a cmd (Window...
(NOUN_VERB_CONFUSION)
[grammar] ~192-~192: The operating system from Apple is written “macOS”.
Context: ...cmd (Windows) or terminal (Linux or MacOS) session in this folder. 1. An easy ...
(MAC_OS)
[uncategorized] ~194-~194: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...e option based on your OS. 3. For Our Open Source Contributor Software Developers: ...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[style] ~220-~220: Consider using the more formal “until”.
Context: ...take a few minutes to complete. 4. Wait till the process is complete and you see por...
(TILL)
[uncategorized] ~220-~220: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...te. 4. Wait till the process is complete and you see ports being forwarded in the te...
(COMMA_COMPOUND_SENTENCE)
[duplication] ~255-~255: Possible typo: you repeated a word.
Context: ...ent of talawa api: 1. Git 2. Github 3. Docker 4. Docker compose In this section we'll explain ...
(ENGLISH_WORD_REPEAT_RULE)
[typographical] ~258-~258: It appears that a comma is missing.
Context: ...ub 3. Docker 4. Docker compose In this section we'll explain how to set up all the pre...
(DURING_THAT_TIME_COMMA)
[uncategorized] ~264-~264: 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] ~273-~273: This expression is usually spelled with a hyphen.
Context: ... Settings. - Check Use the WSL 2 based engine. - Verify your distribution...
(BASED_HYPHEN)
[uncategorized] ~284-~284: Use a comma before ‘so’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...r $USER` - Sign out and back in again so your changes take effect. ## Setup usi...
(COMMA_COMPOUND_SENTENCE_2)
[grammar] ~314-~314: The operating system from Apple is written “macOS”.
Context: ...s) or terminal (terminal for Linux or MacOS) session in this folder. - You can u...
(MAC_OS)
[typographical] ~367-~367: Usually, there’s no comma before “if”.
Context: ...uction server after closing the terminal, if docker containers are running. - for n...
(IF_NO_COMMA)
[uncategorized] ~391-~391: Did you mean: “By default,”?
Context: ...Ls for coding and troubleshooting : 1. By default talawa-api runs on port 4000 on your ...
(BY_DEFAULT_COMMA)
🪛 Markdownlint (0.37.0)
INSTALLATION.md
47-47: null
Multiple top-level headings in the same document
(MD025, single-title, single-h1)
51-51: null
Multiple top-level headings in the same document
(MD025, single-title, single-h1)
247-247: null
Multiple top-level headings in the same document
(MD025, single-title, single-h1)
383-383: null
Multiple top-level headings in the same document
(MD025, single-title, single-h1)
448-448: null
Multiple top-level headings in the same document
(MD025, single-title, single-h1)
495-495: null
Multiple top-level headings in the same document
(MD025, single-title, single-h1)
507-507: null
Multiple top-level headings in the same document
(MD025, single-title, single-h1)
519-519: null
Multiple top-level headings in the same document
(MD025, single-title, single-h1)
84-84: Punctuation: ':'
Trailing punctuation in heading
(MD026, no-trailing-punctuation)
92-92: Punctuation: ':'
Trailing punctuation in heading
(MD026, no-trailing-punctuation)
231-231: Punctuation: '.'
Trailing punctuation in heading
(MD026, no-trailing-punctuation)
268-268: Punctuation: ':'
Trailing punctuation in heading
(MD026, no-trailing-punctuation)
276-276: Punctuation: ':'
Trailing punctuation in heading
(MD026, no-trailing-punctuation)
367-367: Punctuation: '.'
Trailing punctuation in heading
(MD026, no-trailing-punctuation)
111-111: null
Fenced code blocks should be surrounded by blank lines
(MD031, blanks-around-fences)
113-113: null
Fenced code blocks should be surrounded by blank lines
(MD031, blanks-around-fences)
206-206: null
Fenced code blocks should be surrounded by blank lines
(MD031, blanks-around-fences)
210-210: null
Fenced code blocks should be surrounded by blank lines
(MD031, blanks-around-fences)
317-317: null
Fenced code blocks should be surrounded by blank lines
(MD031, blanks-around-fences)
321-321: null
Fenced code blocks should be surrounded by blank lines
(MD031, blanks-around-fences)
333-333: null
Fenced code blocks should be surrounded by blank lines
(MD031, blanks-around-fences)
358-358: null
Fenced code blocks should be surrounded by blank lines
(MD031, blanks-around-fences)
360-360: null
Fenced code blocks should be surrounded by blank lines
(MD031, blanks-around-fences)
404-404: null
Fenced code blocks should be surrounded by blank lines
(MD031, blanks-around-fences)
451-451: null
Fenced code blocks should be surrounded by blank lines
(MD031, blanks-around-fences)
453-453: null
Fenced code blocks should be surrounded by blank lines
(MD031, blanks-around-fences)
498-498: null
Fenced code blocks should be surrounded by blank lines
(MD031, blanks-around-fences)
500-500: null
Fenced code blocks should be surrounded by blank lines
(MD031, blanks-around-fences)
510-510: null
Fenced code blocks should be surrounded by blank lines
(MD031, blanks-around-fences)
512-512: null
Fenced code blocks should be surrounded by blank lines
(MD031, blanks-around-fences)
605-605: null
Lists should be surrounded by blank lines
(MD032, blanks-around-lists)
123-123: null
Bare URL used
(MD034, no-bare-urls)
525-525: null
Bare URL used
(MD034, no-bare-urls)
569-569: null
Bare URL used
(MD034, no-bare-urls)
393-393: null
Fenced code blocks should have a language specified
(MD040, fenced-code-language)
399-399: null
Fenced code blocks should have a language specified
(MD040, fenced-code-language)
416-416: null
Fenced code blocks should have a language specified
(MD040, fenced-code-language)
430-430: null
Fenced code blocks should have a language specified
(MD040, fenced-code-language)
436-436: null
Fenced code blocks should have a language specified
(MD040, fenced-code-language)
444-444: null
Fenced code blocks should have a language specified
(MD040, fenced-code-language)
166-166: Expected: fenced; Actual: indented
Code block style
(MD046, code-block-style)
296-296: Expected: fenced; Actual: indented
Code block style
(MD046, code-block-style)
343-343: Expected: fenced; Actual: indented
Code block style
(MD046, code-block-style)
🪛 GitHub Actions: Pull request workflow
INSTALLATION.md
[error] Unauthorized changes detected in sensitive file. Changes to this file require the 'ignore-sensitive-files-pr' label to proceed.
🔇 Additional comments (4)
INSTALLATION.md (4)
343-346:⚠️ Potential issueUse secure placeholder values for sensitive configuration.
The example values for environment variables should use clear placeholder text to prevent accidental use in production.
Apply this diff to use secure placeholders:
- 1. **CADDY_TALAWA_API_DOMAIN_NAME** (e.g., `localhost`) - 2. **CADDY_TALAWA_API_EMAIL** (e.g., `[email protected]`) - 3. **API_POSTGRES_PASSWORD** (e.g., `password`) - 4. **API_BASE_URL** (e.g., `https://localhost`) + 1. **CADDY_TALAWA_API_DOMAIN_NAME** (e.g., `<your-domain>`) + 2. **CADDY_TALAWA_API_EMAIL** (e.g., `<your-admin-email>`) + 3. **API_POSTGRES_PASSWORD** (e.g., `<strong-unique-password>`) + 4. **API_BASE_URL** (e.g., `<your-api-url>`)Likely invalid or redundant comment.
🧰 Tools
🪛 Markdownlint (0.37.0)
343-343: Expected: fenced; Actual: indented
Code block style(MD046, code-block-style)
🪛 GitHub Actions: Pull request workflow
[error] Unauthorized changes detected in sensitive file. Changes to this file require the 'ignore-sensitive-files-pr' label to proceed.
351-353:⚠️ Potential issueEnhance security of JWT secret generation.
The current command using
base64encoding might not provide sufficient entropy for a secure JWT secret.Apply this diff to use a more secure method:
-openssl rand -base64 64 +openssl rand -hex 32Likely invalid or redundant comment.
🧰 Tools
🪛 GitHub Actions: Pull request workflow
[error] Unauthorized changes detected in sensitive file. Changes to this file require the 'ignore-sensitive-files-pr' label to proceed.
533-541:⚠️ Potential issueRemove sensitive information from API examples.
The API examples should not expose default credentials.
Apply this diff to use placeholders:
- "emailAddress": "[email protected]", - "password": "password" + "emailAddress": "<your-email>", + "password": "<your-password>"Likely invalid or redundant comment.
🧰 Tools
🪛 GitHub Actions: Pull request workflow
[error] Unauthorized changes detected in sensitive file. Changes to this file require the 'ignore-sensitive-files-pr' label to proceed.
1-46: 🧹 Nitpick (assertive)Improve document structure and formatting.
The document structure needs the following improvements:
- Use a single top-level heading (
#) for the document title- Use subheadings (
##,###, etc.) for all other sections- Add language specifications to code blocks
- Ensure consistent spacing around code blocks
Apply this diff to fix the document structure:
-# Table of Contents +# Talawa-API Installation Guide + +## Table of ContentsLikely invalid or redundant comment.
🧰 Tools
🪛 LanguageTool
[typographical] ~33-~33: Usually, there’s no comma before “if”.
Context: ...uction server after closing the terminal, if docker containers are running.](#comman...(IF_NO_COMMA)
🪛 GitHub Actions: Pull request workflow
[error] Unauthorized changes detected in sensitive file. Changes to this file require the 'ignore-sensitive-files-pr' label to proceed.
palisadoes
added
the
ignore-sensitive-files-pr
|
@MohitMaulekhi you just copy pasted the documentation from |
|
Closing. This is a cut and paste of the document in the |
What kind of change does this PR introduce?
This PR updates the
installation.mdfile to assist new open-source contributors in setting up the Talawa-API environment.Issue Number:
Fixes #2857
Summary
This PR includes detailed instructions for setting up the Talawa-API environment, including prerequisite installations, cloning the repository, setting up environment variables, and starting the server. The goal is to make it easier for new contributors to get started.
Does this PR introduce a breaking change?
no
Checklist
Updated installation.md with detailed setup instructions
Verified that the setup instructions are clear and easy to follow
Have you read the contributing guide?
yes
Summary by CodeRabbit