merlimat closed pull request #2026: Fixup misleading text in compaction cookbook
URL: https://github.com/apache/incubator-pulsar/pull/2026
This is a PR merged from a forked repository.
As GitHub hides the original diff on merge, it is displayed below for
the sake of provenance:
As this is a foreign pull request (from a fork), the diff is supplied
below (as it won't show otherwise due to GitHub magic):
diff --git a/site/docs/latest/cookbooks/compaction.md
b/site/docs/latest/cookbooks/compaction.md
index 035dfd4ff0..df76fa0d41 100644
--- a/site/docs/latest/cookbooks/compaction.md
+++ b/site/docs/latest/cookbooks/compaction.md
@@ -11,7 +11,7 @@ To use compaction:
* Compaction can be configured to run [automatically](#automatic), or you can
manually [trigger](#trigger) compaction using the Pulsar administrative API.
* Your {% popover consumers %} must be [configured](#config) to read from
compacted topics ([Java consumers](#java), for example, have a `readCompacted`
setting that must be set to `true`). If this configuration is not set,
consumers will still be able to read from the non-compacted topic.
-{% include admonition.html type="warning" content="Compaction only works on
messages that have keys (as in the stock ticker example the stock symbol serves
as the key for each message). Keys can thus be thought of as the axis along
which compaction is applied. Messages that don't have keys are simply ignored
by compaction." %}
+{% include admonition.html type="warning" content="Compaction only works on
messages that have keys (as in the stock ticker example the stock symbol serves
as the key for each message). Keys can thus be thought of as the axis along
which compaction is applied. Messages that don't have keys are left untouched
by compaction, and retained in final compacted topic." %}
## When should I use compacted topics? {#when}
@@ -122,4 +122,4 @@ Message<byte[]> msg = MessageBuilder.create()
.build();
compactedTopicProducer.send(msg);
-```
\ No newline at end of file
+```
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
[email protected]
With regards,
Apache Git Services
