[
https://issues.apache.org/jira/browse/KAFKA-5686?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16531566#comment-16531566
]
ASF GitHub Bot commented on KAFKA-5686:
---------------------------------------
omkreddy closed pull request #3683: KAFKA-5686: update compression docs
URL: https://github.com/apache/kafka/pull/3683
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/docs/design.html b/docs/design.html
index 564df386db7..489cb1bbe63 100644
--- a/docs/design.html
+++ b/docs/design.html
@@ -136,7 +136,7 @@ <h4><a id="design_compression"
href="#design_compression">End-to-end Batch Compr
Kafka supports this with an efficient batching format. A batch of messages
can be clumped together compressed and sent to the server in this form. This
batch of messages will be written in compressed form and will
remain compressed in the log and will only be decompressed by the consumer.
<p>
- Kafka supports GZIP, Snappy and LZ4 compression protocols. More details on
compression can be found <a
href="https://cwiki.apache.org/confluence/display/KAFKA/Compression";>here</a>.
+ Kafka supports GZIP, Snappy and LZ4 compression protocols. Compression
related config properties can be found in the <a href="#brokerconfigs">Broker
configs</a> and <a href="#producerconfigs">Producer configs</a> sections.
<h3><a id="theproducer" href="#theproducer">4.4 The Producer</a></h3>
----------------------------------------------------------------
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:
us...@infra.apache.org
> Documentation inconsistency on the "Compression"
> ------------------------------------------------
>
> Key: KAFKA-5686
> URL: https://issues.apache.org/jira/browse/KAFKA-5686
> Project: Kafka
> Issue Type: Bug
> Components: documentation
> Affects Versions: 0.11.0.0
> Reporter: Seweryn Habdank-Wojewodzki
> Assignee: Manikumar
> Priority: Minor
>
> At the page:
> https://kafka.apache.org/documentation/
> There is a sentence:
> {{Kafka supports GZIP, Snappy and LZ4 compression protocols. More details on
> compression can be found here.}}
> Especially link under the word *here* is describing very old compression
> settings, which is false in case of version 0.11.x.y.
> JAVA API:
> Also it would be nice to clearly state if *compression.type* uses only case
> sensitive String as a value or if it is recommended to use e.g.
> {{CompressionType.GZIP.name}} for JAVA API.
--
This message was sent by Atlassian JIRA
(v7.6.3#76005)
