Skip to content

CASSANDRA-21331: Improve incremental repair documentation clarity#4881

Open
dybyte wants to merge 2 commits into
apache:trunkfrom
dybyte:dybyte/CASSANDRA-21331/trunk
Open

CASSANDRA-21331: Improve incremental repair documentation clarity#4881
dybyte wants to merge 2 commits into
apache:trunkfrom
dybyte:dybyte/CASSANDRA-21331/trunk

Conversation

@dybyte

@dybyte dybyte commented Jun 15, 2026

Copy link
Copy Markdown

This PR improves the incremental repair documentation for CASSANDRA-21331.

It:

  • explains why enabling incremental repair on an existing cluster can create significant anticompaction load
  • clarifies how the first incremental repair differs from a full repair
  • adds a direct anchor for the anticompaction reference in the compaction overview docs

Validation:

  • ran ./.build/sh/ai-build

No CHANGES.txt entry is needed because this is a documentation-only change.

dybyte added 2 commits June 15, 2026 18:43
Patch by dybyte; reviewed by TBD for CASSANDRA-21331
Patch by dybyte; reviewed by TBD for CASSANDRA-21331

Copilot AI 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.

Pull request overview

This documentation-only PR improves the operator guidance around enabling incremental repair on existing clusters by clarifying why the first run can be expensive (anticompaction load) and how the first incremental repair differs from a full repair. It also adds a direct anchor in the compaction overview docs so incremental-repair docs can link precisely to the anticompaction explanation.

Changes:

  • Added an explicit #anticompaction anchor in the compaction overview documentation.
  • Expanded incremental repair guidance to explain anticompaction-related load when enabling incremental repair on existing clusters.
  • Clarified that the first incremental repair still compares the full unrepaired dataset, but (unlike full repair) updates incremental repair state for subsequent runs.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.

File Description
doc/modules/cassandra/pages/managing/operating/compaction/overview.adoc Adds a dedicated #anticompaction anchor to enable direct cross-references.
doc/modules/cassandra/pages/managing/operating/auto_repair.adoc Improves incremental repair documentation clarity and updates links to the new anticompaction anchor.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants