[improve][doc] Improve defaultRetentionTimeInMinutes and defaultRetentionSizeInMB doc #16824
Conversation
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
codelipenghui
added
the
doc
AnonHxy
force-pushed
the
doc_default_retention
branch
4 times, most recently
from
96f338c to
22e8aca
Compare
Anonymitaet
reviewed
Aug 10, 2022
Anonymitaet
approved these changes
Aug 10, 2022
Member
Anonymitaet
left a comment
Anonymitaet
left a comment
There was a problem hiding this comment.
Thanks for your contribution! LGTM from the technical writing perspective 😊
AnonHxy
force-pushed
the
doc_default_retention
branch
2 times, most recently
from
eef9716 to
7d412b4
Compare
codelipenghui
approved these changes
Aug 24, 2022
Contributor
Author
|
/pulsarbot run-failure-checks |
AnonHxy
force-pushed
the
doc_default_retention
branch
from
7d412b4 to
80a576b
Compare
Nicklee007
pushed a commit
to Nicklee007/pulsar
that referenced
this pull request
Aug 29, 2022
…tionSizeInMB doc (apache#16824) * Improve retention doc * address comment
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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.
Motivation
There is only a simple word
Default message retention time/sizeondefaultRetentionTimeInMinutes=0anddefaultRetentionSizeInMB=0in broker.conf.I think it is not clear for users because
0and-1are both special numbers but have different meaning here. It is easliy that new users maybe mistaken thought a value of0means limit as "infinite" size quota , but in fact direct opposite.Modifications
defaultRetentionTimeInMinutesanddefaultRetentionSizeInMBdoc on *.conf and *.md andServiceConfiguration.javaVerifying this change
Documentation
Check the box below or label this PR directly.
Need to update docs?
doc-required(Your PR needs to update docs and you will update later)
doc-not-needed(Please explain why)
doc(Your PR contains doc changes)
doc-complete(Docs have been already added)