[jira] [Commented] (NIFI-434) Improve formatting of machine generated component documentation

["Dan Bress (JIRA)" <ji...@apache.org>]

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

Dan Bress commented on NIFI-434:
--------------------------------

[~joewitt] [~mcgilman] Just updated the CSS for the documentation.  Let me know if you think this looks better.  I made two changes:
# Changed "Valid Values" to "Allowable Values"
# Changed the "name" "default" and "allowable" columns to not break on spaces.  The net result of this, is what I *think* Joe wanted.

The reason I went with this approach for #2 is, there are 2 approaches to sizing the widths of the column
# auto, which is what I am using, lets the browser auto size the columns based on the text that is filling them.  It was set to wrap text on spaces
# fixed, which requires a developer to "guess" what width will be best for all processors.  In my opinion, this resulted in some columns being too wide when there was no text, or minimal text in them.

So I chose to stick with the auto size way, and change the way word breaking happens.  Let me know how this looks to you.  You can see some differences here:
[Before|http://danbress.github.io/generated-documentation/components-03192015/org.apache.nifi.processors.standard.EvaluateRegularExpression/index.html]
[After|http://danbress.github.io/generated-documentation/components-03232015/files/org.apache.nifi.processors.standard.EvaluateRegularExpression/index.html]

And here:
[Before|http://danbress.github.io/generated-documentation/components-03192015/org.apache.nifi.processors.kafka.PutKafka/index.html]
[After|http://danbress.github.io/generated-documentation/components-03232015/files/org.apache.nifi.processors.kafka.PutKafka/index.html]

Let me know if this doesn't satisfy your original request, or if you have any other suggestions.

> Improve formatting of machine generated component documentation
> ---------------------------------------------------------------
>
>                 Key: NIFI-434
>                 URL: https://issues.apache.org/jira/browse/NIFI-434
>             Project: Apache NiFi
>          Issue Type: Improvement
>          Components: Core Framework, Documentation & Website
>    Affects Versions: 0.1.0
>            Reporter: Dan Bress
>            Priority: Minor
>              Labels: beginner, css, html
>             Fix For: 0.1.0
>
>
> Dan,
> Some feedback to consider.
> - The printout of 'Valid Values' should perhaps read 'Enumerated Values' or simply "Allowed Values". We're not listing all 'valid' values we're only providing that when there is an enumeration of allowed values. I just don't want folks to think that those are the only valid values in cases where it isn't an enumeration.
> - Consider widening 'Valid Values' and 'Default Values' and narrowing the description.



--
This message was sent by Atlassian JIRA
(v6.3.4#6332)