If the expected documentation is not showing up in the UI - particularly if
an older version of the documentation is present - you may have to clear
your browser cache and reload the documentation page.
-Mark
On Wed, Apr 5, 2023 at 11:52 AM Matthew Baine
wrote:
> Hi Russell and Bryan,
>
> Yes,
Hi Russell and Bryan,
Yes, we are currently making use of the @CapabilityDescription annotations
etc, it's the additionalDetails.html file I am trying to implement.
The feedback is much appreciated, I'll proceed as advised.
Kind Regards,
Matthew
On Tue, 4 Apr 2023 at 17:54, Russell Bateman wro
Matthew,
If you feel that the documentation generated from the annotations at the
top of your custom processor class (@CapabilityDescription, etc., of
which Bryan spoke) is insufficient, it's also possible to supplement it with
/src/main/resources/docs/.CustomProcessorClass/additionalDeta
Hello,
Documentation for a component is generated automatically from the component
itself by using available API methods and the annotations on the class [1].
For example, documentation on a processor will use the
getPropertyDescriptors and getRelationship methods of the component, as
well as anno
Hi Bryan,
Sorry, on a separate note, what would be the best way to set up Usage
Documentation for a custom processor?
[image: image.png]
We can't seem to get this right with the information online and on the Nifi
developer guide (
https://nifi.apache.org/docs/nifi-docs/html/developer-guide.html)
27;ll give it a try.
> > > > > > > > > >
> > > > > > > > > > David P.
> > > > > > > > > >
> > > > > > > > > > On 2019/08/26 15:21:12, Bryan Bende
> > > > > > > > >
> > On 2019/08/26 15:21:12, Bryan Bende wrote:
> > > > > > > > > > Hello,
> > > > > > > > > >
> > > > > > > > > > The documentation for a processor is generated
> > > > &g
tation for a processor is generated automatically
> > > > > > > > > from the
> > > > > > > > > annotations on the processors. If you used the Maven
> > > > > > > > > Archetype to
> > > > > > >
; > > > > > to
> > > > > > > > generate your NAR then you should already have a starting point
> > > > > > > > for
> > > > > > > > this with the example MyProcessor which has the following
> > > > > > > &
example MyProcessor which has the following
> > > > > > > annotations:
> > > > > > >
> > > > > > > @Tags({"example"})
> > > > > > > @CapabilityDescription("Provide a descript
s({@WritesAttribute(attribute="", description="")})
> > > > > >
> > > > > > For the additionalDetails.html, it may help you to look at how it is
> > > > > > setup in the existing NARs:
> > > > > >
it is
> > > > > setup in the existing NARs:
> > > > >
> > > > > https://github.com/apache/nifi/tree/master/nifi-nar-bundles/nifi-kafka-bundle/nifi-kafka-2-0-processors/src/main/resources/docs
> > > > >
> > > > > In the
gt; > > > setup in the existing NARs:
> > > >
> > > > https://github.com/apache/nifi/tree/master/nifi-nar-bundles/nifi-kafka-bundle/nifi-kafka-2-0-processors/src/main/resources/docs
> > > >
> > > > In the processors Maven module, the locat
> In the processors Maven module, the location would be
> > > "src/main/resources/docs/{fully-qualified-component-name}/additionalDetails.html"
> > >
> > > On Fri, Aug 23, 2019 at 3:43 PM David Perkins
> > > wrote:
> > > >
> > > >
t-name}/additionalDetails.html"
> >
> > On Fri, Aug 23, 2019 at 3:43 PM David Perkins
> > wrote:
> > >
> > > Hello,
> > > I'm having trouble generating documentation for a set of custom NiFi
> > > processors. I posted a question with all the
le, the location would be
> "src/main/resources/docs/{fully-qualified-component-name}/additionalDetails.html"
>
> On Fri, Aug 23, 2019 at 3:43 PM David Perkins
> wrote:
> >
> > Hello,
> > I'm having trouble generating documentation for a set of custom
s>
> > In the processors Maven module, the location would be> >
"src/main/resources/docs/{fully-qualified-component-name}/additionalDetails.html">
> > On Fri, Aug 23, 2019 at 3:43 PM David Perkins wrote:> > >> > >
Hello,> > > I'm
nt-name}/additionalDetails.html"
On Fri, Aug 23, 2019 at 3:43 PM David Perkins wrote:
>
> Hello,
> I'm having trouble generating documentation for a set of custom NiFi
> processors. I posted a question with all the details here on Stack
> Overflow.
> https://stackoverfl
Hello,
I'm having trouble generating documentation for a set of custom NiFi
processors. I posted a question with all the details here on Stack
Overflow.
https://stackoverflow.com/questions/57530465/how-to-generate-usage-documentation-for-custom-processors
Below is a copy of what I p
19 matches
Mail list logo
