DOC-1378: Compaction robustness #1153
Conversation
✅ Deploy Preview for redpanda-docs-preview ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 3
🧹 Nitpick comments (2)
modules/reference/pages/properties/cluster-properties.adoc (1)
3698-3698: Consider linkingsegment.msto its property reference
The note "Do not set this value lower thansegment.ms." is helpful but could be enhanced by adding a cross-reference to thesegment.msdocumentation (xref:reference:properties/cluster-properties.adoc#log_segment_ms).modules/reference/pages/properties/topic-properties.adoc (1)
45-50: Align alias IDs with existing conventions.The new entries use dots in the alias IDs (
max.compaction.lag.ms/min.compaction.lag.ms), while other properties strip dots from IDs. Consider renaming these tomaxcompactionlagmsandmincompactionlagmsfor consistency.@@ -45,4 +45,4 @@ -| <<max.compaction.lag.ms,`max.compaction.lag.ms`>> +| <<maxcompactionlagms,`max.compaction.lag.ms`>> @@ -48,4 +48,4 @@ -| <<min.compaction.lag.ms,`min.compaction.lag.ms`>> +| <<mincompactionlagms,`min.compaction.lag.ms`>>
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (5)
antora.yml(1 hunks)local-antora-playbook.yml(2 hunks)modules/manage/pages/cluster-maintenance/compaction-settings.adoc(1 hunks)modules/reference/pages/properties/cluster-properties.adoc(2 hunks)modules/reference/pages/properties/topic-properties.adoc(1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (3)
- GitHub Check: Redirect rules - redpanda-docs-preview
- GitHub Check: Header rules - redpanda-docs-preview
- GitHub Check: Pages changed - redpanda-docs-preview
🔇 Additional comments (4)
antora.yml (2)
3-3: Bump Antora version to 25.2
Theversionattribute has been correctly updated from25.1to25.2for this beta release.
4-5: Add beta display metadata
Includingdisplay_version: '25.2 Beta'andprerelease: trueproperly flags this as a pre-release.local-antora-playbook.yml (2)
3-3: Verify start_page target
Thestart_pagehas been updated to25.2@ROOT:get-started:intro-to-events.adoc. Please confirm this is the intended landing page for the 25.2 beta docs.
18-18: Prioritize main branch in sources
Movingmainto the front of thebrancheslist ensures the latest content is served first. This aligns with your version bump.
modules/manage/pages/cluster-maintenance/compaction-settings.adoc
Outdated
Show resolved
Hide resolved
modules/manage/pages/cluster-maintenance/compaction-settings.adoc
Outdated
Show resolved
Hide resolved
|
Important Review skippedAuto incremental reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the You can disable this status message by setting the 📝 WalkthroughWalkthroughThe changes update documentation and configuration files to reflect the introduction of new compaction-related properties in version 25.2 Beta. Specifically, the Antora configuration is updated for the new version and prerelease status, and the playbook is adjusted to use the new version as the start page. Documentation is expanded to include two new cluster and topic-level compaction properties: Sequence Diagram(s)sequenceDiagram
participant User
participant Docs
participant Config
User->>Docs: Access documentation
Docs->>Config: Reference antora.yml and playbook for version info
Docs->>Docs: Display new compaction properties (cluster & topic level)
User->>Docs: View descriptions and cross-references for new properties
Assessment against linked issues
Assessment against linked issues: Out-of-scope changesNo out-of-scope changes found. Suggested reviewers
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
There was a problem hiding this comment.
Actionable comments posted: 3
♻️ Duplicate comments (2)
modules/reference/pages/properties/cluster-properties.adoc (2)
3708-3724: Cross-reference syntax & accepted-values formatting still brokenThe earlier feedback hasn’t been fully applied:
Antora xref syntax is wrong – the link will not render:
(xref:reference:properties/topic-properties.adoc#max.compaction.lag.ms)[max.compaction.lag.ms]should be:
xref:reference:properties/topic-properties.adoc#max.compaction.lag.ms[`max.compaction.lag.ms`]Accepted-values range is wrapped in one code span, losing the two separate literals and missing the closing back-tick after
1:*Accepted values:* [`1, 9223372036854`]should be:
*Accepted values:* [`1`, `9223372036854`]Apply the diff below.
-For a compacted topic, the maximum time a message remains ineligible for compaction. -The topic property (xref:reference:properties/topic-properties.adoc#max.compaction.lag.ms)[max.compaction.lag.ms] overrides this property. +For a compacted topic, the maximum time a message remains ineligible for compaction. +The topic property xref:reference:properties/topic-properties.adoc#max.compaction.lag.ms[`max.compaction.lag.ms`] overrides this property. @@ -*Accepted values:* [`1, 9223372036854`] +*Accepted values:* [`1`, `9223372036854`]
3972-3986: Same formatting issues formin_compaction_lag_msThe same two problems appear here:
(xref:reference:properties/topic-properties.adoc#min.compaction.lag.ms)[min.compaction.lag.ms] *Accepted values:* [`0,9223372036854`]Should be:
xref:reference:properties/topic-properties.adoc#min.compaction.lag.ms[`min.compaction.lag.ms`] *Accepted values:* [`0`, `9223372036854`]Patch:
-For a compacted topic, the minimum time a message remains uncompacted in the log. The topic property (xref:reference:properties/topic-properties.adoc#min.compaction.lag.ms)[min.compaction.lag.ms] overrides this property. +For a compacted topic, the minimum time a message remains uncompacted in the log. +The topic property xref:reference:properties/topic-properties.adoc#min.compaction.lag.ms[`min.compaction.lag.ms`] overrides this property. @@ -*Accepted values:* [`0,9223372036854`] +*Accepted values:* [`0`, `9223372036854`]
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (5)
antora.yml(1 hunks)local-antora-playbook.yml(2 hunks)modules/manage/pages/cluster-maintenance/compaction-settings.adoc(1 hunks)modules/reference/pages/properties/cluster-properties.adoc(2 hunks)modules/reference/pages/properties/topic-properties.adoc(1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)
- GitHub Check: Redirect rules - redpanda-docs-preview
- GitHub Check: Header rules - redpanda-docs-preview
- GitHub Check: Pages changed - redpanda-docs-preview
🔇 Additional comments (2)
local-antora-playbook.yml (2)
3-3: Confirm the 25 .2 landing page exists before merging.
start_page: 25.2@ROOT:get-started:intro-to-events.adocwill 404 in preview builds unless the25.2component version is generated. Double-check that theantora.ymlin this branch is indeed published as25.2(see previous comment) and that the referenced page hasn’t moved.
18-18: Ordering sources is OK – but ensuremainstays mutually exclusive withv/*.Introducing
mainfirst is sensible for beta docs; just be aware that any cherry-picked content that lives only on maintenance branches could now be shadowed. No action required if that’s intentional.
modules/manage/pages/cluster-maintenance/compaction-settings.adoc
Outdated
Show resolved
Hide resolved
modules/manage/pages/cluster-maintenance/compaction-settings.adoc
Outdated
Show resolved
Hide resolved
modules/manage/pages/cluster-maintenance/compaction-settings.adoc
Outdated
Show resolved
Hide resolved
|
@Feediver1 Doc needs to be added for the 2 new topic properties. The other topic properties in this table have links to descriptions later in the page, but these 2 new ones link to nothing. |
|
After that content is added, the links in the cluster properties should go directly into those descriptions, instead of just to the Topic Properties page (e.g., this cluster property should link into the topic property description) |
local-antora-playbook.yml
Outdated
| branches: [main, v/*, api, shared, site-search,'!v-end-of-life/*'] | ||
| - url: https://github.com/redpanda-data/cloud-docs | ||
| branches: 'main' | ||
| branches: 'DOC-1404-Document-new-configurable-property' |
There was a problem hiding this comment.
Revert this before merging
|
@Feediver1: There should also be an addition for this in the What's New! |
micheleRP
left a comment
micheleRP
left a comment
There was a problem hiding this comment.
left some suggestions, but lgtm. Remember to change playbook back to main!
Description
This pull request introduces documentation updates to include new configurable properties for message compaction in Redpanda. These changes add details about
max_compaction_lag_msandmin_compaction_lag_msat both the cluster and topic levels, enhancing clarity and usability for users configuring compaction settings.Updates to compaction-related properties:
Cluster-level properties:
max_compaction_lag_msinmodules/reference/pages/properties/cluster-properties.adoc. This property specifies the maximum time a message remains ineligible for compaction, with details on units, accepted values, and default settings.min_compaction_lag_msinmodules/reference/pages/properties/cluster-properties.adoc. This property defines the minimum time a message remains uncompacted in the log, including its units, accepted values, and default settings.Topic-level properties:
modules/reference/pages/properties/topic-properties.adocto include cross-references formax.compaction.lag.msandmin.compaction.lag.ms, linking them to their corresponding cluster-level properties.Updates to compaction settings documentation:
modules/manage/pages/cluster-maintenance/compaction-settings.adocwith detailed descriptions ofmax_compaction_lag_msandmin_compaction_lag_msfor both cluster and topic levels, explaining their purpose and use cases.Playbook configuration update:
local-antora-playbook.ymlto track theDOC-1404-Document-new-configurable-propertybranch in thecloud-docsrepository, ensuring the documentation aligns with the latest updates.Resolves https://redpandadata.atlassian.net/browse/DOC-1378
Review deadline:
Page previews
Topic Properties
max_compaction_lag_ms
min_compaction_lag_ms
Compaction settings - configuration options
Checks