Minor Fix: Docs

[JaiPannu-IITI]

Overview

This is a quick fix which seems cosmetic but is logical error that if not fixed might be misleading. I added these steps in my last PR but due to unnoticed indentation sequence wasn't properly numbered.

Related PR: #3317
Related Issue: #3214

Current behavior

Updated behavior

Summary by CodeRabbit

• Documentation
  • Enhanced the installation instructions with improved code snippet formatting for clearer and more readable Docker command guidelines and output messages.

[coderabbitai]

Walkthrough

The changes adjust the formatting of code snippets in the installation documentation for the Talawa API. Indentation and spacing have been refined for commands and expected JSON output, specifically for Docker devcontainer commands. The modifications are purely presentational; the commands’ functionality and declared public entities remain unchanged.

Changes

File	Change Summary
docs/.../getting-started/installation.md	Reformatted code blocks with improved indentation and spacing for Docker devcontainer commands and JSON outputs.

Possibly related PRs

• Updated documentation - testing in a separate document #3106: Focuses on structural changes and content updates in the same installation document.
• Updated documentation for devcontainers #3100: Involves rephrasing and restructuring sections of the installation documentation.
• Updated API_ADMINISTRATOR_USER_EMAIL_ADDRESS documentation #3107: Introduces new sections and commands related to the development environment setup in the same file.

Suggested labels

ignore-sensitive-files-pr

Suggested reviewers

• palisadoes

---

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?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

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)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[github-actions]

Our Pull Request Approval Process

Thanks for contributing!

Testing Your Code

Remember, your PRs won't be reviewed until these criteria are met:

1. We don't merge PRs with poor code quality.
   1. Follow coding best practices such that CodeRabbit.ai approves your PR.
2. We don't merge PRs with failed tests.
   1. When tests fail, click on the Details link to learn more.
   2. Write sufficient tests for your changes (CodeCov Patch Test). Your testing level must be better than the target threshold of the repository
   3. Tests may fail if you edit sensitive files. Ask to add the ignore-sensitive-files-pr label if the edits are necessary.
3. We cannot merge PRs with conflicting files. These must be fixed.

Our policies make our code better.

Reviewers

Do not assign reviewers. Our Queue Monitors will review your PR and assign them.
When your PR has been assigned reviewers contact them to get your code reviewed and approved via:

1. comments in this PR or
2. our slack channel

Reviewing Your Code

Your reviewer(s) will have the following roles:

1. arbitrators of future discussions with other contributors about the validity of your changes
2. point of contact for evaluating the validity of your work
3. person who verifies matching issues by others that should be closed.
4. person who gives general guidance in fixing your tests

CONTRIBUTING.md

Read our CONTRIBUTING.md file. Most importantly:

1. PRs with issues not assigned to you will be closed by the reviewer
2. Fix the first comment in the PR so that each issue listed automatically closes

Other

1. 🎯 Please be considerate of our volunteers' time. Contacting the person who assigned the reviewers is not advised unless they ask for your input. Do not @ the person who did the assignment otherwise.
2. Read the CONTRIBUTING.md file make

[coderabbitai]

Actionable comments posted: 4

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 557cbbe and 8dd8107.

📒 Files selected for processing (1)

• docs/docs/docs/getting-started/installation.md (1 hunks)

🧰 Additional context used

🪛 markdownlint-cli2 (0.17.2)

docs/docs/docs/getting-started/installation.md

294-294: Fenced code blocks should have a language specified
null

(MD040, fenced-code-language)

---

300-300: Fenced code blocks should have a language specified
null

(MD040, fenced-code-language)

---

306-306: Fenced code blocks should have a language specified
null

(MD040, fenced-code-language)

---

312-312: Fenced code blocks should have a language specified
null

(MD040, fenced-code-language)

⏰ Context from checks skipped due to timeout of 90000ms (2)

• GitHub Check: Run tests for talawa api
• GitHub Check: Analyse Code With CodeQL (typescript)

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 49.45%. Comparing base (38a7f65) to head (8bf0ac8).
Report is 15 commits behind head on develop-postgres.

Additional details and impacted files

@@                 Coverage Diff                  @@
##           develop-postgres    #3328      +/-   ##
====================================================
+ Coverage             48.80%   49.45%   +0.65%     
====================================================
  Files                   458      462       +4     
  Lines                 34494    34776     +282     
  Branches                985     1038      +53     
====================================================
+ Hits                  16834    17199     +365     
+ Misses                17660    17577      -83     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[JaiPannu-IITI]

@palisadoes PR is ready for review.

[Cioppolo14]

@varshith257 @disha1202 Can you review this PR?