Added Build Your Own Kafka

[buildthingsuseful]

Building Your Own Kafka-like System From Scratch: A Step-by-Step Guide

Summary by CodeRabbit

• Documentation
  • Added a new tutorial subsection in the Tutorials area to highlight distributed systems. This update features a Java guide that offers step-by-step instructions for building a Kafka-like system, expanding the available learning resources for users interested in distributed system architectures.

[coderabbitai]

Walkthrough

The pull request updates the documentation by adding a new subsection under the "Tutorials" heading in the README. This new subsection, titled Build your own Distributed Systems, includes a tutorial entry that links to a Java guide for building a Kafka-like system from scratch. The update provides additional resources for users interested in distributed systems without impacting any application code.

Changes

File	Change Summary
README.md	Added a new subsection "Build your own Distributed Systems" under the Tutorials section with a link to the Java tutorial guide.

Poem

I'm a rabbit who hops with glee,
In the README, new tutorials I see.
A guide to build systems, so bold and bright,
Java dreams taking flight in the light.
With every change, I cheer with delight!
🐇✨

Tip

⚡🧪 Multi-step agentic review comment chat (experimental)

• We're introducing multi-step agentic chat in review comments. This experimental feature enhances review discussions with the CodeRabbit agentic chat by enabling advanced interactions, including the ability to create pull requests directly from comments.
  - To enable this feature, set early_access to true under in the settings.

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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.

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: 0

🧹 Nitpick comments (2)

README.md (2)

41-41: Adjust Heading Level for Consistency
The heading "#### Build your own Distributed Systems" is four levels deep, which is too steep given that the parent heading "## Tutorials" is at level two. To ensure proper hierarchical progression, change this heading to level three (i.e., use "###").

-#### Build your own `Distributed Systems`
+### Build your own `Distributed Systems`

🧰 Tools

🪛 markdownlint-cli2 (0.17.2)

41-41: Heading levels should only increment by one level at a time
Expected: h3; Actual: h4

(MD001, heading-increment)

---

42-42: Standardize Emphasis Style
Markdownlint expects the use of asterisks for emphasis instead of underscores. Please update the italic formatting in the tutorial entry by replacing underscores with asterisks.

-* [**Java**: _Building Your Own Kafka-like System From Scratch: A Step-by-Step Guide_](https://github.com/buildthingsuseful/build-your-own-kafka)
+* [**Java**: *Building Your Own Kafka-like System From Scratch: A Step-by-Step Guide*](https://github.com/buildthingsuseful/build-your-own-kafka)

🧰 Tools

🪛 markdownlint-cli2 (0.17.2)

42-42: Emphasis style
Expected: asterisk; Actual: underscore

(MD049, emphasis-style)

---

42-42: Emphasis style
Expected: asterisk; Actual: underscore

(MD049, emphasis-style)

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 7b7d32b and 363261b.

📒 Files selected for processing (1)

• README.md (1 hunks)

🧰 Additional context used

🪛 markdownlint-cli2 (0.17.2)

README.md

41-41: Heading levels should only increment by one level at a time
Expected: h3; Actual: h4

(MD001, heading-increment)

---

42-42: Emphasis style
Expected: asterisk; Actual: underscore

(MD049, emphasis-style)

---

42-42: Emphasis style
Expected: asterisk; Actual: underscore

(MD049, emphasis-style)