[jira] [Comment Edited] (KAFKA-5460) Documentation on website uses word-breaks resulting in confusion

["Derrick Or (JIRA)" <ji...@apache.org>]

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

Derrick Or edited comment on KAFKA-5460 at 6/23/17 6:05 PM:
------------------------------------------------------------

I totally see how the hyphens make the property names confusing. One quick fix for this is to simply not render hyphens for the first column of tables for now (since this is consistently the column used for property names):

.data-table tr td:first-of-type {
	-ms-hyphens: none;
	-moz-hyphens: none;
	-webkit-hyphens: none;
	hyphens: none;
}

It's up to personal preference, but I think the browser's auto hyphenation of words that are wrapping in paragraph cells like "description" is actually helpful. 

[~tombentley] I like the idea of grouping up some of the columns in that first column using the description lists. However, for tables that include large fields for descriptions I'd consider using a 2 column table where you have your description lists in the left column and property descriptions in the right column. 


was (Author: derrickor):
I totally see how the hyphens make the property names confusing. Once quick fix for this is to simply not render hyphens for the first column of tables for now (since this is consistently the column used for property names):

.data-table tr td:first-of-type {
	-ms-hyphens: none;
	-moz-hyphens: none;
	-webkit-hyphens: none;
	hyphens: none;
}

It's up to personal preference, but I think the browser's auto hyphenation of words that are wrapping in paragraph cells like "description" is actually helpful. 

[~tombentley] I like the idea of grouping up some of the columns in that first column using the description lists. However, for tables that include large fields for descriptions I'd consider using a 2 column table where you have your description lists in the left column and property descriptions in the right column. 

> 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, Screenshot from 2017-06-23 14-45-02.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
(v6.4.14#64029)