Repository: kafka Updated Branches: refs/heads/0.10.2 a9f4b671f -> 8488b81a5
MINOR: Use API hyperlinks in 'Kafka Protocol Guide' to facilitate navigation Finding the protocol associated with an API key can be a challenge in the lengthy [web page](http://kafka.apache.org/protocol.html#protocol_api_keys). Adding hyperlinks would definitely help with that. Co-authored with imandhan. Author: Vahid Hashemian <[email protected]> Reviewers: Ewen Cheslack-Postava <[email protected]> Closes #2467 from vahidhashemian/minor/hyperlinks_in_kafka_protocol_guide (cherry picked from commit 5b682baad546e41fe7aa27be0865ea6adaca2d2a) Signed-off-by: Ewen Cheslack-Postava <[email protected]> Project: http://git-wip-us.apache.org/repos/asf/kafka/repo Commit: http://git-wip-us.apache.org/repos/asf/kafka/commit/8488b81a Tree: http://git-wip-us.apache.org/repos/asf/kafka/tree/8488b81a Diff: http://git-wip-us.apache.org/repos/asf/kafka/diff/8488b81a Branch: refs/heads/0.10.2 Commit: 8488b81a52e32c4efcec16c05efa6ab9ed0d3c87 Parents: a9f4b67 Author: Vahid Hashemian <[email protected]> Authored: Sat Feb 25 18:44:32 2017 -0800 Committer: Ewen Cheslack-Postava <[email protected]> Committed: Sat Feb 25 18:45:15 2017 -0800 ---------------------------------------------------------------------- .../src/main/java/org/apache/kafka/common/protocol/ApiKeys.java | 2 +- .../src/main/java/org/apache/kafka/common/protocol/Protocol.java | 3 ++- 2 files changed, 3 insertions(+), 2 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/kafka/blob/8488b81a/clients/src/main/java/org/apache/kafka/common/protocol/ApiKeys.java ---------------------------------------------------------------------- diff --git a/clients/src/main/java/org/apache/kafka/common/protocol/ApiKeys.java b/clients/src/main/java/org/apache/kafka/common/protocol/ApiKeys.java index 239780c..614f12f 100644 --- a/clients/src/main/java/org/apache/kafka/common/protocol/ApiKeys.java +++ b/clients/src/main/java/org/apache/kafka/common/protocol/ApiKeys.java @@ -89,7 +89,7 @@ public enum ApiKeys { for (ApiKeys key : ApiKeys.values()) { b.append("<tr>\n"); b.append("<td>"); - b.append(key.name); + b.append("<a href=\"#The_Messages_" + key.name + "\">" + key.name + "</a>"); b.append("</td>"); b.append("<td>"); b.append(key.id); http://git-wip-us.apache.org/repos/asf/kafka/blob/8488b81a/clients/src/main/java/org/apache/kafka/common/protocol/Protocol.java ---------------------------------------------------------------------- diff --git a/clients/src/main/java/org/apache/kafka/common/protocol/Protocol.java b/clients/src/main/java/org/apache/kafka/common/protocol/Protocol.java index b04587f..032e00e 100644 --- a/clients/src/main/java/org/apache/kafka/common/protocol/Protocol.java +++ b/clients/src/main/java/org/apache/kafka/common/protocol/Protocol.java @@ -1176,10 +1176,11 @@ public class Protocol { for (ApiKeys key : ApiKeys.values()) { // Key b.append("<h5>"); + b.append("<a name=\"The_Messages_" + key.name + "\">"); b.append(key.name); b.append(" API (Key: "); b.append(key.id); - b.append("):</h5>\n\n"); + b.append("):</a></h5>\n\n"); // Requests b.append("<b>Requests:</b><br>\n"); Schema[] requests = REQUESTS[key.id];
