Patch/kafka and readme

[igorcampos-dev]

Summary by CodeRabbit

• Documentation

  • Improved formatting of the "Projects" table in the main README for better readability.
  • Added a new README for the Spring Kafka example, including an overview, technology stack, and related resources.

• New Features

  • Introduced Docker Compose services for Zookeeper and Kafka to support local development with the Spring Kafka example.

[coderabbitai]

Walkthrough

This update introduces a new README and Docker Compose configuration for the spring-kafka-example project, detailing Kafka and Zookeeper service setup for local development. Additionally, the main repository README's "Projects" table formatting is streamlined for clarity, with no changes to table content.

Changes

File(s)	Change Summary
README.md	Reformatted the "Projects" markdown table header and separator lines for a more compact style.
spring-kafka-example/README.md	Added a new README with an overview, tech stack, and related resources for the Kafka example.
spring-kafka-example/compose.yaml	Added Zookeeper and Kafka services to Docker Compose for local development; no changes to server.

Estimated code review effort

2 (~15 minutes)

Possibly related PRs

• Create README.md #17: Both PRs involve adding or updating README files to document Spring Kafka integration examples.

Suggested labels

doc: documentation

---

🪧 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.
  • Explain this complex logic.
  • 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 explain this code block.
  • @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 explain its main purpose.
  • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate sequence diagram to generate a sequence diagram of the changes in 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.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

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.

[coderabbitai]

Actionable comments posted: 4

📜 Review details

Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between db49972 and 3676921.

📒 Files selected for processing (3)

• README.md (1 hunks)
• spring-kafka-example/README.md (1 hunks)
• spring-kafka-example/compose.yaml (2 hunks)

🪛 LanguageTool

README.md

[grammar] ~19-~19: Use correct spacing
Context: ...n between Spring Boot and Apache Kafka. | --- ## Tech Stack - Spring Framework - Techn...

(QB_NEW_EN_OTHER_ERROR_IDS_5)

spring-kafka-example/README.md

[grammar] ~1-~1: Use correct spacing
Context: # spring-example-kafka --- ## Overview Basic Java Spring (Java 21) pr...

(QB_NEW_EN_OTHER_ERROR_IDS_5)

---

[grammar] ~8-~8: Use correct spacing
Context: ...d consumer with minimal setup for local development. --- ## Tech stack - Spring Boot - Java 21 - Ka...

(QB_NEW_EN_OTHER_ERROR_IDS_5)

---

[grammar] ~12-~12: Use correct spacing
Context: ...up for local development. --- ## Tech stack - Spring Boot - Java 21 - Kafka (Docker) ...

(QB_NEW_EN_OTHER_ERROR_IDS_5)

---

[grammar] ~16-~16: Use correct spacing
Context: ... stack - Spring Boot - Java 21 - Kafka (Docker) --- ## Related Resources | Description ...

(QB_NEW_EN_OTHER_ERROR_IDS_5)

---

[grammar] ~20-~20: Use correct spacing
Context: ...va 21 - Kafka (Docker) --- ## Related Resources | Description ...

(QB_NEW_EN_OTHER_ERROR_IDS_5)

🪛 YAMLlint (1.37.1)

spring-kafka-example/compose.yaml

[error] 33-33: no new line character at the end of file

(new-line-at-end-of-file)

🧰 Additional context used

🪛 LanguageTool

README.md

[grammar] ~19-~19: Use correct spacing
Context: ...n between Spring Boot and Apache Kafka. | --- ## Tech Stack - Spring Framework - Techn...

(QB_NEW_EN_OTHER_ERROR_IDS_5)

spring-kafka-example/README.md

[grammar] ~1-~1: Use correct spacing
Context: # spring-example-kafka --- ## Overview Basic Java Spring (Java 21) pr...

(QB_NEW_EN_OTHER_ERROR_IDS_5)

---

[grammar] ~8-~8: Use correct spacing
Context: ...d consumer with minimal setup for local development. --- ## Tech stack - Spring Boot - Java 21 - Ka...

(QB_NEW_EN_OTHER_ERROR_IDS_5)

---

[grammar] ~12-~12: Use correct spacing
Context: ...up for local development. --- ## Tech stack - Spring Boot - Java 21 - Kafka (Docker) ...

(QB_NEW_EN_OTHER_ERROR_IDS_5)

---

[grammar] ~16-~16: Use correct spacing
Context: ... stack - Spring Boot - Java 21 - Kafka (Docker) --- ## Related Resources | Description ...

(QB_NEW_EN_OTHER_ERROR_IDS_5)

---

[grammar] ~20-~20: Use correct spacing
Context: ...va 21 - Kafka (Docker) --- ## Related Resources | Description ...

(QB_NEW_EN_OTHER_ERROR_IDS_5)

🪛 YAMLlint (1.37.1)

spring-kafka-example/compose.yaml

[error] 33-33: no new line character at the end of file

(new-line-at-end-of-file)

🔇 Additional comments (1)

README.md (1)

17-19: Table re-formatting looks good

Alignment and Markdown syntax are correct; no functional concerns.

[coderabbitai]

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 3676921 and c26aef5.

📒 Files selected for processing (1)

• spring-kafka-example/compose.yaml (2 hunks)

🧠 Learnings (1)

spring-kafka-example/compose.yaml (1)

Learnt from: igorcampos-dev
PR: #21
File: spring-kafka-example/compose.yaml:30-32
Timestamp: 2025-07-22T01:30:57.030Z
Learning: User igorcampos-dev prefers to maintain environment parity between local development and production, avoiding development-specific configurations like ALLOW_PLAINTEXT_LISTENER even when they might provide clearer intent or safety nets.

🧰 Additional context used

🧠 Learnings (1)

spring-kafka-example/compose.yaml (1)

Learnt from: igorcampos-dev
PR: #21
File: spring-kafka-example/compose.yaml:30-32
Timestamp: 2025-07-22T01:30:57.030Z
Learning: User igorcampos-dev prefers to maintain environment parity between local development and production, avoiding development-specific configurations like ALLOW_PLAINTEXT_LISTENER even when they might provide clearer intent or safety nets.

🔇 Additional comments (1)

spring-kafka-example/compose.yaml (1)

20-33: Kafka ↔ ZooKeeper versions now aligned – good catch
Both services use Confluent Platform 7.4.0, removing the cross-version risk flagged earlier.

[coderabbitai]

Actionable comments posted: 2

📜 Review details

Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between c26aef5 and 86b659c.

📒 Files selected for processing (1)

• spring-kafka-example/README.md (1 hunks)

🧠 Learnings (1)

📓 Common learnings

Learnt from: igorcampos-dev
PR: igorcampos-dev/spring-integrations-examples#21
File: spring-kafka-example/compose.yaml:30-32
Timestamp: 2025-07-22T01:30:57.030Z
Learning: User igorcampos-dev prefers to maintain environment parity between local development and production, avoiding development-specific configurations like ALLOW_PLAINTEXT_LISTENER even when they might provide clearer intent or safety nets.

🪛 LanguageTool

spring-kafka-example/README.md

[grammar] ~1-~1: Use correct spacing
Context: # spring-kafka-example --- ## Overview Basic Java Spring (Java 21) pr...

(QB_NEW_EN_OTHER_ERROR_IDS_5)

---

[grammar] ~8-~8: Use correct spacing
Context: ...d consumer with minimal setup for local development. --- ## Tech stack - Spring Boot - Java 21 - Ka...

(QB_NEW_EN_OTHER_ERROR_IDS_5)

---

[grammar] ~12-~12: Use correct spacing
Context: ...up for local development. --- ## Tech stack - Spring Boot - Java 21 - Kafka (Docker) ...

(QB_NEW_EN_OTHER_ERROR_IDS_5)

---

[grammar] ~16-~16: Use correct spacing
Context: ... stack - Spring Boot - Java 21 - Kafka (Docker) --- ## Related Resources | Description ...

(QB_NEW_EN_OTHER_ERROR_IDS_5)

---

[grammar] ~20-~20: Use correct spacing
Context: ...va 21 - Kafka (Docker) --- ## Related Resources | Description ...

(QB_NEW_EN_OTHER_ERROR_IDS_5)

🧰 Additional context used

🧠 Learnings (1)

📓 Common learnings

Learnt from: igorcampos-dev
PR: igorcampos-dev/spring-integrations-examples#21
File: spring-kafka-example/compose.yaml:30-32
Timestamp: 2025-07-22T01:30:57.030Z
Learning: User igorcampos-dev prefers to maintain environment parity between local development and production, avoiding development-specific configurations like ALLOW_PLAINTEXT_LISTENER even when they might provide clearer intent or safety nets.

🪛 LanguageTool

spring-kafka-example/README.md

[grammar] ~1-~1: Use correct spacing
Context: # spring-kafka-example --- ## Overview Basic Java Spring (Java 21) pr...

(QB_NEW_EN_OTHER_ERROR_IDS_5)

---

[grammar] ~8-~8: Use correct spacing
Context: ...d consumer with minimal setup for local development. --- ## Tech stack - Spring Boot - Java 21 - Ka...

(QB_NEW_EN_OTHER_ERROR_IDS_5)

---

[grammar] ~12-~12: Use correct spacing
Context: ...up for local development. --- ## Tech stack - Spring Boot - Java 21 - Kafka (Docker) ...

(QB_NEW_EN_OTHER_ERROR_IDS_5)

---

[grammar] ~16-~16: Use correct spacing
Context: ... stack - Spring Boot - Java 21 - Kafka (Docker) --- ## Related Resources | Description ...

(QB_NEW_EN_OTHER_ERROR_IDS_5)

---

[grammar] ~20-~20: Use correct spacing
Context: ...va 21 - Kafka (Docker) --- ## Related Resources | Description ...

(QB_NEW_EN_OTHER_ERROR_IDS_5)

🔇 Additional comments (1)

spring-kafka-example/README.md (1)

1-1: Title mismatch resolved – looks good
Heading now aligns with directory name, eliminating the confusion flagged in the previous review.