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/03/04 22:39:15 UTC
Advance usage documentation not displayed
Just getting back to this...
I have so far been unable to get the Advanced "Usage" documentation
feature to work in any of my processors. Whether I right-click on the
processor in the workspace and choose Usage or click Help in the
workspace, I get nothing that resembles or contains what I've got in
/additionalDetails.html/.
The most important bits of my processor are illustrated below. I think
they match the documentation in
https://nifi.apache.org/docs/nifi-docs/html/developer-guide.html#advanced-documentation
.
├── pom.xml
└── /src/
└── /main/
├── /java/
│ └── *com*
│ └── *imatsolutions*
│ └── *nifi*
│ └── *processor*
│ └── *AppointmentsProcessor*.java
└── /resources/
├── /docs/
│ └──
*com.imatsolutions.nifi.processor.AppointmentsProcessor*
│ └── additionalDetails.html
└── META-INF
└── services
└── org.apache.nifi.processor.Processor
The nifi-nar-maven-plugin appears to put this where it belongs:
Re: Advance usage documentation not displayed
Posted by Russell Bateman <ru...@perfectsearchcorp.com>.
Yes, thanks. I just tried using the archetype and what it generated is
pretty much unusable by us. Our sandbox structure is already so complex
that it defied mavenization in the first place (as the newcomer, I was
kind of forcing the switch from ant to Maven, but NiFi's helped to tip
the whole thing right over the ledge). Incorporating what's suggested by
the /pom.xml/ generated is not welcomed complexity at this point. So,
we'll have to wait for the outcome of this 1601 and just forego
additional doc until then.
Thanks!
On 03/08/2016 08:42 AM, Matt Gilman wrote:
> If we support discovering your Processor being bundled directly into a
> NAR, we also need to support loading documentation from there. I've
> created a JIRA for this work [1].
>
> In the meantime, if you re-package your Processor as a JAR bundled in
> a NAR it should address the issues your seeing. A good reference would
> be the Solr Processors Bryan mentioned earlier [2].
>
> Matt
>
> [1] https://issues.apache.org/jira/browse/NIFI-1601
> [2]
> https://github.com/apache/nifi/tree/master/nifi-nar-bundles/nifi-solr-bundle
>
> On Tue, Mar 8, 2016 at 10:34 AM, Russell Bateman
> <russell.bateman@perfectsearchcorp.com
> <ma...@perfectsearchcorp.com>> wrote:
>
> Ah, yes, we are bundling our processor directly in a NAR. Our
> first grunts and groans in NiFi were guided by
>
> http://www.nifi.rocks/developing-a-custom-apache-nifi-processor-json/
>
> I got the impression that NAR replaced JAR.
>
> So, this is the first I've heard it intimated that it could happen
> otherwise. I'm not sure how to embed a JAR inside a NAR and
> haven't looked yet, but is there a sample /pom.xml/ that I could
> go off of? That would save me a lot of time tinkering.
>
> Russ
>
> On 03/08/2016 07:35 AM, Matt Gilman wrote:
>> Russell,
>>
>> So something isn't quite right. The index.html page is
>> automatically generated and you should also see the
>> additionalDetails.html that is packaged in your Processor JAR
>> that is in your Bundle NAR.
>>
>> For instance, the PutSolrContentStream Processor that Bryan had
>> previously mentioned.
>>
>> $ ls -l org.apache.nifi.processors.solr.PutSolrContentStream/
>> total 24
>> -rw-r--r-- 1 mgilman staff 1948 Mar 7 16:35
>> additionalDetails.html
>> -rw-r--r-- 1 mgilman staff 4975 Mar 7 16:35 index.html
>>
>> Are you bundling your Processor directly in a NAR (without the
>> Processor JAR)?
>>
>> Matt
>>
>>
>> On Mon, Mar 7, 2016 at 6:19 PM, Russell Bateman
>> <russell.bateman@perfectsearchcorp.com
>> <ma...@perfectsearchcorp.com>> wrote:
>>
>> Yes, it's there and has my (meager) content
>>
>> ~/dev/nifi/nifi/work/docs/components $ ll
>> com.imatsolutions.nifi.processor.AppointmentsProcessor
>> total 20
>> drwxr-xr-x. 2 russ russ 4096 Feb 29 10:31 .
>> drwxr-xr-x. 132 russ russ 12288 Feb 29 10:31 ..
>> -rw-r--r--. 1 russ russ 1183 Feb 29 10:31 index.html
>>
>>
>> On 03/07/2016 02:45 PM, Matt Gilman wrote:
>>> Russell,
>>>
>>> It doesn't appear that your Processor is appearing in the
>>> documentation at all. Do you see a folder for your Processor
>>> in <NIFI_HOME>/work/docs/components?
>>>
>>> Matt
>>>
>>> On Mon, Mar 7, 2016 at 2:19 PM, Russell Bateman
>>> <russell.bateman@perfectsearchcorp.com
>>> <ma...@perfectsearchcorp.com>> wrote:
>>>
>>> Thanks for your reply. No, indeed, I'm not seeing that
>>> (which doesn't exclude that I'm doing something wrong).
>>> Here's me getting there. Note I'm searching for
>>> "additional" on the page which doesn't exist.
>>>
>>>
>>> On 03/05/2016 05:10 PM, Bryan Bende wrote:
>>>> Russell,
>>>>
>>>> Just want to confirm what you are seeing... so when you
>>>> bring up the usage for your processor, you see the
>>>> normal documentation, but you don't see an "Additional
>>>> Details..." link at the top of the page?
>>>>
>>>> One example I know of is the PutSolrContentStream
>>>> processor:
>>>>
>>>> https://nifi.apache.org/docs/nifi-docs/components/org.apache.nifi.processors.solr.PutSolrContentStream/index.html
>>>> https://nifi.apache.org/docs/nifi-docs/components/org.apache.nifi.processors.solr.PutSolrContentStream/additionalDetails.html
>>>>
>>>> -Bryan
>>>>
>>>> On Fri, Mar 4, 2016 at 4:39 PM, Russell Bateman
>>>> <russell.bateman@perfectsearchcorp.com
>>>> <ma...@perfectsearchcorp.com>> wrote:
>>>>
>>>> Just getting back to this...
>>>>
>>>> I have so far been unable to get the Advanced
>>>> "Usage" documentation feature to work in any of my
>>>> processors. Whether I right-click on the processor
>>>> in the workspace and choose Usage or click Help in
>>>> the workspace, I get nothing that resembles or
>>>> contains what I've got in /additionalDetails.html/.
>>>>
>>>> The most important bits of my processor are
>>>> illustrated below. I think they match the
>>>> documentation in
>>>>
>>>> https://nifi.apache.org/docs/nifi-docs/html/developer-guide.html#advanced-documentation
>>>>
>>>>
>>>> .
>>>> ├── pom.xml
>>>> └── /src/
>>>> └── /main/
>>>> ├── /java/
>>>> │ └── *com*
>>>> │ └── *imatsolutions*
>>>> │ └── *nifi*
>>>> │ └── *processor*
>>>> │ └── *AppointmentsProcessor*.java
>>>> └── /resources/
>>>> ├── /docs/
>>>> │ └──
>>>> *com.imatsolutions.nifi.processor.AppointmentsProcessor*
>>>> │ └── additionalDetails.html
>>>> └── META-INF
>>>> └── services
>>>> └── org.apache.nifi.processor.Processor
>>>>
>>>>
>>>> The nifi-nar-maven-plugin appears to put this where
>>>> it belongs:
>>>>
>>>>
>>>>
>>>
>>>
>>
>>
>
>
Re: Advance usage documentation not displayed
Posted by Matt Gilman <ma...@gmail.com>.
If we support discovering your Processor being bundled directly into a NAR,
we also need to support loading documentation from there. I've created a
JIRA for this work [1].
In the meantime, if you re-package your Processor as a JAR bundled in a NAR
it should address the issues your seeing. A good reference would be the
Solr Processors Bryan mentioned earlier [2].
Matt
[1] https://issues.apache.org/jira/browse/NIFI-1601
[2]
https://github.com/apache/nifi/tree/master/nifi-nar-bundles/nifi-solr-bundle
On Tue, Mar 8, 2016 at 10:34 AM, Russell Bateman <
russell.bateman@perfectsearchcorp.com> wrote:
> Ah, yes, we are bundling our processor directly in a NAR. Our first grunts
> and groans in NiFi were guided by
>
> http://www.nifi.rocks/developing-a-custom-apache-nifi-processor-json/
>
> I got the impression that NAR replaced JAR.
>
> So, this is the first I've heard it intimated that it could happen
> otherwise. I'm not sure how to embed a JAR inside a NAR and haven't looked
> yet, but is there a sample *pom.xml* that I could go off of? That would
> save me a lot of time tinkering.
>
> Russ
>
> On 03/08/2016 07:35 AM, Matt Gilman wrote:
>
> Russell,
>
> So something isn't quite right. The index.html page is automatically
> generated and you should also see the additionalDetails.html that is
> packaged in your Processor JAR that is in your Bundle NAR.
>
> For instance, the PutSolrContentStream Processor that Bryan had previously
> mentioned.
>
> $ ls -l org.apache.nifi.processors.solr.PutSolrContentStream/
> total 24
> -rw-r--r-- 1 mgilman staff 1948 Mar 7 16:35 additionalDetails.html
> -rw-r--r-- 1 mgilman staff 4975 Mar 7 16:35 index.html
>
> Are you bundling your Processor directly in a NAR (without the Processor
> JAR)?
>
> Matt
>
>
> On Mon, Mar 7, 2016 at 6:19 PM, Russell Bateman <
> russell.bateman@perfectsearchcorp.com> wrote:
>
>> Yes, it's there and has my (meager) content
>>
>> ~/dev/nifi/nifi/work/docs/components $ ll
>> com.imatsolutions.nifi.processor.AppointmentsProcessor
>> total 20
>> drwxr-xr-x. 2 russ russ 4096 Feb 29 10:31 .
>> drwxr-xr-x. 132 russ russ 12288 Feb 29 10:31 ..
>> -rw-r--r--. 1 russ russ 1183 Feb 29 10:31 index.html
>>
>>
>> On 03/07/2016 02:45 PM, Matt Gilman wrote:
>>
>> Russell,
>>
>> It doesn't appear that your Processor is appearing in the documentation
>> at all. Do you see a folder for your Processor in
>> <NIFI_HOME>/work/docs/components?
>>
>> Matt
>>
>> On Mon, Mar 7, 2016 at 2:19 PM, Russell Bateman <
>> <ru...@perfectsearchcorp.com>
>> russell.bateman@perfectsearchcorp.com> wrote:
>>
>>> Thanks for your reply. No, indeed, I'm not seeing that (which doesn't
>>> exclude that I'm doing something wrong). Here's me getting there. Note I'm
>>> searching for "additional" on the page which doesn't exist.
>>>
>>>
>>> On 03/05/2016 05:10 PM, Bryan Bende wrote:
>>>
>>> Russell,
>>>
>>> Just want to confirm what you are seeing... so when you bring up the
>>> usage for your processor, you see the normal documentation, but you don't
>>> see an "Additional Details..." link at the top of the page?
>>>
>>> One example I know of is the PutSolrContentStream processor:
>>>
>>>
>>> https://nifi.apache.org/docs/nifi-docs/components/org.apache.nifi.processors.solr.PutSolrContentStream/index.html
>>>
>>> https://nifi.apache.org/docs/nifi-docs/components/org.apache.nifi.processors.solr.PutSolrContentStream/additionalDetails.html
>>>
>>> -Bryan
>>>
>>> On Fri, Mar 4, 2016 at 4:39 PM, Russell Bateman <
>>> <ru...@perfectsearchcorp.com>
>>> russell.bateman@perfectsearchcorp.com> wrote:
>>>
>>>> Just getting back to this...
>>>>
>>>> I have so far been unable to get the Advanced "Usage" documentation
>>>> feature to work in any of my processors. Whether I right-click on the
>>>> processor in the workspace and choose Usage or click Help in the workspace,
>>>> I get nothing that resembles or contains what I've got in
>>>> *additionalDetails.html*.
>>>>
>>>> The most important bits of my processor are illustrated below. I think
>>>> they match the documentation in
>>>>
>>>>
>>>> https://nifi.apache.org/docs/nifi-docs/html/developer-guide.html#advanced-documentation
>>>>
>>>>
>>>> .
>>>> ├── pom.xml
>>>> └── *src*
>>>> └── *main*
>>>> ├── *java*
>>>> │ └── *com*
>>>> │ └── *imatsolutions*
>>>> │ └── *nifi*
>>>> │ └── *processor*
>>>> │ └── *AppointmentsProcessor*.java
>>>> └── *resources*
>>>> ├── *docs*
>>>> │ └──
>>>> *com.imatsolutions.nifi.processor.AppointmentsProcessor*
>>>> │ └── additionalDetails.html
>>>> └── META-INF
>>>> └── services
>>>> └── org.apache.nifi.processor.Processor
>>>>
>>>>
>>>> The nifi-nar-maven-plugin appears to put this where it belongs:
>>>>
>>>>
>>>>
>>>
>>>
>>
>>
>
>
Re: Advance usage documentation not displayed
Posted by Bryan Bende <bb...@gmail.com>.
Russell,
There is a Maven archetype that will generate the project structure for you:
https://cwiki.apache.org/confluence/display/NIFI/Maven+Projects+for+Extensions#MavenProjectsforExtensions-MavenProcessorArchetype
That page also shows how the bundle should be laid out. Let us know if it
doesn't make sense.
-Bryan
On Tue, Mar 8, 2016 at 10:34 AM, Russell Bateman <
russell.bateman@perfectsearchcorp.com> wrote:
> Ah, yes, we are bundling our processor directly in a NAR. Our first grunts
> and groans in NiFi were guided by
>
> http://www.nifi.rocks/developing-a-custom-apache-nifi-processor-json/
>
> I got the impression that NAR replaced JAR.
>
> So, this is the first I've heard it intimated that it could happen
> otherwise. I'm not sure how to embed a JAR inside a NAR and haven't looked
> yet, but is there a sample *pom.xml* that I could go off of? That would
> save me a lot of time tinkering.
>
> Russ
>
> On 03/08/2016 07:35 AM, Matt Gilman wrote:
>
> Russell,
>
> So something isn't quite right. The index.html page is automatically
> generated and you should also see the additionalDetails.html that is
> packaged in your Processor JAR that is in your Bundle NAR.
>
> For instance, the PutSolrContentStream Processor that Bryan had previously
> mentioned.
>
> $ ls -l org.apache.nifi.processors.solr.PutSolrContentStream/
> total 24
> -rw-r--r-- 1 mgilman staff 1948 Mar 7 16:35 additionalDetails.html
> -rw-r--r-- 1 mgilman staff 4975 Mar 7 16:35 index.html
>
> Are you bundling your Processor directly in a NAR (without the Processor
> JAR)?
>
> Matt
>
>
> On Mon, Mar 7, 2016 at 6:19 PM, Russell Bateman <
> russell.bateman@perfectsearchcorp.com> wrote:
>
>> Yes, it's there and has my (meager) content
>>
>> ~/dev/nifi/nifi/work/docs/components $ ll
>> com.imatsolutions.nifi.processor.AppointmentsProcessor
>> total 20
>> drwxr-xr-x. 2 russ russ 4096 Feb 29 10:31 .
>> drwxr-xr-x. 132 russ russ 12288 Feb 29 10:31 ..
>> -rw-r--r--. 1 russ russ 1183 Feb 29 10:31 index.html
>>
>>
>> On 03/07/2016 02:45 PM, Matt Gilman wrote:
>>
>> Russell,
>>
>> It doesn't appear that your Processor is appearing in the documentation
>> at all. Do you see a folder for your Processor in
>> <NIFI_HOME>/work/docs/components?
>>
>> Matt
>>
>> On Mon, Mar 7, 2016 at 2:19 PM, Russell Bateman <
>> <ru...@perfectsearchcorp.com>
>> russell.bateman@perfectsearchcorp.com> wrote:
>>
>>> Thanks for your reply. No, indeed, I'm not seeing that (which doesn't
>>> exclude that I'm doing something wrong). Here's me getting there. Note I'm
>>> searching for "additional" on the page which doesn't exist.
>>>
>>>
>>> On 03/05/2016 05:10 PM, Bryan Bende wrote:
>>>
>>> Russell,
>>>
>>> Just want to confirm what you are seeing... so when you bring up the
>>> usage for your processor, you see the normal documentation, but you don't
>>> see an "Additional Details..." link at the top of the page?
>>>
>>> One example I know of is the PutSolrContentStream processor:
>>>
>>>
>>> https://nifi.apache.org/docs/nifi-docs/components/org.apache.nifi.processors.solr.PutSolrContentStream/index.html
>>>
>>> https://nifi.apache.org/docs/nifi-docs/components/org.apache.nifi.processors.solr.PutSolrContentStream/additionalDetails.html
>>>
>>> -Bryan
>>>
>>> On Fri, Mar 4, 2016 at 4:39 PM, Russell Bateman <
>>> <ru...@perfectsearchcorp.com>
>>> russell.bateman@perfectsearchcorp.com> wrote:
>>>
>>>> Just getting back to this...
>>>>
>>>> I have so far been unable to get the Advanced "Usage" documentation
>>>> feature to work in any of my processors. Whether I right-click on the
>>>> processor in the workspace and choose Usage or click Help in the workspace,
>>>> I get nothing that resembles or contains what I've got in
>>>> *additionalDetails.html*.
>>>>
>>>> The most important bits of my processor are illustrated below. I think
>>>> they match the documentation in
>>>>
>>>>
>>>> https://nifi.apache.org/docs/nifi-docs/html/developer-guide.html#advanced-documentation
>>>>
>>>>
>>>> .
>>>> ├── pom.xml
>>>> └── *src*
>>>> └── *main*
>>>> ├── *java*
>>>> │ └── *com*
>>>> │ └── *imatsolutions*
>>>> │ └── *nifi*
>>>> │ └── *processor*
>>>> │ └── *AppointmentsProcessor*.java
>>>> └── *resources*
>>>> ├── *docs*
>>>> │ └──
>>>> *com.imatsolutions.nifi.processor.AppointmentsProcessor*
>>>> │ └── additionalDetails.html
>>>> └── META-INF
>>>> └── services
>>>> └── org.apache.nifi.processor.Processor
>>>>
>>>>
>>>> The nifi-nar-maven-plugin appears to put this where it belongs:
>>>>
>>>>
>>>>
>>>
>>>
>>
>>
>
>
Re: Advance usage documentation not displayed
Posted by Russell Bateman <ru...@perfectsearchcorp.com>.
Ah, yes, we are bundling our processor directly in a NAR. Our first
grunts and groans in NiFi were guided by
http://www.nifi.rocks/developing-a-custom-apache-nifi-processor-json/
I got the impression that NAR replaced JAR.
So, this is the first I've heard it intimated that it could happen
otherwise. I'm not sure how to embed a JAR inside a NAR and haven't
looked yet, but is there a sample /pom.xml/ that I could go off of? That
would save me a lot of time tinkering.
Russ
On 03/08/2016 07:35 AM, Matt Gilman wrote:
> Russell,
>
> So something isn't quite right. The index.html page is automatically
> generated and you should also see the additionalDetails.html that is
> packaged in your Processor JAR that is in your Bundle NAR.
>
> For instance, the PutSolrContentStream Processor that Bryan had
> previously mentioned.
>
> $ ls -l org.apache.nifi.processors.solr.PutSolrContentStream/
> total 24
> -rw-r--r-- 1 mgilman staff 1948 Mar 7 16:35 additionalDetails.html
> -rw-r--r-- 1 mgilman staff 4975 Mar 7 16:35 index.html
>
> Are you bundling your Processor directly in a NAR (without the
> Processor JAR)?
>
> Matt
>
>
> On Mon, Mar 7, 2016 at 6:19 PM, Russell Bateman
> <russell.bateman@perfectsearchcorp.com
> <ma...@perfectsearchcorp.com>> wrote:
>
> Yes, it's there and has my (meager) content
>
> ~/dev/nifi/nifi/work/docs/components $ ll
> com.imatsolutions.nifi.processor.AppointmentsProcessor
> total 20
> drwxr-xr-x. 2 russ russ 4096 Feb 29 10:31 .
> drwxr-xr-x. 132 russ russ 12288 Feb 29 10:31 ..
> -rw-r--r--. 1 russ russ 1183 Feb 29 10:31 index.html
>
>
> On 03/07/2016 02:45 PM, Matt Gilman wrote:
>> Russell,
>>
>> It doesn't appear that your Processor is appearing in the
>> documentation at all. Do you see a folder for your Processor in
>> <NIFI_HOME>/work/docs/components?
>>
>> Matt
>>
>> On Mon, Mar 7, 2016 at 2:19 PM, Russell Bateman
>> <russell.bateman@perfectsearchcorp.com
>> <ma...@perfectsearchcorp.com>> wrote:
>>
>> Thanks for your reply. No, indeed, I'm not seeing that (which
>> doesn't exclude that I'm doing something wrong). Here's me
>> getting there. Note I'm searching for "additional" on the
>> page which doesn't exist.
>>
>>
>> On 03/05/2016 05:10 PM, Bryan Bende wrote:
>>> Russell,
>>>
>>> Just want to confirm what you are seeing... so when you
>>> bring up the usage for your processor, you see the normal
>>> documentation, but you don't see an "Additional Details..."
>>> link at the top of the page?
>>>
>>> One example I know of is the PutSolrContentStream processor:
>>>
>>> https://nifi.apache.org/docs/nifi-docs/components/org.apache.nifi.processors.solr.PutSolrContentStream/index.html
>>> https://nifi.apache.org/docs/nifi-docs/components/org.apache.nifi.processors.solr.PutSolrContentStream/additionalDetails.html
>>>
>>> -Bryan
>>>
>>> On Fri, Mar 4, 2016 at 4:39 PM, Russell Bateman
>>> <russell.bateman@perfectsearchcorp.com
>>> <ma...@perfectsearchcorp.com>> wrote:
>>>
>>> Just getting back to this...
>>>
>>> I have so far been unable to get the Advanced "Usage"
>>> documentation feature to work in any of my processors.
>>> Whether I right-click on the processor in the workspace
>>> and choose Usage or click Help in the workspace, I get
>>> nothing that resembles or contains what I've got in
>>> /additionalDetails.html/.
>>>
>>> The most important bits of my processor are illustrated
>>> below. I think they match the documentation in
>>>
>>> https://nifi.apache.org/docs/nifi-docs/html/developer-guide.html#advanced-documentation
>>>
>>>
>>> .
>>> ├── pom.xml
>>> └── /src/
>>> └── /main/
>>> ├── /java/
>>> │ └── *com*
>>> │ └── *imatsolutions*
>>> │ └── *nifi*
>>> │ └── *processor*
>>> │ └── *AppointmentsProcessor*.java
>>> └── /resources/
>>> ├── /docs/
>>> │ └──
>>> *com.imatsolutions.nifi.processor.AppointmentsProcessor*
>>> │ └── additionalDetails.html
>>> └── META-INF
>>> └── services
>>> └── org.apache.nifi.processor.Processor
>>>
>>>
>>> The nifi-nar-maven-plugin appears to put this where it
>>> belongs:
>>>
>>>
>>>
>>
>>
>
>
Re: Advance usage documentation not displayed
Posted by Matt Gilman <ma...@gmail.com>.
Russell,
So something isn't quite right. The index.html page is automatically
generated and you should also see the additionalDetails.html that is
packaged in your Processor JAR that is in your Bundle NAR.
For instance, the PutSolrContentStream Processor that Bryan had previously
mentioned.
$ ls -l org.apache.nifi.processors.solr.PutSolrContentStream/
total 24
-rw-r--r-- 1 mgilman staff 1948 Mar 7 16:35 additionalDetails.html
-rw-r--r-- 1 mgilman staff 4975 Mar 7 16:35 index.html
Are you bundling your Processor directly in a NAR (without the Processor
JAR)?
Matt
On Mon, Mar 7, 2016 at 6:19 PM, Russell Bateman <
russell.bateman@perfectsearchcorp.com> wrote:
> Yes, it's there and has my (meager) content
>
> ~/dev/nifi/nifi/work/docs/components $ ll
> com.imatsolutions.nifi.processor.AppointmentsProcessor
> total 20
> drwxr-xr-x. 2 russ russ 4096 Feb 29 10:31 .
> drwxr-xr-x. 132 russ russ 12288 Feb 29 10:31 ..
> -rw-r--r--. 1 russ russ 1183 Feb 29 10:31 index.html
>
>
> On 03/07/2016 02:45 PM, Matt Gilman wrote:
>
> Russell,
>
> It doesn't appear that your Processor is appearing in the documentation at
> all. Do you see a folder for your Processor in
> <NIFI_HOME>/work/docs/components?
>
> Matt
>
> On Mon, Mar 7, 2016 at 2:19 PM, Russell Bateman <
> russell.bateman@perfectsearchcorp.com> wrote:
>
>> Thanks for your reply. No, indeed, I'm not seeing that (which doesn't
>> exclude that I'm doing something wrong). Here's me getting there. Note I'm
>> searching for "additional" on the page which doesn't exist.
>>
>>
>> On 03/05/2016 05:10 PM, Bryan Bende wrote:
>>
>> Russell,
>>
>> Just want to confirm what you are seeing... so when you bring up the
>> usage for your processor, you see the normal documentation, but you don't
>> see an "Additional Details..." link at the top of the page?
>>
>> One example I know of is the PutSolrContentStream processor:
>>
>>
>> https://nifi.apache.org/docs/nifi-docs/components/org.apache.nifi.processors.solr.PutSolrContentStream/index.html
>>
>> https://nifi.apache.org/docs/nifi-docs/components/org.apache.nifi.processors.solr.PutSolrContentStream/additionalDetails.html
>>
>> -Bryan
>>
>> On Fri, Mar 4, 2016 at 4:39 PM, Russell Bateman <
>> <ru...@perfectsearchcorp.com>
>> russell.bateman@perfectsearchcorp.com> wrote:
>>
>>> Just getting back to this...
>>>
>>> I have so far been unable to get the Advanced "Usage" documentation
>>> feature to work in any of my processors. Whether I right-click on the
>>> processor in the workspace and choose Usage or click Help in the workspace,
>>> I get nothing that resembles or contains what I've got in
>>> *additionalDetails.html*.
>>>
>>> The most important bits of my processor are illustrated below. I think
>>> they match the documentation in
>>>
>>>
>>> https://nifi.apache.org/docs/nifi-docs/html/developer-guide.html#advanced-documentation
>>>
>>>
>>> .
>>> ├── pom.xml
>>> └── *src*
>>> └── *main*
>>> ├── *java*
>>> │ └── *com*
>>> │ └── *imatsolutions*
>>> │ └── *nifi*
>>> │ └── *processor*
>>> │ └── *AppointmentsProcessor*.java
>>> └── *resources*
>>> ├── *docs*
>>> │ └──
>>> *com.imatsolutions.nifi.processor.AppointmentsProcessor*
>>> │ └── additionalDetails.html
>>> └── META-INF
>>> └── services
>>> └── org.apache.nifi.processor.Processor
>>>
>>>
>>> The nifi-nar-maven-plugin appears to put this where it belongs:
>>>
>>>
>>>
>>
>>
>
>
Re: Advance usage documentation not displayed
Posted by Russell Bateman <ru...@perfectsearchcorp.com>.
Yes, it's there and has my (meager) content
~/dev/nifi/nifi/work/docs/components $ ll
com.imatsolutions.nifi.processor.AppointmentsProcessor
total 20
drwxr-xr-x. 2 russ russ 4096 Feb 29 10:31 .
drwxr-xr-x. 132 russ russ 12288 Feb 29 10:31 ..
-rw-r--r--. 1 russ russ 1183 Feb 29 10:31 index.html
On 03/07/2016 02:45 PM, Matt Gilman wrote:
> Russell,
>
> It doesn't appear that your Processor is appearing in the
> documentation at all. Do you see a folder for your Processor in
> <NIFI_HOME>/work/docs/components?
>
> Matt
>
> On Mon, Mar 7, 2016 at 2:19 PM, Russell Bateman
> <russell.bateman@perfectsearchcorp.com
> <ma...@perfectsearchcorp.com>> wrote:
>
> Thanks for your reply. No, indeed, I'm not seeing that (which
> doesn't exclude that I'm doing something wrong). Here's me getting
> there. Note I'm searching for "additional" on the page which
> doesn't exist.
>
>
> On 03/05/2016 05:10 PM, Bryan Bende wrote:
>> Russell,
>>
>> Just want to confirm what you are seeing... so when you bring up
>> the usage for your processor, you see the normal documentation,
>> but you don't see an "Additional Details..." link at the top of
>> the page?
>>
>> One example I know of is the PutSolrContentStream processor:
>>
>> https://nifi.apache.org/docs/nifi-docs/components/org.apache.nifi.processors.solr.PutSolrContentStream/index.html
>> https://nifi.apache.org/docs/nifi-docs/components/org.apache.nifi.processors.solr.PutSolrContentStream/additionalDetails.html
>>
>> -Bryan
>>
>> On Fri, Mar 4, 2016 at 4:39 PM, Russell Bateman
>> <russell.bateman@perfectsearchcorp.com
>> <ma...@perfectsearchcorp.com>> wrote:
>>
>> Just getting back to this...
>>
>> I have so far been unable to get the Advanced "Usage"
>> documentation feature to work in any of my processors.
>> Whether I right-click on the processor in the workspace and
>> choose Usage or click Help in the workspace, I get nothing
>> that resembles or contains what I've got in
>> /additionalDetails.html/.
>>
>> The most important bits of my processor are illustrated
>> below. I think they match the documentation in
>>
>> https://nifi.apache.org/docs/nifi-docs/html/developer-guide.html#advanced-documentation
>>
>>
>> .
>> ├── pom.xml
>> └── /src/
>> └── /main/
>> ├── /java/
>> │ └── *com*
>> │ └── *imatsolutions*
>> │ └── *nifi*
>> │ └── *processor*
>> │ └── *AppointmentsProcessor*.java
>> └── /resources/
>> ├── /docs/
>> │ └──
>> *com.imatsolutions.nifi.processor.AppointmentsProcessor*
>> │ └── additionalDetails.html
>> └── META-INF
>> └── services
>> └── org.apache.nifi.processor.Processor
>>
>>
>> The nifi-nar-maven-plugin appears to put this where it belongs:
>>
>>
>>
>
>
Re: Advance usage documentation not displayed
Posted by Matt Gilman <ma...@gmail.com>.
Russell,
It doesn't appear that your Processor is appearing in the documentation at
all. Do you see a folder for your Processor in
<NIFI_HOME>/work/docs/components?
Matt
On Mon, Mar 7, 2016 at 2:19 PM, Russell Bateman <
russell.bateman@perfectsearchcorp.com> wrote:
> Thanks for your reply. No, indeed, I'm not seeing that (which doesn't
> exclude that I'm doing something wrong). Here's me getting there. Note I'm
> searching for "additional" on the page which doesn't exist.
>
>
>
>
>
> On 03/05/2016 05:10 PM, Bryan Bende wrote:
>
> Russell,
>
> Just want to confirm what you are seeing... so when you bring up the usage
> for your processor, you see the normal documentation, but you don't see an
> "Additional Details..." link at the top of the page?
>
> One example I know of is the PutSolrContentStream processor:
>
>
> https://nifi.apache.org/docs/nifi-docs/components/org.apache.nifi.processors.solr.PutSolrContentStream/index.html
>
> https://nifi.apache.org/docs/nifi-docs/components/org.apache.nifi.processors.solr.PutSolrContentStream/additionalDetails.html
>
> -Bryan
>
> On Fri, Mar 4, 2016 at 4:39 PM, Russell Bateman <
> russell.bateman@perfectsearchcorp.com> wrote:
>
>> Just getting back to this...
>>
>> I have so far been unable to get the Advanced "Usage" documentation
>> feature to work in any of my processors. Whether I right-click on the
>> processor in the workspace and choose Usage or click Help in the workspace,
>> I get nothing that resembles or contains what I've got in
>> *additionalDetails.html*.
>>
>> The most important bits of my processor are illustrated below. I think
>> they match the documentation in
>>
>>
>> https://nifi.apache.org/docs/nifi-docs/html/developer-guide.html#advanced-documentation
>>
>>
>> .
>> ├── pom.xml
>> └── *src*
>> └── *main*
>> ├── *java*
>> │ └── *com*
>> │ └── *imatsolutions*
>> │ └── *nifi*
>> │ └── *processor*
>> │ └── *AppointmentsProcessor*.java
>> └── *resources*
>> ├── *docs*
>> │ └──
>> *com.imatsolutions.nifi.processor.AppointmentsProcessor*
>> │ └── additionalDetails.html
>> └── META-INF
>> └── services
>> └── org.apache.nifi.processor.Processor
>>
>>
>> The nifi-nar-maven-plugin appears to put this where it belongs:
>>
>>
>>
>
>
Re: Advance usage documentation not displayed
Posted by Russell Bateman <ru...@perfectsearchcorp.com>.
Thanks for your reply. No, indeed, I'm not seeing that (which doesn't
exclude that I'm doing something wrong). Here's me getting there. Note
I'm searching for "additional" on the page which doesn't exist.
On 03/05/2016 05:10 PM, Bryan Bende wrote:
> Russell,
>
> Just want to confirm what you are seeing... so when you bring up the
> usage for your processor, you see the normal documentation, but you
> don't see an "Additional Details..." link at the top of the page?
>
> One example I know of is the PutSolrContentStream processor:
>
> https://nifi.apache.org/docs/nifi-docs/components/org.apache.nifi.processors.solr.PutSolrContentStream/index.html
> https://nifi.apache.org/docs/nifi-docs/components/org.apache.nifi.processors.solr.PutSolrContentStream/additionalDetails.html
>
> -Bryan
>
> On Fri, Mar 4, 2016 at 4:39 PM, Russell Bateman
> <russell.bateman@perfectsearchcorp.com
> <ma...@perfectsearchcorp.com>> wrote:
>
> Just getting back to this...
>
> I have so far been unable to get the Advanced "Usage"
> documentation feature to work in any of my processors. Whether I
> right-click on the processor in the workspace and choose Usage or
> click Help in the workspace, I get nothing that resembles or
> contains what I've got in /additionalDetails.html/.
>
> The most important bits of my processor are illustrated below. I
> think they match the documentation in
>
> https://nifi.apache.org/docs/nifi-docs/html/developer-guide.html#advanced-documentation
>
>
> .
> ├── pom.xml
> └── /src/
> └── /main/
> ├── /java/
> │ └── *com*
> │ └── *imatsolutions*
> │ └── *nifi*
> │ └── *processor*
> │ └── *AppointmentsProcessor*.java
> └── /resources/
> ├── /docs/
> │ └──
> *com.imatsolutions.nifi.processor.AppointmentsProcessor*
> │ └── additionalDetails.html
> └── META-INF
> └── services
> └── org.apache.nifi.processor.Processor
>
>
> The nifi-nar-maven-plugin appears to put this where it belongs:
>
>
>
Re: Advance usage documentation not displayed
Posted by Bryan Bende <bb...@gmail.com>.
Russell,
Just want to confirm what you are seeing... so when you bring up the usage
for your processor, you see the normal documentation, but you don't see an
"Additional Details..." link at the top of the page?
One example I know of is the PutSolrContentStream processor:
https://nifi.apache.org/docs/nifi-docs/components/org.apache.nifi.processors.solr.PutSolrContentStream/index.html
https://nifi.apache.org/docs/nifi-docs/components/org.apache.nifi.processors.solr.PutSolrContentStream/additionalDetails.html
-Bryan
On Fri, Mar 4, 2016 at 4:39 PM, Russell Bateman <
russell.bateman@perfectsearchcorp.com> wrote:
> Just getting back to this...
>
> I have so far been unable to get the Advanced "Usage" documentation
> feature to work in any of my processors. Whether I right-click on the
> processor in the workspace and choose Usage or click Help in the workspace,
> I get nothing that resembles or contains what I've got in
> *additionalDetails.html*.
>
> The most important bits of my processor are illustrated below. I think
> they match the documentation in
>
>
> https://nifi.apache.org/docs/nifi-docs/html/developer-guide.html#advanced-documentation
>
>
> .
> ├── pom.xml
> └── *src*
> └── *main*
> ├── *java*
> │ └── *com*
> │ └── *imatsolutions*
> │ └── *nifi*
> │ └── *processor*
> │ └── *AppointmentsProcessor*.java
> └── *resources*
> ├── *docs*
> │ └──
> *com.imatsolutions.nifi.processor.AppointmentsProcessor*
> │ └── additionalDetails.html
> └── META-INF
> └── services
> └── org.apache.nifi.processor.Processor
>
>
> The nifi-nar-maven-plugin appears to put this where it belongs:
>
>
>