fix: regenerate property docs with corrected property names (DOC-2351 follow-up) - #1884
fix: regenerate property docs with corrected property names (DOC-2351 follow-up)#1884JakeSCahill wants to merge 1 commit into
Conversation
… follow-up) Regenerate v26.2.1 property docs with docs-extensions-and-macros 5.3.5, which derives property names from the registered name literal instead of the C++ member identifier. Removes 13 wrong or duplicate property names and adds their correct counterparts. Also remove the property-overrides entry for leader_balancer_node_mute_timeout. Redpanda registers both leader-balancer mute members under the same leader_balancer_mute_timeout key, so the node variant was never a settable property. Its semantics are folded into leader_balancer_mute_timeout. Repoint the three config_ref macros in the Tiered Storage partial from cloud_storage_cache_check_interval_ms to the real name.
✅ Deploy Preview for redpanda-docs-preview ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
Warning Review limit reached
Next review available in: 49 minutes You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository. How can I continue?After more reviews become available, a review can be triggered using the To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews. How do review limits work?CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability. For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window. Please refer docs for additional details. Review details⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (7)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
|
Source verification addendum, prompted by review discussion: Every rename is confirmed against registered name literals in the Redpanda source at v26.2.1 ( The three override-injected properties are a deliberate lead-ahead: |
1 participant
Follow-up to DOC-2351 (related: DOC-1889): the property extractor regression that produced
default_topic_replicationmisnamed other properties too, and those stayed wrong in the published reference until a regeneration with the fixed extractor. This PR is that regeneration.Changes
Regenerated the v26.2.1 property docs with docs-extensions-and-macros 5.3.5, which includes the extractor fix (docs-extensions-and-macros#233, merged 2026-07-31) that derives property names from the registered name string literal in the source instead of the C++ member identifier.
Removed 14 wrong or phantom property names (verified against
configuration.cc,kafka/client/configuration.ccat v26.2.1):sampled_memory_profile,kafka_tcp_keepalive_idle_timeout_seconds,cloud_storage_cache_check_interval_ms,cloud_storage_manifest_cache_ttl_ms,retry_base_backoff,produce_batch_delay,produce_shutdown_delay, sixconsumer_*names missing their_ms/_secsuffix, andleader_balancer_node_mute_timeout(see below). Several of these had appeared alongside their correctly named twins, so the reference documented the same property twice under two names.Added the correct counterparts:
memory_enable_memory_sampling,kafka_tcp_keepalive_timeout,cloud_storage_cache_check_interval,cloud_topics_indexing_interval, plus three properties injected fromproperty-overrides.jsonfor backports (log_eviction_exempt_topics,schema_registry_deferred_recovery,schema_registry_replay_on_startup, introduced v26.1.14).cloud_storage_manifest_cache_ttl_msneeded no counterpart because its registered name,cloud_storage_materialized_manifest_ttl_ms, was already documented.Dropped the
leader_balancer_node_mute_timeoutoverride entry. Redpanda registers both leader-balancer mute members under the sameleader_balancer_mute_timeoutname string (configuration.cc:3526-3534), so the node variant was never a settable key. Documenting it invites the same silent misconfiguration that motivated DOC-2351. Its node-mute semantics are folded into theleader_balancer_mute_timeoutdescription.Repointed the three
config_ref:macros in the Tiered Storage partial fromcloud_storage_cache_check_interval_msto the real name. A repo-wide sweep found no other prose or xref references to any removed name.Validation
k-crd.adocattribute notices on main).config_reflinks resolve to#cloud_storage_cache_check_interval, andleader_balancer_node_mute_timeoutis gone from the built cluster properties page.redpanda.remote.allowgaps,redpanda.virtual.cluster.id) unchanged by this PR.🤖 Generated with Claude Code