You are viewing a plain text version of this content. The canonical link for it is here.

Posted to users@nifi.apache.org by Russell Bateman <ru...@perfectsearchcorp.com> on 2016/01/20 18:50:56 UTC

Newbie looking for docs subdirectory in NAR

I'm trying to add the documented file, /additionalDetails.html/, to the 
proposed /docs/ subdirectory under the root of my processor's NAR. It's 
a bit mystifying:

  * Where in my (Eclipse/IntelliJ) project do I put it such that the NAR
    plug-in will find it?
  * Where will it end up in the NAR?


I'm reading https://nifi.apache.org/developer-guide.html of course.

The existing NiFi sample projects are exceedingly sparse.

Thanks,

Russ

Re: Newbie looking for docs subdirectory in NAR

Posted by Russell Bateman <ru...@perfectsearchcorp.com>.

Thanks!

On 01/20/2016 10:57 AM, Bryan Bende wrote:
> Hi Russ,
>
> If you have the traditional bundle with a jar project for your 
> processors and a nar project that packages everything, then the 
> additionalDetails.html goes in the jar project under 
> src/main/resources/docs followed by a directory with the fully 
> qualified class name of your processor.
>
> As an example, here is the solr bundle:
>
> https://github.com/apache/nifi/tree/master/nifi-nar-bundles/nifi-solr-bundle/nifi-solr-processors/src/main/resources/docs/org.apache.nifi.processors.solr.PutSolrContentStream
>
> It will end up inside your processors jar which in turn will end up 
> inside your nar, thus making it available on the NiFi classpath at 
> runtime.
>
> Let us know if it is still not clear.
>
> Thanks,
>
> Bryan
>
> On Wed, Jan 20, 2016 at 12:50 PM, Russell Bateman 
> <russell.bateman@perfectsearchcorp.com 
> <ma...@perfectsearchcorp.com>> wrote:
>
>     I'm trying to add the documented file, /additionalDetails.html/,
>     to the proposed /docs/ subdirectory under the root of my
>     processor's NAR. It's a bit mystifying:
>
>       * Where in my (Eclipse/IntelliJ) project do I put it such that
>         the NAR plug-in will find it?
>       * Where will it end up in the NAR?
>
>
>     I'm reading https://nifi.apache.org/developer-guide.html of course.
>
>     The existing NiFi sample projects are exceedingly sparse.
>
>     Thanks,
>
>     Russ
>
>

Re: Newbie looking for docs subdirectory in NAR

Posted by Bryan Bende <bb...@gmail.com>.

Hi Russ,

If you have the traditional bundle with a jar project for your processors
and a nar project that packages everything, then the additionalDetails.html
goes in the jar project under src/main/resources/docs followed by a
directory with the fully qualified class name of your processor.

As an example, here is the solr bundle:

https://github.com/apache/nifi/tree/master/nifi-nar-bundles/nifi-solr-bundle/nifi-solr-processors/src/main/resources/docs/org.apache.nifi.processors.solr.PutSolrContentStream

It will end up inside your processors jar which in turn will end up inside
your nar, thus making it available on the NiFi classpath at runtime.

Let us know if it is still not clear.

Thanks,

Bryan

On Wed, Jan 20, 2016 at 12:50 PM, Russell Bateman <
russell.bateman@perfectsearchcorp.com> wrote:

> I'm trying to add the documented file, *additionalDetails.html*, to the
> proposed *docs* subdirectory under the root of my processor's NAR. It's a
> bit mystifying:
>
>    - Where in my (Eclipse/IntelliJ) project do I put it such that the NAR
>    plug-in will find it?
>    - Where will it end up in the NAR?
>
>
> I'm reading https://nifi.apache.org/developer-guide.html of course.
>
> The existing NiFi sample projects are exceedingly sparse.
>
> Thanks,
>
> Russ
>