kafka-jira mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Tom Bentley (JIRA)" <j...@apache.org>
Subject [jira] [Commented] (KAFKA-5460) Documentation on website uses word-breaks resulting in confusion
Date Thu, 22 Jun 2017 14:23:00 GMT

    [ https://issues.apache.org/jira/browse/KAFKA-5460?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16059457#comment-16059457

Tom Bentley commented on KAFKA-5460:

bq. I wouldn't recommend switching to <dl/> in this case because, there up to 6 columns
on the documentation page. dt/dd pairs are good for replacing tables with 2 columns.

I was thinking that the config property name would be the <dt>, and within the <dd>
things like the default, type, and valid values could be like key: value pairs, followed by
the actual documentation. So it would look, very approximately, like this:

  _importance:_ high
  _type:_ boolean
  _default:_ true
  Enable auto creation of topic on the server.

This would leave plenty of horizontal space for both the config property name and the documentation.
It would also solve the problem of not being able to see the table headings when part way
down a long table, since the key-value pairs are self describing.

> Documentation on website uses word-breaks resulting in confusion
> ----------------------------------------------------------------
>                 Key: KAFKA-5460
>                 URL: https://issues.apache.org/jira/browse/KAFKA-5460
>             Project: Kafka
>          Issue Type: Bug
>            Reporter: Karel Vervaeke
>         Attachments: Screen Shot 2017-06-16 at 14.45.40.png
> Documentation seems to suggest there is a configuration property auto.off-set.reset but
it really is auto.offset.reset.
> We should look into disabling the word-break css properties (globally or at least in
the configuration reference tables)

This message was sent by Atlassian JIRA

View raw message