[
https://issues.apache.org/jira/browse/NIFI-725?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Dan Bress updated NIFI-725:
---------------------------
Description:
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.
was:
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.
> 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
> 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)
