Skip to content

Conversation

@paulohtb6
Copy link
Collaborator

@paulohtb6 paulohtb6 commented Jan 19, 2026

Description

Clarifies the relationship of the newly introduced property log_compaction_tx_batch_removal_enabled and the existing behavior of deletion.retention.ms

Resolves https://redpandadata.atlassian.net/browse/DOC-1380
Review deadline: Jan 26th

Page previews

Checks

  • New feature
  • Content gap
  • Support Follow-up
  • Small fix (typos, links, copyedits, etc)

@paulohtb6 paulohtb6 requested a review from a team as a code owner January 19, 2026 19:36
@netlify
Copy link

netlify bot commented Jan 19, 2026

Deploy Preview for redpanda-docs-preview ready!

Name Link
🔨 Latest commit 78b6873
🔍 Latest deploy log https://app.netlify.com/projects/redpanda-docs-preview/deploys/696fb8aeb063630009ee6dfe
😎 Deploy Preview https://deploy-preview-1551--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
Copy link
Contributor

coderabbitai bot commented Jan 19, 2026

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.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

📝 Walkthrough

Walkthrough

This PR updates documentation across two Redpanda files to describe the transactional control batch removal feature during log compaction. The changes clarify that log_compaction_tx_batch_removal_enabled enables removal of transactional control batches during compaction, explain how delete.retention.ms applies to these markers, and document requirements such as compact cleanup policy compatibility and incompatibility with Tiered Storage. An example configuration command is added along with topic-level configuration notes.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

Suggested reviewers

  • jason-da-redpanda
  • bharathv
  • Feediver1
🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly references the main feature being documented (deletion of expired transaction markers) and directly matches the primary changes made to both documentation files.
Description check ✅ Passed The description provides context (clarification of log_compaction_tx_batch_removal_enabled and delete.retention.ms relationship), references the resolved Jira ticket, includes a review deadline, and checks appropriate categories. However, page previews are not included as specified in the template.
Linked Issues check ✅ Passed The pull request successfully documents the feature for deletion of expired transaction markers in local storage, addressing the core objective of DOC-1380 through updates to two documentation pages with implementation details and configuration guidance.
Out of Scope Changes check ✅ Passed All changes are directly focused on documenting the transaction marker deletion feature. Both documentation files contain related content covering the new log_compaction_tx_batch_removal_enabled property, delete.retention.ms behavior, and Tiered Storage constraints.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

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


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.

❤️ Share

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

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Fix all issues with AI agents
In `@modules/manage/pages/cluster-maintenance/compaction-settings.adoc`:
- Around line 159-175: Add the Tiered Storage limitation to the transactional
control batch removal docs: update the existing NOTE block under Transactional
control batch removal to include a sentence stating that "This feature is not
applied when Tiered Storage is enabled." Reference the relevant property names
(log_compaction_tx_batch_removal_enabled and delete.retention.ms) remain
unchanged; simply append the Tiered Storage limitation to the NOTE or add a
short paragraph immediately after it so the docs match the transactions.adoc
behavior.
🧹 Nitpick comments (1)
modules/develop/pages/transactions.adoc (1)

328-329: Consider using empty brackets for xref to auto-pull section title.

The xref to the compaction settings page includes explicit link text. Per documentation best practices, consider using empty brackets to automatically pull the section title from the target document:

-See xref:manage:cluster-maintenance/compaction-settings.adoc#transactional-control-batch-removal[Transactional control batch removal].
+See xref:manage:cluster-maintenance/compaction-settings.adoc#transactional-control-batch-removal[].

This ensures the link text stays synchronized if the target section title changes.

Based on learnings, this applies to all AsciiDoc files in the repository.

Copy link
Contributor

@WillemKauf WillemKauf left a comment

Choose a reason for hiding this comment

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

Looks great! No notes.

@micheleRP
Copy link
Contributor

@WillemKauf we had this separate ticket that this may hit Cloud. Can you please confirm if this impacts Cloud docs at all?

@WillemKauf
Copy link
Contributor

Can you please confirm if this impacts Cloud docs at all?

No, we shouldn't make mention of this in cloud docs.

Co-authored-by: Michele Cyran <michele@redpanda.com>
@micheleRP
Copy link
Contributor

@paulohtb6: It'd be nice if delete.retention.ms and cleanup.policy were formatted here

Copy link
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.

lgtm!

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.

4 participants