[
https://issues.apache.org/jira/browse/KAFKA-8633?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16881135#comment-16881135
]
ASF GitHub Bot commented on KAFKA-8633:
---------------------------------------
weichuliu commented on pull request #7056: KAFKA-8633: Fix Auto Generated Kafka
Configuration Docs
URL: https://github.com/apache/kafka/pull/7056
*More detailed description of your change,
This PR fixes 2 things for auto-generated Kafka documents, namely
configuration table part.
1. Remove the duplicated /td tag.
2. Change angle brackets in some description into square brackets, so
browsers can display properly.
*Summary of testing strategy (including rationale)
for the feature or bug fix. Unit and/or integration
tests are expected for any behaviour change and
system tests should be considered for larger changes.*
### Committer Checklist (excluded from commit message)
- [ ] Verify design and implementation
- [ ] Verify test coverage and CI build status
- [ ] Verify documentation (including upgrade notes)
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to 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
> Extra </td> in generated documents
> ----------------------------------
>
> Key: KAFKA-8633
> URL: https://issues.apache.org/jira/browse/KAFKA-8633
> Project: Kafka
> Issue Type: Task
> Components: documentation
> Reporter: Weichu Liu
> Priority: Trivial
>
> The auto generated tables for all configurations (e.g.
> https://kafka.apache.org/documentation/#brokerconfigs) are with 2 </td> for
> each cell.
> e.g. the first row for broker configuration.
> {noformat}
> <tr>
> <td>zookeeper.connect</td></td><td>Specifies the ZooKeeper connection string
> in the form <code>hostname:port</code> where host and port are the host and
> port of a ZooKeeper server. To allow connecting through other ZooKeeper nodes
> when that ZooKeeper machine is down you can also specify multiple hosts in
> the form <code>hostname1:port1,hostname2:port2,hostname3:port3</code>.
> The server can also have a ZooKeeper chroot path as part of its ZooKeeper
> connection string which puts its data under some path in the global ZooKeeper
> namespace. For example to give a chroot path of <code>/chroot/path</code> you
> would give the connection string as
> <code>hostname1:port1,hostname2:port2,hostname3:port3/chroot/path</code>.</td></td><td>string</td></td><td></td></td><td></td></td><td>high</td></td><td>read-only</td></tr>
> {noformat}
> This is due to {{toHtmlTable}} function in
> {{./clients/src/main/java/org/apache/kafka/common/config/ConfigDef.java}} is
> appending an extra "</td>" in the code.
> {code:java}
> for (String headerName : headers()) {
> addColumnValue(b, getConfigValue(key, headerName));
> b.append("</td>");
> }
> {code}
> (The addColumnValue already wrap the value with <td> and </td>)
> This is very minor issue, but it will prevent an html parser to properly
> fetch table data (like what I was trying to do)
--
This message was sent by Atlassian JIRA
(v7.6.3#76005)
