Skip to content

docs+quickstart: Medium cross-link and a header in the greeter example#269

Merged
oleksandr-kazimirov merged 1 commit into
releasefrom
docs/cross-links-quickstart-header
Jul 24, 2026
Merged

docs+quickstart: Medium cross-link and a header in the greeter example#269
oleksandr-kazimirov merged 1 commit into
releasefrom
docs/cross-links-quickstart-header

Conversation

@oleksandr-kazimirov

@oleksandr-kazimirov oleksandr-kazimirov commented Jul 24, 2026

Copy link
Copy Markdown
Contributor

Cross-link pass after the KZM-3.4 announcements: canonical article byline gains the Medium link; the quickstart greeter sets one record header on its egress so the feature is visible in the first example users run. Quickstart smoke validates the round-trip against the published 3.4.0-KZM-3.4 artifacts.

Summary by CodeRabbit

  • New Features

    • Quickstart greeting messages now include a greeted-by Kafka header identifying the component that produced them.
  • Documentation

    • Updated the Kafka record headers article with publication attribution and links to read the article on dev.to and Medium.

…n the greeter

The quickstart greeter now sets one Kafka record header on its egress so
every new user sees the KZM-3.4 header API in the first example they run.
The canonical headers article byline links the Medium syndication next to
the dev.to one.
@oleksandr-kazimirov
oleksandr-kazimirov requested a review from a team July 24, 2026 16:25
@coderabbitai

coderabbitai Bot commented Jul 24, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: a3da217e-b9b3-44bb-a7de-5240afbfbda7

📥 Commits

Reviewing files that changed from the base of the PR and between 2cda350 and f07b0f3.

📒 Files selected for processing (2)
  • docs/articles/kafka-record-headers.md
  • examples/quickstart/greeter/src/main/java/io/github/kzmlabs/quickstart/GreeterFn.java

Walkthrough

The greeter example now emits a greeted-by Kafka header. The Kafka record headers article’s publication metadata now includes maintainer attribution and links to dev.to and Medium.

Changes

Greeter Kafka header

Layer / File(s) Summary
Emit greeter header
examples/quickstart/greeter/src/main/java/io/github/kzmlabs/quickstart/GreeterFn.java
The egress message builder adds the UTF-8 greeted-by header with value quickstart-greeter.

Article publication metadata

Layer / File(s) Summary
Update publication metadata
docs/articles/kafka-record-headers.md
The publication line adds kzmlabs maintainers attribution and dev.to and Medium links.

Estimated code review effort: 1 (Trivial) | ~3 minutes

Possibly related PRs

  • kzmlabs/flink-statefun#268: Revises the same Kafka record headers article, including its title, description, and header guidance.
🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly summarizes the two main changes: a Medium cross-link in docs and a Kafka record header in the greeter example.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/cross-links-quickstart-header

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

Comment @coderabbitai help to get the list of available commands.

@oleksandr-kazimirov
oleksandr-kazimirov merged commit b2dc169 into release Jul 24, 2026
7 checks passed
@codecov

codecov Bot commented Jul 24, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant