docs(DOC-2012): mirror Kafka Compatibility frontmatter on cloud stub#606
Conversation
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>
✅ Deploy Preview for rp-cloud ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
Important Review skippedAuto incremental reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
📝 WalkthroughWalkthroughThis PR adds AsciiDoc metadata attributes to the Kafka clients documentation page. Four metadata lines are inserted into the page header: Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Suggested reviewers
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
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>
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) addedpage-topic-type,personas, and two learning objectives in the frontmatter so the page carries proper metadata in the streaming component. The cloud stubcloud-docs/modules/develop/pages/kafka-clients.adocincludes the body viainclude::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
@micheleRPrecommended: 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
/cloud-data-platform/develop/kafka-clients/