Updated installation documentation #3097
Conversation
palisadoes
added
the
ignore-sensitive-files-pr
WalkthroughThis pull request involves documentation and configuration updates across multiple files. The changes primarily focus on improving the README.md file's formatting, updating the installation documentation with more detailed setup instructions for Linux systems, and adding a new CLI-related dependency in the package.json file. The modifications aim to enhance documentation clarity and provide more comprehensive development environment setup guidance. Changes
Possibly related PRs
Suggested labels
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
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 3
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro
⛔ Files ignored due to path filters (3)
docs/pnpm-lock.yamlis excluded by!**/pnpm-lock.yamldocs/static/img/markdown/misc/talawa-logo-lite-200x200.pngis excluded by!**/*.pngpnpm-lock.yamlis excluded by!**/pnpm-lock.yaml
📒 Files selected for processing (3)
README.md(3 hunks)docs/docs/docs/getting-started/installation.md(2 hunks)package.json(1 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/docs/docs/getting-started/installation.md
[style] ~244-~244: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ... the docker group on your next login. You don't have to logout, just start anothe...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[misspelling] ~244-~244: Did you mean the verb “log out” instead of the noun ‘logout’?
Context: ...p on your next login. You don't have to logout, just start another session on the CLI ...
(LOG_IN)
🪛 markdownlint-cli2 (0.17.2)
docs/docs/docs/getting-started/installation.md
205-205: Fenced code blocks should be surrounded by blank lines
null
(MD031, blanks-around-fences)
209-209: Fenced code blocks should be surrounded by blank lines
null
(MD031, blanks-around-fences)
218-218: Fenced code blocks should be surrounded by blank lines
null
(MD031, blanks-around-fences)
223-223: Fenced code blocks should be surrounded by blank lines
null
(MD031, blanks-around-fences)
225-225: Fenced code blocks should be surrounded by blank lines
null
(MD031, blanks-around-fences)
227-227: Fenced code blocks should be surrounded by blank lines
null
(MD031, blanks-around-fences)
229-229: Fenced code blocks should be surrounded by blank lines
null
(MD031, blanks-around-fences)
231-231: Fenced code blocks should be surrounded by blank lines
null
(MD031, blanks-around-fences)
233-233: Fenced code blocks should be surrounded by blank lines
null
(MD031, blanks-around-fences)
235-235: Fenced code blocks should be surrounded by blank lines
null
(MD031, blanks-around-fences)
237-237: Fenced code blocks should be surrounded by blank lines
null
(MD031, blanks-around-fences)
239-239: Fenced code blocks should be surrounded by blank lines
null
(MD031, blanks-around-fences)
241-241: Fenced code blocks should be surrounded by blank lines
null
(MD031, blanks-around-fences)
241-241: Fenced code blocks should have a language specified
null
(MD040, fenced-code-language)
243-243: Fenced code blocks should be surrounded by blank lines
null
(MD031, blanks-around-fences)
245-245: Fenced code blocks should be surrounded by blank lines
null
(MD031, blanks-around-fences)
245-245: Fenced code blocks should have a language specified
null
(MD040, fenced-code-language)
247-247: Fenced code blocks should be surrounded by blank lines
null
(MD031, blanks-around-fences)
249-249: Fenced code blocks should be surrounded by blank lines
null
(MD031, blanks-around-fences)
249-249: Fenced code blocks should have a language specified
null
(MD040, fenced-code-language)
251-251: Fenced code blocks should be surrounded by blank lines
null
(MD031, blanks-around-fences)
253-253: Fenced code blocks should be surrounded by blank lines
null
(MD031, blanks-around-fences)
253-253: Fenced code blocks should have a language specified
null
(MD040, fenced-code-language)
255-255: Fenced code blocks should be surrounded by blank lines
null
(MD031, blanks-around-fences)
⏰ Context from checks skipped due to timeout of 90000ms (1)
- GitHub Check: Analyse Code With CodeQL (typescript)
🔇 Additional comments (5)
README.md (2)
5-5: LGTM! Image path updated correctly.The image path has been updated to reflect the new directory structure.
31-34: LGTM! Documentation section formatting improved.The formatting changes in the Table of Contents and Documentation sections enhance readability.
Also applies to: 50-54
package.json (1)
7-7: LGTM! Appropriate dependency added for CLI setup.The addition of
@devcontainers/clialigns with the new CLI-based setup instructions.docs/docs/docs/getting-started/installation.md (2)
203-209: LGTM! Clear PostgreSQL installation steps.The PostgreSQL installation steps are accurate and well-documented.
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
205-205: Fenced code blocks should be surrounded by blank lines
null(MD031, blanks-around-fences)
209-209: Fenced code blocks should be surrounded by blank lines
null(MD031, blanks-around-fences)
232-235: Verify PostgreSQL host configuration.The instruction to set
API_POSTGRES_HOST=localhostneeds verification to ensure it works with both local and container-based setups.✅ Verification successful
PostgreSQL host configuration is correctly documented
Setting
API_POSTGRES_HOST=localhostis valid as it works for both scenarios:
- Local development: PostgreSQL container ports are mapped to localhost
- Container-based setup: Docker compose handles the networking appropriately
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Check if PostgreSQL is accessible on localhost pg_isready -h localhost -p 5432 # Verify if the connection details work PGPASSWORD=password psql -h localhost -U talawa -d talawa -c "\conninfo"Length of output: 306
Script:
#!/bin/bash # Search for Docker-related files echo "=== Docker Files ===" fd -e dockerfile -e yml -e yaml | grep -i docker # Search for environment variable documentation and configuration echo -e "\n=== Environment Config Files ===" fd -e env # Search for PostgreSQL host configuration in documentation echo -e "\n=== PostgreSQL Host Documentation ===" rg -i "postgres.*host|host.*postgres" --type mdLength of output: 5310
Script:
#!/bin/bash # Check Docker compose files for PostgreSQL configuration echo "=== Docker Compose PostgreSQL Config ===" cat docker/compose.devcontainer.yaml docker/compose.testing.yamlLength of output: 11731
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
233-233: Fenced code blocks should be surrounded by blank lines
null(MD031, blanks-around-fences)
235-235: Fenced code blocks should be surrounded by blank lines
null(MD031, blanks-around-fences)
| ``` | ||
| sudo usermod -a -G docker $USER | ||
| ``` | ||
| 1. You will only become a part of the `docker` group on your next login. You don't have to logout, just start another session on the CLI using the `su` command. | ||
| ``` | ||
| sudo su $USER - | ||
| ``` |
There was a problem hiding this comment.
🧹 Nitpick (assertive)
Fix wording and add blank lines around code blocks.
The text contains repetitive sentence beginnings and incorrect usage of "logout" vs "log out".
-You will only become a part of the `docker` group on your next login. You don't have to logout, just start another session on the CLI using the `su` command.
+The changes will take effect on your next login. However, you don't need to log out - simply start another session on the CLI using the `su` command.
```bash
sudo su $USER -
<details>
<summary>🧰 Tools</summary>
<details>
<summary>🪛 LanguageTool</summary>
[style] ~244-~244: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ... the `docker` group on your next login. You don't have to logout, just start anothe...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
---
[misspelling] ~244-~244: Did you mean the verb “log out” instead of the noun ‘logout’?
Context: ...p on your next login. You don't have to logout, just start another session on the CLI ...
(LOG_IN)
</details>
<details>
<summary>🪛 markdownlint-cli2 (0.17.2)</summary>
241-241: Fenced code blocks should be surrounded by blank lines
null
(MD031, blanks-around-fences)
---
241-241: Fenced code blocks should have a language specified
null
(MD040, fenced-code-language)
---
243-243: Fenced code blocks should be surrounded by blank lines
null
(MD031, blanks-around-fences)
---
245-245: Fenced code blocks should be surrounded by blank lines
null
(MD031, blanks-around-fences)
---
245-245: Fenced code blocks should have a language specified
null
(MD040, fenced-code-language)
---
247-247: Fenced code blocks should be surrounded by blank lines
null
(MD031, blanks-around-fences)
</details>
</details>
<!-- This is an auto-generated comment by CodeRabbit -->
| ```bash | ||
| sudo apt-get -y install postgresql postgresql-contrib | ||
| sudo systemctl enable postgresql.service | ||
| sudo systemctl start postgresql.service | ||
| ``` | ||
| 1. Connect to the PostgreSQL CLI | ||
|
|
||
| ```bash | ||
| sudo -u postgres psql | ||
|
|
||
| ``` | ||
|
|
||
| 1. Create the database, grant permissions then exit | ||
| ```sql | ||
| CREATE DATABASE talawa; | ||
| CREATE USER talawa WITH PASSWORD 'password'; | ||
| GRANT ALL PRIVILEGES ON DATABASE talawa TO talawa; | ||
| GRANT ALL ON SCHEMA public TO talawa; | ||
| ``` | ||
| 1. Exit the PostgreSQL CLI | ||
| ```bash | ||
| exit | ||
| ``` | ||
| 1. Create the `.env` file by copying the template from the `envFiles/` directory | ||
| ```bash | ||
| cp envFiles/.env.devcontainer .env | ||
| ``` | ||
| 1. Change the `.env` file's `API_POSTGRES_HOST` parameter to `localhost`. | ||
| ```ini | ||
| API_POSTGRES_HOST=localhost | ||
| ``` | ||
| 1. Install the packages | ||
| ```bash | ||
| pnpm install | ||
| ``` |
There was a problem hiding this comment.
🧹 Nitpick (assertive)
Add language identifiers to code blocks.
Several code blocks are missing language identifiers, which affects syntax highlighting.
Add appropriate language identifiers to code blocks:
- Line 242:
→bash - Line 246:
→bash - Line 250:
→bash - Line 254:
→json
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
205-205: Fenced code blocks should be surrounded by blank lines
null
(MD031, blanks-around-fences)
209-209: Fenced code blocks should be surrounded by blank lines
null
(MD031, blanks-around-fences)
218-218: Fenced code blocks should be surrounded by blank lines
null
(MD031, blanks-around-fences)
223-223: Fenced code blocks should be surrounded by blank lines
null
(MD031, blanks-around-fences)
225-225: Fenced code blocks should be surrounded by blank lines
null
(MD031, blanks-around-fences)
227-227: Fenced code blocks should be surrounded by blank lines
null
(MD031, blanks-around-fences)
229-229: Fenced code blocks should be surrounded by blank lines
null
(MD031, blanks-around-fences)
231-231: Fenced code blocks should be surrounded by blank lines
null
(MD031, blanks-around-fences)
233-233: Fenced code blocks should be surrounded by blank lines
null
(MD031, blanks-around-fences)
235-235: Fenced code blocks should be surrounded by blank lines
null
(MD031, blanks-around-fences)
237-237: Fenced code blocks should be surrounded by blank lines
null
(MD031, blanks-around-fences)
239-239: Fenced code blocks should be surrounded by blank lines
null
(MD031, blanks-around-fences)
| 1. Create the database, grant permissions then exit | ||
| ```sql | ||
| CREATE DATABASE talawa; | ||
| CREATE USER talawa WITH PASSWORD 'password'; | ||
| GRANT ALL PRIVILEGES ON DATABASE talawa TO talawa; | ||
| GRANT ALL ON SCHEMA public TO talawa; | ||
| ``` |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Add schema creation step for PostgreSQL setup.
The PostgreSQL setup should include creating the schema explicitly before granting permissions.
CREATE DATABASE talawa;
CREATE USER talawa WITH PASSWORD 'password';
GRANT ALL PRIVILEGES ON DATABASE talawa TO talawa;
+\c talawa
+CREATE SCHEMA IF NOT EXISTS public;
GRANT ALL ON SCHEMA public TO talawa;📝 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.
| 1. Create the database, grant permissions then exit | |
| ```sql | |
| CREATE DATABASE talawa; | |
| CREATE USER talawa WITH PASSWORD 'password'; | |
| GRANT ALL PRIVILEGES ON DATABASE talawa TO talawa; | |
| GRANT ALL ON SCHEMA public TO talawa; | |
| ``` | |
| 1. Create the database, grant permissions then exit |
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
218-218: Fenced code blocks should be surrounded by blank lines
null
(MD031, blanks-around-fences)
223-223: Fenced code blocks should be surrounded by blank lines
null
(MD031, blanks-around-fences)
Updated installation documentation
Summary by CodeRabbit
Documentation
Dependencies
@devcontainers/cliversion 0.73.0 to project dependencies