MINOR: Fix incorrect config name and stale links in Log Compaction docs#21942
Open
fru1tworld wants to merge 1 commit intoapache:trunkfrom
Open
MINOR: Fix incorrect config name and stale links in Log Compaction docs#21942fru1tworld wants to merge 1 commit intoapache:trunkfrom
fru1tworld wants to merge 1 commit intoapache:trunkfrom
Conversation
The Log Compaction section incorrectly advised using the broker-level
`log.cleanup.policy` to enable compaction on a particular topic. The
correct topic-level property is `cleanup.policy`. This also resolves
the self-contradiction where the next paragraph described
`log.cleanup.policy` as a broker configuration.
Additionally, replace legacy `/documentation.html#brokerconfigs` links
with the current Hugo-based `/{version}/configuration/broker-configs`
pattern.
|
A label of 'needs-attention' was automatically added to this PR in order to raise the |
|
A label of 'needs-attention' was automatically added to this PR in order to raise the |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The Log Compaction section incorrectly advised using the broker-level
log.cleanup.policyto enable compaction on a particular topic.The correct topic-level property is
cleanup.policy. This also resolves the self-contradiction where the next paragraph describedlog.cleanup.policyas a broker configuration.Additionally, replace legacy
/documentation.html#brokerconfigslinkswith the current Hugo-based
/{version}/configuration/broker-configspattern.
Changes
docs/design/design.md: Replacelog.cleanup.policy=compactwithcleanup.policy=compactin the per-topic configuration examplekafka-configs.shlog.cleanup.policyand the topic-levelcleanup.policy/documentation.html#brokerconfigslinks to/{version}/configuration/broker-configsTesting
Documentation-only change. Verified with
./gradlew siteDocsTar --dry-run(BUILD SUCCESSFUL). Confirmed the property names match the source code:TopicConfig.CLEANUP_POLICY_CONFIG = "cleanup.policy"(topic-level)ServerLogConfigs.LOG_CLEANUP_POLICY_CONFIG/LOG_CLEANUP_POLICY_DEFAULT = "delete"(broker-level default)