Skip to content

docs: surface redpanda.storage.mode.impl on the topic properties page - #1841

Merged
Feediver1 merged 6 commits into
ga-main-mergefrom
whats-new-reorder-tsv2-beta
Jul 28, 2026
Merged

docs: surface redpanda.storage.mode.impl on the topic properties page#1841
Feediver1 merged 6 commits into
ga-main-mergefrom
whats-new-reorder-tsv2-beta

Conversation

@Feediver1

@Feediver1 Feediver1 commented Jul 28, 2026

Copy link
Copy Markdown
Contributor

Follow-up to #1839, which merged while these fixes were in flight.

Changes

  • redpanda.storage.mode.impl was invisible: it had no category override, so the generator emitted it in the category-other tag region of the topic-properties partial — a region the topic properties page never includes. Categorized it as tiered-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).
  • Repointed stale config_refs: the generator documents default_redpanda_storage_mode_tiered_impl on the object storage properties page, but three references (in the redpanda.storage.mode/redpanda.storage.mode.impl override descriptions and the Tiered Storage partial) linked to cluster-properties. Repointed to object-storage-properties.
  • Regenerated the property partials from v26.2.1 on the merged overrides (includes the v26.1.14 auto-docs override updates that landed via the beta sync).

🤖 Generated with Claude Code

Preview pages

Note: Netlify does not build deploy previews for PRs based on ga-main-merge (non-default base), so no preview exists for the current state. The links below are from the earlier beta-based build and predate the review fixes in 28b1fdb; the review fixes only remove content (three not-in-26.2 property sections and the corrupted baseline diff) and are verified at the source level — tag regions balanced, changes file recomputed (26 new / 3 removed), v26.1.14 attachment byte-identical to base.

@Feediver1
Feediver1 requested a review from a team as a code owner July 28, 2026 17:03
@netlify

netlify Bot commented Jul 28, 2026

Copy link
Copy Markdown

Deploy Preview for redpanda-docs-preview ready!

Name Link
🔨 Latest commit a377a5c
🔍 Latest deploy log https://app.netlify.com/projects/redpanda-docs-preview/deploys/6a68e355f80ca0000847aaf3
😎 Deploy Preview https://deploy-preview-1841--redpanda-docs-preview.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

coderabbitai Bot commented Jul 28, 2026

Copy link
Copy Markdown
Contributor

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

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: 83e4ffe9-466c-45e5-90d4-09f6ef1bd99c

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
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch whats-new-reorder-tsv2-beta

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

Feediver1 and others added 2 commits July 28, 2026 13:10
- 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>
@Feediver1
Feediver1 force-pushed the whats-new-reorder-tsv2-beta branch from df6622e to a377a5c Compare July 28, 2026 17:13
@Feediver1
Feediver1 changed the base branch from beta to ga-main-merge July 28, 2026 17:13
JakeSCahill and others added 3 commits July 28, 2026 18:17
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>

@JakeSCahill JakeSCahill left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

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_size are all absent at v26.1.14 and present at v26.2.1.
  • Removing log_eviction_exempt_topics, schema_registry_deferred_recovery, and schema_registry_replay_on_startup from cluster-properties.adoc is right — they're v26.1.14 backports that do not exist in v26.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 from deprecated-properties.adoc corrects a misclassification. cloud_topics_enabled and space_management_enable_override correctly remain (the latter is still present and is_deprecated: true in 26.2.1).
  • The tiered-storage category fix that surfaces redpanda.storage.mode.impl, the object-storage-properties config_ref path, and the exact-integer bounds (18446744073709551615 instead of the float-rounded …552000) are all improvements.

Defects — please fix

  1. The three removed cluster properties were moved into topic-properties.adoc. They are cluster properties, not topic properties — and they don't exist in v26.2.1 at all, so they shouldn't appear anywhere on the 26.2 line. Please drop these three sections from topic-properties.adoc.
  2. redpanda-properties-v26.1.14.json was regenerated from the wrong source ref. The new version contains 26 properties that don't exist in Redpanda v26.1.14 (verified: e.g. kafka_fetch_read_coalescing_enabled, cloud_topics_leveling_disabled are 26.2-only). This corrupts redpanda-property-changes-v26.1.14-to-v26.2.1.json: its summary goes from newProperties: 26 to newProperties: 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 actual v26.1.14 tag, 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.

@JakeSCahill
JakeSCahill self-requested a review July 28, 2026 17:29
…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>
@Feediver1

Copy link
Copy Markdown
Contributor Author

@JakeSCahill both defects addressed in 28b1fdb — thanks for the source-verified review.

  1. Backports dropped from topic-properties.adoc: all three sections (log_eviction_exempt_topics, schema_registry_deferred_recovery, schema_registry_replay_on_startup) removed; tag regions verified balanced. They were also injected into the v26.2.1 attachment by the same restore logic, so they're removed there too — the 26.2 line no longer documents them anywhere.

  2. v26.1.14 baseline restored to the auto-docs auto-docs: Update property docs for tag v26.1.14 #1824 version, byte-identical to the PR base (the file now drops out of the diff entirely). The changes file is recomputed from the corrected attachments and now reports exactly what you predicted: newProperties: 26, removedProperties: 3 (the three backports), with the changed-defaults/descriptions/types counts recomputed against the true baseline (6/6/4 — the earlier 32/30/30 were artifacts of the corrupted baseline).

Root cause, for the record: doc-tools generate property-docs --tag v26.2.1 --diff v26.1.14 overwrites the old-version attachment during the run and then diffs against its own output — reproduced on doc-tools 5.2.5: even starting from the pristine #1824 baseline, a single run re-corrupts it and reports "No new properties". The changes file in this PR was therefore computed outside the tool (same schema as the v26.1.13→v26.1.14 file). Worth a doc-tools issue so the next release regen doesn't hit this — happy to file it with the repro.

🤖 Generated with Claude Code

@Feediver1
Feediver1 merged commit f8403b3 into ga-main-merge Jul 28, 2026
5 checks passed
@Feediver1
Feediver1 deleted the whats-new-reorder-tsv2-beta branch July 28, 2026 17:38
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