Skip to content

Commit 150f09f

Browse files
authored
KAFKA-20519 Fix broken links in configuration option docs (#22127)
Several items in the Kafka docs configuration reference seem to include links to other parts of the documentation that do not work anymore on the new website. This PR updates them in the Java code so that they could be fixed in the next release. It is using the pattern already used for some other configuration otpions, so hopefully it is the correct one. Reviewers: Chia-Ping Tsai <chia7712@gmail.com>
1 parent 1938d32 commit 150f09f

2 files changed

Lines changed: 7 additions & 7 deletions

File tree

clients/src/main/java/org/apache/kafka/common/config/TopicConfig.java

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ public class TopicConfig {
5353
"we would fsync after every message; if it were 5 we would fsync after every five messages. " +
5454
"In general we recommend you not set this and use replication for durability and allow the " +
5555
"operating system's background flush capabilities as it is more efficient. This setting can " +
56-
"be overridden on a per-topic basis (see <a href=\"#topicconfigs\">the per-topic configuration section</a>).";
56+
"be overridden on a per-topic basis (see <a href=\"https://kafka.apache.org/documentation/#topicconfigs\">the per-topic configuration section</a>).";
5757

5858
public static final String FLUSH_MS_CONFIG = "flush.ms";
5959
public static final String FLUSH_MS_DOC = "This setting allows specifying a time interval at which we will " +
@@ -124,7 +124,7 @@ public class TopicConfig {
124124

125125
public static final String DELETE_RETENTION_MS_CONFIG = "delete.retention.ms";
126126
public static final String DELETE_RETENTION_MS_DOC = "The amount of time to retain delete tombstone markers " +
127-
"for <a href=\"#compaction\">log compacted</a> topics. This setting also gives a bound " +
127+
"for <a href=\"https://kafka.apache.org/documentation/#compaction\">log compacted</a> topics. This setting also gives a bound " +
128128
"on the time in which a consumer must complete a read if they begin from offset 0 " +
129129
"to ensure that they get a valid snapshot of the final stage (otherwise delete " +
130130
"tombstones may be collected before they complete their scan).";
@@ -139,7 +139,7 @@ public class TopicConfig {
139139

140140
public static final String MIN_CLEANABLE_DIRTY_RATIO_CONFIG = "min.cleanable.dirty.ratio";
141141
public static final String MIN_CLEANABLE_DIRTY_RATIO_DOC = "This configuration controls how frequently " +
142-
"the log compactor will attempt to clean the log (assuming <a href=\"#compaction\">log " +
142+
"the log compactor will attempt to clean the log (assuming <a href=\"https://kafka.apache.org/documentation/#compaction\">log " +
143143
"compaction</a> is enabled). By default we will avoid cleaning a log where more than " +
144144
"50% of the log has been compacted. This ratio bounds the maximum space wasted in " +
145145
"the log by duplicates (at 50% at most 50% of the log could be duplicates). A " +
@@ -156,7 +156,7 @@ public class TopicConfig {
156156
public static final String CLEANUP_POLICY_DOC = "This config designates the retention policy to " +
157157
"use on log segments. The \"delete\" policy (which is the default) will discard old segments " +
158158
"when their retention time or size limit has been reached. The \"compact\" policy will enable " +
159-
"<a href=\"#compaction\">log compaction</a>, which retains the latest value for each key. " +
159+
"<a href=\"https://kafka.apache.org/documentation/#compaction\">log compaction</a>, which retains the latest value for each key. " +
160160
"It is also possible to specify both policies in a comma-separated list (e.g. \"delete,compact\"). " +
161161
"In this case, old segments will be discarded per the retention time and size configuration, " +
162162
"while retained segments will be compacted. " +
@@ -185,7 +185,7 @@ public class TopicConfig {
185185
"A typical scenario would be to create a topic with a replication factor of 3, " +
186186
"set <code>min.insync.replicas</code> to 2, and produce with <code>acks</code> of \"all\". " +
187187
"This ensures that a majority of replicas must persist a write before it's considered successful by the producer and it's visible to consumers." +
188-
"<p>Note that when the Eligible Leader Replicas feature is enabled, the semantics of this config changes. Please refer to <a href=\"#eligible_leader_replicas\">the ELR section</a> for more info.</p>";
188+
"<p>Note that when the Eligible Leader Replicas feature is enabled, the semantics of this config changes. Please refer to <a href=\"https://kafka.apache.org/documentation/#eligible_leader_replicas\">the ELR section</a> for more info.</p>";
189189

190190
public static final String COMPRESSION_TYPE_CONFIG = "compression.type";
191191
public static final String COMPRESSION_TYPE_DOC = "Specify the final compression type for a given topic. " +

clients/src/main/java/org/apache/kafka/common/config/internals/BrokerSecurityConfigs.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ public class BrokerSecurityConfigs {
5555
" from the client certificate to short name. The rules are evaluated in order and the first rule that matches" +
5656
" a principal name is used to map it to a short name. Any later rules in the list are ignored. By default," +
5757
" distinguished name of the X.500 certificate will be the principal. For more details on the format please" +
58-
" see <a href=\"#security_authz\"> security authorization and acls</a>. Note that this configuration is ignored" +
58+
" see <a href=\"https://kafka.apache.org/documentation/#security_authz\"> security authorization and acls</a>. Note that this configuration is ignored" +
5959
" if an extension of KafkaPrincipalBuilder is provided by the <code>" + PRINCIPAL_BUILDER_CLASS_CONFIG + "</code>" +
6060
" configuration.";
6161

@@ -65,7 +65,7 @@ public class BrokerSecurityConfigs {
6565
"names to short names (typically operating system usernames). The rules are evaluated in order and the " +
6666
"first rule that matches a principal name is used to map it to a short name. Any later rules in the list are " +
6767
"ignored. By default, principal names of the form <code>{username}/{hostname}@{REALM}</code> are mapped " +
68-
"to <code>{username}</code>. For more details on the format please see <a href=\"#security_authz\"> " +
68+
"to <code>{username}</code>. For more details on the format please see <a href=\"https://kafka.apache.org/documentation/#security_authz\"> " +
6969
"security authorization and acls</a>. Note that this configuration is ignored if an extension of " +
7070
"<code>KafkaPrincipalBuilder</code> is provided by the <code>" + PRINCIPAL_BUILDER_CLASS_CONFIG + "</code> configuration.";
7171

0 commit comments

Comments
 (0)