You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@nifi.apache.org by "ASF GitHub Bot (JIRA)" <ji...@apache.org> on 2015/02/02 23:01:35 UTC

[jira] [Commented] (NIFI-280) Machine generate Processor/ReportingTask/Html documentation

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

ASF GitHub Bot commented on NIFI-280:
-------------------------------------

Github user danbress commented on the pull request:

    https://github.com/apache/incubator-nifi/pull/14#issuecomment-72547440
  
    Mark/Joe,
       Unless I hear anything to the contrary, I'll update the code to remove the license generation later tonight.
    
    Thanks!
    
    Dan


> Machine generate Processor/ReportingTask/Html documentation
> -----------------------------------------------------------
>
>                 Key: NIFI-280
>                 URL: https://issues.apache.org/jira/browse/NIFI-280
>             Project: Apache NiFi
>          Issue Type: Improvement
>          Components: Core Framework, Core UI, Documentation & Website
>    Affects Versions: 0.0.1
>            Reporter: Dan Bress
>            Priority: Minor
>             Fix For: 0.1.0
>
>   Original Estimate: 96h
>  Remaining Estimate: 96h
>
> The goals of this effort will be:
>     - Machine generate as much of the basic(processor description, property description, relationship description) info as possible.  This
> will make the developers lives better by storing this information in one
> place, and make users lives better by having the "inline" documentation
>  match the "usage" documentation.  This will also ensure that all the
>  documentation is formatted consistently.
>        - Allow the developer to optionally provide additional html and
>  images that would be linked from the machine generated documentation
>        - Provide a way for the documentation to be generated statically
>  and linked from the Apache NiFi webpage



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