You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@nifi.apache.org by "Dan Bress (JIRA)" <ji...@apache.org> on 2015/01/17 14:42:34 UTC

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

Dan Bress created NIFI-280:
------------------------------

             Summary: Machine generate Processor/ReportingTask/Html documentation
                 Key: NIFI-280
                 URL: https://issues.apache.org/jira/browse/NIFI-280
             Project: Apache NiFi
          Issue Type: Bug
          Components: Core Framework, Core UI, Documentation & Website
    Affects Versions: 0.0.1
            Reporter: Dan Bress
             Fix For: 0.1.0


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)