DOC-422: Clarify log_compression_type behavior #1320
Conversation
|
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 PR updates documentation in two AsciiDoc files:
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Assessment against linked issues
Assessment against linked issues: Out-of-scope changes
Suggested reviewers
✨ Finishing Touches🧪 Generate unit tests
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. CodeRabbit Commands (Invoked using PR/Issue comments)Type Other keywords and placeholders
CodeRabbit Configuration File (
|
✅ 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: 2
🧹 Nitpick comments (3)
modules/reference/pages/properties/cluster-properties.adoc (2)
3765-3767: Avoid implying unsupported options are honoredTo fully meet DOC-422 (“Prefer removing or not listing the other options to avoid implying they are supported”), please either:
- Reduce Accepted Values to only
producer, or- Annotate non-
producervalues as “compatibility only; ignored by broker”.Example (outside changed lines; illustrative AsciiDoc snippet):
*Accepted Values:* `producer`Or:
*Accepted Values:* `producer`. The following values are accepted for Kafka compatibility but ignored by the broker: `gzip`, `snappy`, `lz4`, `zstd`, `none`.
3757-3760: Resolve contradiction between note and descriptionAfter the IMPORTANT note, the description says “Default topic compression type” and references topic override behavior, which reads as if the broker will apply a compression algorithm. That conflicts with the clarified behavior.
Proposed wording (outside changed lines):
- Replace “Default topic compression type.” with: “Default for the Kafka-compatible compression.type property. Redpanda does not recompress data; see note above.”
- Keep the override sentence but add: “The value is used for compatibility only; the broker always preserves producer compression.”
This prevents users from thinking the broker will compress on their behalf.
modules/reference/pages/properties/topic-properties.adoc (1)
372-380: Fix misleading description and values to align with broker behaviorImmediately after the note, the text says “The type of compression algorithm to apply for all messages of a topic…”, which suggests the broker enforces compression. In Redpanda, compression is producer-controlled.
Suggested follow-ups (outside changed lines):
- Replace that first paragraph with: “This property is provided for Kafka compatibility. Redpanda does not enforce or change compression for stored data; configure compression in your producers.”
- In the “Values” list, either list only
produceror annotate the others as “compatibility only; ignored”.Example “Values” block:
**Values**: - `producer` — Use the compression chosen by producers. This is the only value with effect in Redpanda. - `none`, `gzip`, `lz4`, `snappy`, `zstd` — Accepted for Kafka compatibility; ignored by the broker.Also consider adding a brief cross-link to “Configure Producers” for setting producer-side compression.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
💡 Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled by default for public repositories
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (2)
modules/reference/pages/properties/cluster-properties.adoc(1 hunks)modules/reference/pages/properties/topic-properties.adoc(1 hunks)
yeah the override takes place, but it's only for really for migration tooling to look at and see the value was accepted as a topic property |
doc review suggestions Co-authored-by: Kat Batuigas <[email protected]>
Description
Resolves https://redpandadata.atlassian.net/browse/DOC-422
Review deadline: Monday August 18th
Page previews
log_compression_type cluster property
compression.type topic property
Checks