You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@kafka.apache.org by mi...@apache.org on 2020/02/12 17:45:55 UTC
[kafka] branch 2.5 updated: KAFKA-9423: Refine layout of
configuration options on website and make individual settings directly
linkable (#7955)
This is an automated email from the ASF dual-hosted git repository.
mimaison pushed a commit to branch 2.5
in repository https://gitbox.apache.org/repos/asf/kafka.git
The following commit(s) were added to refs/heads/2.5 by this push:
new 93a4820 KAFKA-9423: Refine layout of configuration options on website and make individual settings directly linkable (#7955)
93a4820 is described below
commit 93a4820488857dcabb2763a5db0bd7f5b8013f17
Author: Sönke Liebau <so...@opencore.com>
AuthorDate: Mon Feb 10 19:05:17 2020 +0100
KAFKA-9423: Refine layout of configuration options on website and make individual settings directly linkable (#7955)
Reviewers: Mickael Maison <mi...@gmail.com>
---
.../org/apache/kafka/common/config/ConfigDef.java | 26 +++++++++++++---------
.../test/scala/unit/kafka/log/LogConfigTest.scala | 2 +-
2 files changed, 16 insertions(+), 12 deletions(-)
diff --git a/clients/src/main/java/org/apache/kafka/common/config/ConfigDef.java b/clients/src/main/java/org/apache/kafka/common/config/ConfigDef.java
index 43ab70d..469476d 100644
--- a/clients/src/main/java/org/apache/kafka/common/config/ConfigDef.java
+++ b/clients/src/main/java/org/apache/kafka/common/config/ConfigDef.java
@@ -1453,19 +1453,20 @@ public class ConfigDef {
List<ConfigKey> configs = sortedConfigs();
StringBuilder b = new StringBuilder();
b.append("<ul class=\"config-list\">\n");
-
for (ConfigKey key : configs) {
if (key.internalConfig) {
continue;
}
- b.append("<li>");
- b.append("<b>");
- b.append(key.name);
- b.append("</b>: ");
- b.append(key.documentation);
- b.append("<br/>");
- // details
- b.append("<ul class=\"horizontal-list\">");
+ b.append("<li>\n");
+ b.append(String.format("<h4>" +
+ "<a id=\"%1$s\" href=\"#%1$s\">%1$s</a>" +
+ "</h4>%n", key.name));
+ b.append("<p>");
+ b.append(key.documentation.replaceAll("\n", "<br>"));
+ b.append("</p>\n");
+
+ b.append("<table>" +
+ "<tbody>\n");
for (String detail : headers()) {
if (detail.equals("Name") || detail.equals("Description")) continue;
addConfigDetail(b, detail, getConfigValue(key, detail));
@@ -1476,7 +1477,7 @@ public class ConfigDef {
updateMode = "read-only";
addConfigDetail(b, "Update Mode", updateMode);
}
- b.append("</ul>");
+ b.append("</tbody></table>\n");
b.append("</li>\n");
}
b.append("</ul>\n");
@@ -1484,7 +1485,10 @@ public class ConfigDef {
}
private static void addConfigDetail(StringBuilder builder, String name, String value) {
- builder.append("<li><b>" + name + "</b>: " + value + "</li>");
+ builder.append("<tr>" +
+ "<th>" + name + ":</th>" +
+ "<td>" + value + "</td>" +
+ "</tr>\n");
}
}
diff --git a/core/src/test/scala/unit/kafka/log/LogConfigTest.scala b/core/src/test/scala/unit/kafka/log/LogConfigTest.scala
index 556810e..809b5df 100644
--- a/core/src/test/scala/unit/kafka/log/LogConfigTest.scala
+++ b/core/src/test/scala/unit/kafka/log/LogConfigTest.scala
@@ -127,7 +127,7 @@ class LogConfigTest {
@Test
def testToHtml(): Unit = {
val html = LogConfig.configDefCopy.toHtml
- val expectedConfig = "<li><b>file.delete.delay.ms</b>"
+ val expectedConfig = "<h4><a id=\"file.delete.delay.ms\" href=\"#file.delete.delay.ms\">file.delete.delay.ms</a></h4>"
assertTrue(s"Could not find `$expectedConfig` in:\n $html", html.contains(expectedConfig))
}