fix(DOC-1959): remove orphaned raft_election_timeout_ms section from cluster properties#1712
Conversation
…roperties partial Follow-up to #1611. The PR added an `exclude_from_docs` override for `raft_election_timeout_ms` in `docs-data/property-overrides.json`, which correctly removed the property from the source v26.1.6 attachment JSON. However, the rendered `cluster-properties.adoc` partial was never regenerated, so the property still appeared on the published cluster properties page. Delete the orphaned section directly. Future auto-docs regeneration runs will preserve the deletion because the source JSON no longer contains the property. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
|
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 pull request removes the documentation section for the Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Possibly related PRs
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 |
Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
✅ Deploy Preview for redpanda-docs-preview ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Restore the deep-link anchor for users with bookmarks or external links to cluster-properties#raft_election_timeout_ms. The anchor lands on a short note explaining that this is the internal C++ variable name and directing readers to the user-facing election_timeout_ms property. Placed in the parent page (not the auto-generated partial) so it survives future partial regeneration runs. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
This reverts commit fc1fcc4.
micheleRP
left a comment
There was a problem hiding this comment.
Review
Final-pass review for #1712. Fix is correct and minimal — the deletion accomplishes the user-facing goal and breaks no xrefs. Two notes below on the PR description and a UX question.
Suggestions
1. PR description has two inaccurate technical claims
-
"the override succeeded at the source-JSON layer (v26.1.6 JSON no longer contains the property)" — the current source JSON on
mainisredpanda-properties-v26.1.8.jsonand it still containsraft_election_timeout_ms(line 10740).exclude_from_docsdoesn't strip properties from the source JSON; it operates at the partial-generation layer. -
"Future auto-docs regeneration runs will preserve the deletion because the source v26.1.6 JSON no longer contains the property." — the next auto-docs run will re-add the section to the partial, but wrapped in
// tag::exclude-from-docs[]/// end::exclude-from-docs[]markers (seedocs-extensions-and-macros/tools/property-extractor/templates/property.hbs). The consumer page (modules/reference/pages/properties/cluster-properties.adoc:13) filters tagged content out at include time via[tags=!deprecated;!exclude-from-docs], so the published page stays clean — but the partial file itself will show the section reappearing in the next auto-docs diff.
The current partial on main has the section without tag wrappers because auto-docs hasn't run since #1611 was merged (last auto-docs run was for v26.1.9 earlier that day, before #1611 landed). That's why the manual deletion was needed.
Suggested rewording for the description so the next reviewer doesn't think auto-docs has regressed:
Future auto-docs regeneration runs will re-add the section, but wrapped in
// tag::exclude-from-docs[]markers that the consumer page filters out via[tags=!exclude-from-docs]. The deletion is a stopgap until that regeneration runs.
2. Stale-bookmark UX
Commit fc1fcc4 added a soft-redirect anchor on the parent page, then 67f68bc reverted it with no reasoning in the commit message. Worth a one-line note on why the anchor was pulled — or consider re-adding it so users who bookmarked cluster-properties#raft_election_timeout_ms land on a brief note pointing to election_timeout_ms instead of the page top.
Impact on other files
No updates required. Confirmed via git ls-files | xargs grep -l raft_election_timeout_ms — the only remaining references are the source JSON (correctly retained), docs-data/property-overrides.json (the override entry), and the partial itself. No xref: to the removed anchor exists in docs, cloud-docs, or rp-connect-docs. PR #1611 already corrected the user-facing election_timeout_ms entry, so no related-page updates are needed and no What's New entry is warranted (removing incorrect content, not announcing a change).
What works well
- Minimal, targeted change (single file, 0 additions / 47 deletions).
- No code paths or behavior touched.
- Leaves the override in
property-overrides.jsonso the long-term mechanism keeps working. - Concrete Verify and Test plan checklists in the PR body.
micheleRP
left a comment
There was a problem hiding this comment.
Approving — no critical issues. Suggestions in the prior review comment are optional polish (PR description wording + revert reasoning); feel free to merge.
Summary
Follow-up to #1611. Closes out DOC-1959.
PR #1611 added an
exclude_from_docsoverride forraft_election_timeout_msindocs-data/property-overrides.json. That override succeeded at the source-JSON layer (modules/reference/attachments/redpanda-properties-v26.1.6.jsononmainno longer contains the property), but the renderedmodules/reference/partials/properties/cluster-properties.adocpartial was never regenerated. As a result, the published Cluster Properties page still showed araft_election_timeout_msentry, leaving DOC-1959 unsatisfied.This PR deletes the orphaned 47-line section directly from the partial. Future auto-docs regeneration runs will preserve the deletion because the source v26.1.6 JSON no longer contains the property.
Verify
Ctrl+F raft_election_timeout_msreturns no hits.election_timeout_ms(the correct user-facing property) is unchanged.Test plan
grep -rn raft_election_timeout_ms modules/returns zero hits🤖 Generated with Claude Code