nifi-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Dan Bress (JIRA)" <j...@apache.org>
Subject [jira] [Assigned] (NIFI-725) Refactor when documentation is generated
Date Sun, 16 Aug 2015 16:46:45 GMT

     [ https://issues.apache.org/jira/browse/NIFI-725?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]

Dan Bress reassigned NIFI-725:
------------------------------

    Assignee: Dan Bress

> Refactor when documentation is generated
> ----------------------------------------
>
>                 Key: NIFI-725
>                 URL: https://issues.apache.org/jira/browse/NIFI-725
>             Project: Apache NiFi
>          Issue Type: Improvement
>          Components: Core Framework, Documentation & Website
>    Affects Versions: 0.1.0
>            Reporter: Dan Bress
>            Assignee: Dan Bress
>            Priority: Minor
>
> Currently the DocGenerator, which generates all of our Processor/ReportingTask/ControllerService
documentation, is invoked directly from the [NiFi|https://github.com/apache/incubator-nifi/blob/develop/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-runtime/src/main/java/org/apache/nifi/NiFi.java#L123]
class in the runtime project.
> Invoking the DocGenerator directly from the runtime hamstrings what libraries the DocGenerator
can use, because the runtime project should have the least number of dependencies possible,
and it currently depends on the documentation library.
> I'm proposing that we find a new way/place to invoke documentation generation such that
it may bring in whatever dependencies it needs.
> The first dependency it needs is on nifi-framework-core [ReflectionUtils|https://github.com/apache/incubator-nifi/blob/develop/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/util/ReflectionUtils.java],
which would let us [this copy|https://github.com/apache/incubator-nifi/blob/NIFI-632/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-documentation/src/main/java/org/apache/nifi/documentation/util/ReflectionUtils.java]
of that class.



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

Mime
View raw message