fix(properties): correct topic property name in kafka_batch_max_bytes reference#1775
fix(properties): correct topic property name in kafka_batch_max_bytes reference#1775Feediver1 wants to merge 1 commit into
Conversation
… reference The kafka_batch_max_bytes cluster property referenced the topic-level message size property as `message.max.bytes` (the Kafka broker-config name) in both its description and its Related topics link. The correct topic property is `max.message.bytes` (see topic-properties.adoc). Corrected the override in docs-data/property-overrides.json and regenerated the property partial + JSON attachment at tag v26.1.10 with cloud-support intact. Self-managed counterpart to the same error fixed in cloud-docs prose (redpanda-data/cloud-docs#627). Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
✅ Deploy Preview for redpanda-docs-preview ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
📝 WalkthroughWalkthroughThis change updates documentation references for the Estimated code review effort: 1 (Trivial) | ~3 minutes Compact MetadataRelated issues: None provided Poem: 🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
♻️ Duplicate comments (1)
modules/reference/attachments/redpanda-properties-v26.1.10.json (1)
7820-7820: 🎯 Functional Correctness | 🟡 Minor | ⚡ Quick winSame missing-anchor issue propagated from the override source.
This generated file mirrors the
docs-data/property-overrides.jsonentry, including the xref that lacks the#max-message-bytesanchor. Fix at the source (property-overrides.json) and regenerate; no separate fix needed here.Also applies to: 7829-7829
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@modules/reference/attachments/redpanda-properties-v26.1.10.json` at line 7820, The missing-anchor xref is inherited from the override source, so fix the `property-overrides.json` entry that feeds this generated property description rather than editing `redpanda-properties-v26.1.10.json` directly. Update the `max.message.bytes` reference in the relevant override record to include the `#max-message-bytes` anchor, then regenerate the docs so the generated output picks up the corrected link. This applies to the override entry used by the mirrored property descriptions, including the one that produced the `description` field here.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs-data/property-overrides.json`:
- Around line 1207-1210: The xref for max.message.bytes in both related_topics
and description is missing the anchor, so it points to the top of
topic-properties.adoc instead of the property section. Update the references in
property-overrides.json to match the existing pattern used elsewhere in this
file by adding the max-message-bytes anchor to the xref. Use the related_topics
entry and the description text as the places to fix, keeping the same reference
target format as the other max.message.bytes links.
---
Duplicate comments:
In `@modules/reference/attachments/redpanda-properties-v26.1.10.json`:
- Line 7820: The missing-anchor xref is inherited from the override source, so
fix the `property-overrides.json` entry that feeds this generated property
description rather than editing `redpanda-properties-v26.1.10.json` directly.
Update the `max.message.bytes` reference in the relevant override record to
include the `#max-message-bytes` anchor, then regenerate the docs so the
generated output picks up the corrected link. This applies to the override entry
used by the mirrored property descriptions, including the one that produced the
`description` field here.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: b130627c-8d4e-49ec-81be-a25967cc0635
📒 Files selected for processing (3)
docs-data/property-overrides.jsonmodules/reference/attachments/redpanda-properties-v26.1.10.jsonmodules/reference/partials/properties/cluster-properties.adoc
| "related_topics": [ | ||
| "xref:reference:properties/topic-properties.adoc[`message.max.bytes`]" | ||
| "xref:reference:properties/topic-properties.adoc[`max.message.bytes`]" | ||
| ], | ||
| "description": "The default maximum batch size for topics if the topic property xref:reference:properties/topic-properties.adoc[`message.max.bytes`] is not set. If the batch is compressed, the limit applies to the compressed batch size.", | ||
| "description": "The default maximum batch size for topics if the topic property xref:reference:properties/topic-properties.adoc[`max.message.bytes`] is not set. If the batch is compressed, the limit applies to the compressed batch size.", |
There was a problem hiding this comment.
🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win
Missing anchor in max.message.bytes xref — link won't jump to the property.
The new xref xref:reference:properties/topic-properties.adoc[max.message.bytes] points to the top of topic-properties.adoc instead of the specific property section. Elsewhere in this same file, references to this property consistently include the anchor, e.g. kafka_max_message_size_upper_limit_bytes uses xref:reference:properties/topic-properties.adoc#max-message-bytes[max.message.bytes]. Apply the same anchor here for both the related_topics entry and the inline reference in description.
🔗 Proposed fix to add the missing anchor
"related_topics": [
- "xref:reference:properties/topic-properties.adoc[`max.message.bytes`]"
+ "xref:reference:properties/topic-properties.adoc#max-message-bytes[`max.message.bytes`]"
],
- "description": "The default maximum batch size for topics if the topic property xref:reference:properties/topic-properties.adoc[`max.message.bytes`] is not set. If the batch is compressed, the limit applies to the compressed batch size.",
+ "description": "The default maximum batch size for topics if the topic property xref:reference:properties/topic-properties.adoc#max-message-bytes[`max.message.bytes`] is not set. If the batch is compressed, the limit applies to the compressed batch size.",📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| "related_topics": [ | |
| "xref:reference:properties/topic-properties.adoc[`message.max.bytes`]" | |
| "xref:reference:properties/topic-properties.adoc[`max.message.bytes`]" | |
| ], | |
| "description": "The default maximum batch size for topics if the topic property xref:reference:properties/topic-properties.adoc[`message.max.bytes`] is not set. If the batch is compressed, the limit applies to the compressed batch size.", | |
| "description": "The default maximum batch size for topics if the topic property xref:reference:properties/topic-properties.adoc[`max.message.bytes`] is not set. If the batch is compressed, the limit applies to the compressed batch size.", | |
| "related_topics": [ | |
| "xref:reference:properties/topic-properties.adoc#max-message-bytes[`max.message.bytes`]" | |
| ], | |
| "description": "The default maximum batch size for topics if the topic property xref:reference:properties/topic-properties.adoc#max-message-bytes[`max.message.bytes`] is not set. If the batch is compressed, the limit applies to the compressed batch size.", |
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@docs-data/property-overrides.json` around lines 1207 - 1210, The xref for
max.message.bytes in both related_topics and description is missing the anchor,
so it points to the top of topic-properties.adoc instead of the property
section. Update the references in property-overrides.json to match the existing
pattern used elsewhere in this file by adding the max-message-bytes anchor to
the xref. Use the related_topics entry and the description text as the places to
fix, keeping the same reference target format as the other max.message.bytes
links.
2 participants
Why
The
kafka_batch_max_bytescluster property referenced the topic-level message-size property by the wrong name —message.max.bytes(the Kafka broker-config name) — in two places: its description and its Related topics link. The correct topic property ismax.message.bytes(defined intopic-properties.adoc).This is the self-managed counterpart to the same error fixed in cloud-docs prose (redpanda-data/cloud-docs#627).
What
docs-data/property-overrides.json— corrected bothmessage.max.bytes→max.message.bytesin thekafka_batch_max_bytesoverride (description+related_topics). This is the source of truth.modules/reference/partials/properties/cluster-properties.adocandmodules/reference/attachments/redpanda-properties-v26.1.10.json— regenerated viadoc-tools generate property-docs --tag v26.1.10 --generate-partials(cloud-support tags intact), so the generated artifacts reflect the override.Diff is limited to this one property: 3 files, 6 lines, all the
message.max.bytes→max.message.bytescorrection.Note for reviewers
Regenerating at v26.1.10 surfaced one unrelated drift I deliberately excluded from this PR:
topic_memory_per_partition's default rendered as the raw constantDEFAULT_TOPIC_MEMORY_PER_PARTITIONinstead of the resolved200 KiB (204800)currently onmain. I reverted that line to matchmainso this PR stays scoped. Worth a separate look — a future auto-docs regen may reintroduce it (looks like a default-resolution regression in the property extractor).🤖 Generated with Claude Code