docs: surface redpanda.storage.mode.impl on the topic properties page - #1841
Conversation
✅ Deploy Preview for redpanda-docs-preview ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
Important Review skippedAuto reviews are disabled on base/target branches other than the default branch. 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:
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
- redpanda.storage.mode.impl had no category override, so it landed in the category-other tag region, which the topic properties page never includes; it was invisible. Categorize it as tiered-storage. - The generator places default_redpanda_storage_mode_tiered_impl on the object storage properties page; repoint the config_refs that assumed cluster-properties (overrides descriptions and the Tiered Storage partial). Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
df6622e to
a377a5c
Compare
Previous regeneration ran on a stale local 5.0.4 install, producing spurious churn against the auto-docs output. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
…anda-data/docs into whats-new-reorder-tsv2-beta
JakeSCahill
left a comment
There was a problem hiding this comment.
Reviewed with every claim verified against the Redpanda source at the v26.1.14 and v26.2.1 tags. Mixed verdict: several parts of this PR are correct and wanted, but two defects need fixing before merge.
Correct — please keep
- All 26 new
*Introduced in v26.2.1*notes are accurate. Spot-verified against source:kafka_fetch_read_coalescing_enabled,cloud_topics_leveling_disabled,schema_registry_use_rpc,shadow_link_failover_batch_sizeare all absent atv26.1.14and present atv26.2.1. - Removing
log_eviction_exempt_topics,schema_registry_deferred_recovery, andschema_registry_replay_on_startupfromcluster-properties.adocis right — they're v26.1.14 backports that do not exist inv26.2.1(verified in source), so the 26.2 line shouldn't document them yet. - The deprecation-table fix is right — those same three were never deprecated (no deprecation markers at
v26.1.14), so dropping them fromdeprecated-properties.adoccorrects a misclassification.cloud_topics_enabledandspace_management_enable_overridecorrectly remain (the latter is still present andis_deprecated: truein 26.2.1). - The
tiered-storagecategory fix that surfacesredpanda.storage.mode.impl, theobject-storage-propertiesconfig_ref path, and the exact-integer bounds (18446744073709551615instead of the float-rounded…552000) are all improvements.
Defects — please fix
- The three removed cluster properties were moved into
topic-properties.adoc. They are cluster properties, not topic properties — and they don't exist inv26.2.1at all, so they shouldn't appear anywhere on the 26.2 line. Please drop these three sections fromtopic-properties.adoc. redpanda-properties-v26.1.14.jsonwas regenerated from the wrong source ref. The new version contains 26 properties that don't exist in Redpandav26.1.14(verified: e.g.kafka_fetch_read_coalescing_enabled,cloud_topics_leveling_disabledare 26.2-only). This corruptsredpanda-property-changes-v26.1.14-to-v26.2.1.json: its summary goes fromnewProperties: 26tonewProperties: 0, with every genuinely new 26.2 property misclassified as "changed". Please restore the base version of the v26.1.14 attachment (it was generated correctly by #1824) or regenerate it from the actualv26.1.14tag, then recompute the changes file — it should report 26 new properties and the 3 removed backports.
One coordination note: the What's New page on ga-main-merge now has exhaustive property coverage (8ec82b54) including the changed defaults, both deprecations, and the three not-in-26.2.1 backports — no overlap with this PR's files.
…kports - Restore redpanda-properties-v26.1.14.json to the auto-docs (#1824) version; the generator's --diff run had overwritten it with 26.2 data. - Remove log_eviction_exempt_topics, schema_registry_deferred_recovery, and schema_registry_replay_on_startup from the v26.2.1 attachment and the topic-properties partial: they are v26.1.14-only backports that do not exist in v26.2.1, and they are cluster-scope besides. - Recompute redpanda-property-changes-v26.1.14-to-v26.2.1.json from the corrected attachments: 26 new properties, 3 removed. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
|
@JakeSCahill both defects addressed in 28b1fdb — thanks for the source-verified review.
Root cause, for the record: 🤖 Generated with Claude Code |
Follow-up to #1839, which merged while these fixes were in flight.
Changes
redpanda.storage.mode.implwas invisible: it had no category override, so the generator emitted it in thecategory-othertag region of the topic-properties partial — a region the topic properties page never includes. Categorized it astiered-storage, so it now renders in the Tiered Storage properties section (its anchor is linked from the What's New page merged in docs: reorder What's New per review; mark Tiered Storage v2 as beta #1839).config_refs: the generator documentsdefault_redpanda_storage_mode_tiered_implon the object storage properties page, but three references (in theredpanda.storage.mode/redpanda.storage.mode.imploverride descriptions and the Tiered Storage partial) linked to cluster-properties. Repointed to object-storage-properties.🤖 Generated with Claude Code
Preview pages
redpanda.storage.mode.implnow renders in the Tiered Storage section with a working anchor)default_redpanda_storage_mode_tiered_implanchor, target of the repointed links)