Skip to content

docs(DOC-2012): mirror Kafka Compatibility frontmatter on cloud stub#606

Merged
Feediver1 merged 2 commits into
mainfrom
doc-2012-kafka4x-metadata-parity
May 29, 2026
Merged

docs(DOC-2012): mirror Kafka Compatibility frontmatter on cloud stub#606
Feediver1 merged 2 commits into
mainfrom
doc-2012-kafka4x-metadata-parity

Conversation

@Feediver1
Copy link
Copy Markdown
Contributor

@Feediver1 Feediver1 commented May 29, 2026

Summary

Companion to redpanda-data/docs#1614. Resolves DOC-2012 on the cloud side.

The docs-side page (docs/modules/develop/pages/kafka-clients.adoc) added page-topic-type, personas, and two learning objectives in the frontmatter so the page carries proper metadata in the streaming component. The cloud stub cloud-docs/modules/develop/pages/kafka-clients.adoc includes the body via include::streaming:develop:kafka-clients.adoc[tag=single-source] but Antora does not inherit frontmatter through a single-source include — it has to live in the stub.

This PR mirrors the same four attributes on the cloud stub so the page renders with consistent metadata under /cloud-data-platform/.

This is the Pattern B fix @micheleRP recommended: leave the docs-side header as-is, duplicate the frontmatter on the cloud stub. Reference stubs that follow the same pattern: schema-reg-contexts.adoc, manage-throughput.adoc.

Preview pages

Test plan

  • Netlify preview builds without errors
  • Page renders the new metadata (topic type, persona, learning objectives) at /cloud-data-platform/develop/kafka-clients/
  • Body content (Kafka 4.x scope, KIP-890 bullet, terminology fixes) is unchanged — it still comes from the docs single-source include

Companion to redpanda-data/docs#1614. The docs-side page added
page-topic-type, personas, and two learning objectives in the
frontmatter; the cloud stub at modules/develop/pages/kafka-clients.adoc
must duplicate them so the metadata renders consistently on
/cloud-data-platform/ (Pattern B per @micheleRP's review).

Follows the same pattern as schema-reg-contexts.adoc and
manage-throughput.adoc, which carry their own frontmatter even though
the body is single-sourced from the streaming component via
include::streaming:...[tag=single-source].

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
@Feediver1 Feediver1 requested a review from a team as a code owner May 29, 2026 19:56
@netlify
Copy link
Copy Markdown

netlify Bot commented May 29, 2026

Deploy Preview for rp-cloud ready!

Name Link
🔨 Latest commit 5a41caf
🔍 Latest deploy log https://app.netlify.com/projects/rp-cloud/deploys/6a19f5c17b0c7300082d072f
😎 Deploy Preview https://deploy-preview-606--rp-cloud.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 29, 2026

Review Change Stack

Important

Review skipped

Auto incremental reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 30e7a19c-9b50-4dcd-9cd5-63feeb0fea30

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
📝 Walkthrough

Walkthrough

This PR adds AsciiDoc metadata attributes to the Kafka clients documentation page. Four metadata lines are inserted into the page header: :page-topic-type: for topic classification, :personas: for target audience, and two :learning-objective-*: entries that describe learning outcomes.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Suggested reviewers

  • paulohtb6
🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and specifically describes the main change: mirroring Kafka Compatibility frontmatter metadata onto the cloud documentation stub, directly matching the changeset's purpose.
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.
Description check ✅ Passed The pull request description is comprehensive and well-structured, covering the purpose, approach, preview links, and test plan.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch doc-2012-kafka4x-metadata-parity

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

The single-sourced body is pulled from the streaming component (docs repo).
docs#1614 merged after this PR's last preview built, so rebuild to render
the new body (KIP-890 bullet, learning-objective checkboxes) against the
mirrored stub frontmatter.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Copy link
Copy Markdown
Contributor

@micheleRP micheleRP left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm!

@Feediver1 Feediver1 merged commit 8f300da into main May 29, 2026
5 checks passed
@Feediver1 Feediver1 deleted the doc-2012-kafka4x-metadata-parity branch May 29, 2026 20:30
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.

2 participants