Skip to content

fix(DOC-1959): remove orphaned raft_election_timeout_ms section from cluster properties#1712

Merged
Feediver1 merged 5 commits into
mainfrom
fix/doc-1959-remove-raft-election-timeout-section
May 27, 2026
Merged

fix(DOC-1959): remove orphaned raft_election_timeout_ms section from cluster properties#1712
Feediver1 merged 5 commits into
mainfrom
fix/doc-1959-remove-raft-election-timeout-section

Conversation

@Feediver1
Copy link
Copy Markdown
Contributor

Summary

Follow-up to #1611. Closes out DOC-1959.

PR #1611 added an exclude_from_docs override for raft_election_timeout_ms in docs-data/property-overrides.json. That override succeeded at the source-JSON layer (modules/reference/attachments/redpanda-properties-v26.1.6.json on main no longer contains the property), but the rendered modules/reference/partials/properties/cluster-properties.adoc partial was never regenerated. As a result, the published Cluster Properties page still showed a raft_election_timeout_ms entry, 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

  • On the Netlify deploy preview, navigate to Reference > Properties > Cluster Properties and confirm Ctrl+F raft_election_timeout_ms returns no hits.
  • Confirm election_timeout_ms (the correct user-facing property) is unchanged.

Test plan

  • Netlify build passes
  • grep -rn raft_election_timeout_ms modules/ returns zero hits

🤖 Generated with Claude Code

…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>
@Feediver1 Feediver1 requested a review from a team as a code owner May 26, 2026 15:51
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 26, 2026

Review Change Stack

Important

Review skipped

Auto incremental reviews are disabled on this repository.

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: bf851631-110a-4efe-9010-66f4dc75f8ea

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
📝 Walkthrough

Walkthrough

This pull request removes the documentation section for the raft_election_timeout_ms cluster property from the cluster properties reference file. The deletion eliminates a 47-line documentation block, after which the raft_enable_longest_log_detection property documentation now appears immediately following the quota_manager_gc_sec property entry. The change is a straightforward documentation cleanup with no alterations to code entities or functional definitions.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

  • redpanda-data/docs#1359: Makes adjacent documentation formatting changes in cluster-properties.adoc without modifying property content or semantics.
  • redpanda-data/docs#1620: Modifies cluster property documentation related to cluster-properties.adoc, specifically including adjustments to the raft_election_timeout_ms section.

Suggested reviewers

  • micheleRP
  • joe-redpanda
  • paulohtb6
🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and specifically describes the main change: removing an orphaned raft_election_timeout_ms section from cluster properties documentation.
Description check ✅ Passed The description provides comprehensive context, rationale, and verification steps, though it omits the Jira ticket link and check box selection from the template.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch fix/doc-1959-remove-raft-election-timeout-section

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

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
@netlify
Copy link
Copy Markdown

netlify Bot commented May 26, 2026

Deploy Preview for redpanda-docs-preview ready!

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

Feediver1 and others added 3 commits May 27, 2026 12:35
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>
Copy link
Copy Markdown
Contributor

@micheleRP micheleRP left a comment

Choose a reason for hiding this comment

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

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 main is redpanda-properties-v26.1.8.json and it still contains raft_election_timeout_ms (line 10740). exclude_from_docs doesn'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 (see docs-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.json so the long-term mechanism keeps working.
  • Concrete Verify and Test plan checklists in the PR body.

Copy link
Copy Markdown
Contributor

@micheleRP micheleRP left a comment

Choose a reason for hiding this comment

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

Approving — no critical issues. Suggestions in the prior review comment are optional polish (PR description wording + revert reasoning); feel free to merge.

@Feediver1 Feediver1 merged commit ba1c02f into main May 27, 2026
7 checks passed
@Feediver1 Feediver1 deleted the fix/doc-1959-remove-raft-election-timeout-section branch May 27, 2026 19:50
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.

3 participants