[
https://issues.apache.org/jira/browse/NIFI-725?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=14704811#comment-14704811
]
Dan Bress commented on NIFI-725:
--------------------------------
_It probably makes sense to move the maven plugin out of the nifi repository
[1] and into the nifi-maven repository [2]._
100% agree. I put it in this repo just to keep everything together for
simplicity and demo purposes. Long term it should be moved to the repo you
suggest. The only minor hangup I have in using the repo you suggest is the
artifact in that repo is called "nifi-nar-maven-plugin", and the current
implementation of the "document" goal has nothing to do with nars.
_I'm not quite sure about the extract or generate index plugins and whether we
want that driven by the nifi build or the nifi-site build. The only part of it
that concerns me though is knowing which artifacts contained documented
components. It would be nice if we didn't have to brute force it._
While I agree it feels a little weird to build the site out of the
nifi-assembly build as I have it set up. The reason I chose to put it there is
because it(the nifi-assembly) knows about all the nars that are included in a
nifi build. If we setup a maven project under nifi-site, we would have to copy
all the nar dependencies from nifi-assembly into nifi-site. That is totally
doable, but its two places to update when nars are added or removed.
> 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)
