updated documentation #3099
updated documentation #3099
Conversation
WalkthroughThe pull request involves updates to two documentation files: 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
|
palisadoes
added
the
ignore-sensitive-files-pr
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
|
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## develop-postgres #3099 +/- ##
=================================================
Coverage 39.85% 39.85%
=================================================
Files 453 453
Lines 33203 33203
Branches 385 385
=================================================
Hits 13234 13234
Misses 19969 19969 ☔ View full report in Codecov by Sentry. |
![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 (2)
docs/pnpm-lock.yamlis excluded by!**/pnpm-lock.yamldocs/static/img/markdown/misc/talawa-logo-lite-200x200.pngis excluded by!**/*.png
📒 Files selected for processing (2)
README.md(3 hunks)docs/docs/docs/getting-started/installation.md(2 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/docs/docs/getting-started/installation.md
[style] ~248-~248: 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] ~248-~248: 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)
257-257: Fenced code blocks should be surrounded by blank lines
null
(MD031, blanks-around-fences)
257-257: Fenced code blocks should have a language specified
null
(MD040, fenced-code-language)
259-259: 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: Test Deployment to https://docs-api.talawa.io
🔇 Additional comments (3)
README.md (1)
5-5: Documentation structure improvements look good!The changes improve the organization of assets and enhance the readability of the documentation through consistent formatting.
Also applies to: 27-54
docs/docs/docs/getting-started/installation.md (2)
203-227: PostgreSQL setup instructions look good!The step-by-step instructions for PostgreSQL installation and configuration are clear and accurate.
🧰 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)
Line range hint
262-271: IDE setup instructions look good!The Visual Studio Code setup instructions are clear and well-organized.
🧰 Tools
🪛 LanguageTool
[style] ~248-~248: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ... thedockergroup on your next login. You don't have to logout, just start anothe...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[misspelling] ~248-~248: 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)
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)
257-257: Fenced code blocks should be surrounded by blank lines
null(MD031, blanks-around-fences)
257-257: Fenced code blocks should have a language specified
null(MD040, fenced-code-language)
259-259: Fenced code blocks should be surrounded by blank lines
null(MD031, blanks-around-fences)
| ``` | ||
| pnpm install -g @devcontainers/cli | ||
| ``` |
There was a problem hiding this comment.
🧹 Nitpick (assertive)
Add language specifiers to code blocks.
Several code blocks are missing language specifiers, which affects syntax highlighting. Add appropriate language specifiers (e.g., bash) to the following code blocks:
- Line 241: Installation command
- Line 245: Docker group command
- Line 249: User switch command
- Line 253: Devcontainer build command
- Line 257: Success output
Also applies to: 245-247, 249-251, 253-255, 257-259
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
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)
| ```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 | ||
| ``` | ||
| 1. Intall the `devcontainers/cli` package | ||
| ``` | ||
| pnpm install -g @devcontainers/cli | ||
| ``` | ||
| 1. You will now need to make your user a part of the `docker` operating system group or else you will get `permission denied` messages when starting docker later. `$USER` is a universal representation of your username. You don't need to change this in the command below. | ||
| ``` | ||
| 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 - | ||
| ``` | ||
| 1. Start the docker devcontainer | ||
| ``` | ||
| devcontainer build --workspace-folder . | ||
| ``` | ||
| 1. When startup is complete, the last like of the output should be: | ||
| ``` | ||
| {"outcome":"success","imageName":"talawa-api"} | ||
| ``` |
There was a problem hiding this comment.
🧹 Nitpick (assertive)
Add blank lines around code blocks.
For better readability, ensure all code blocks are surrounded by blank lines.
🧰 Tools
🪛 LanguageTool
[style] ~248-~248: 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] ~248-~248: 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)
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)
257-257: Fenced code blocks should be surrounded by blank lines
null
(MD031, blanks-around-fences)
257-257: Fenced code blocks should have a language specified
null
(MD040, fenced-code-language)
259-259: 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. |
There was a problem hiding this comment.
🧹 Nitpick (assertive)
Improve sentence structure and fix spelling.
Consider rewording to avoid repetition and fix spelling:
- Three sentences begin with "You"
- Use "log out" (verb) instead of "logout" (noun)
Apply this change:
-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 to the `docker` group will take effect on your next login. However, you don't have to log out - simply start another session on the CLI using the `su` command.📝 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. 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 to the `docker` group will take effect on your next login. However, you don't have to log out - simply start another session on the CLI using the `su` command. |
🧰 Tools
🪛 LanguageTool
[style] ~248-~248: 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] ~248-~248: 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)
palisadoes
merged commit 74730b2
into
PalisadoesFoundation:develop-postgres
updated documentation
Summary by CodeRabbit