[KAFKA-10801] Docs on configuration have multiple places using the same HTML anchor tag

• Type: Improvement
• Status: Resolved
• Priority: Minor
• Resolution: Fixed
• Affects Version/s: 2.6.0, 2.5.1
• Fix Version/s: 2.7.0
• Component/s: documentation
• Assignee: Unassigned
• Reporter: James Cheng
• Created: 03/Dec/20 01:50
• Updated: 03/Dec/20 10:21
• Resolved: 03/Dec/20 08:37

Description

The configuration option "compression.type" is a configuration option on the Kafka Producer as well as on the Kafka brokers.

 

The same HTML anchor #compression.type is used on both of those entries. So if you click or bookmark the link http://kafka.apache.org/documentation/#compression.type , it will always bring you to the first entry (the broker-side config). It will never bring you to the 2nd entry (producer config).

 

I've only noticed this for the compression.type config, but it is possible that it also applies to any other config option that is the same between the broker/producer/consumer.

 

We should at least fix it for compression.type, and we should possibly fix it across the entire document.