Hi Bryan, thanks for the quick response. I think I can work with that. I was expecting that there might be a separate tool that I could just to generate the documentation, but it seems that NiFi is that tool. It seems that all we need to do now is put together a style sheet to pretty things up. Thanks again, -- Rick Stroobosscher | Vital Images Inc. Mobile: +1 519 500 3500 7 Father David Bauer Drive, Suite 201 Waterloo, ON, N2L 0A2, Canada www.vitalimages.com <http://www.karoshealth.com/>
On Tue, Oct 24, 2017 at 3:59 PM, Bryan Bende <[email protected]> wrote: > Rick, > > The documentation for components is auto-generated from the > annotations on the classes. > > For example, taking the annotations on the RouteOnAttribute processor: > https://github.com/apache/nifi/blob/master/nifi-nar- > bundles/nifi-standard-bundle/nifi-standard-processors/src/ > main/java/org/apache/nifi/processors/standard/ > RouteOnAttribute.java#L63-L74 > > That produces the documentation found here: > https://nifi.apache.org/docs/nifi-docs/components/org. > apache.nifi/nifi-standard-nar/1.4.0/org.apache.nifi.processors.standard. > RouteOnAttribute/index.html > > There is also a way to provide an additionalDetails.html file for your > processor to provide more documentation that doesn't fit well into the > annotations. > > If you deploy your custom NAR to NiFi and follow the above > conventions, then the documentation will be generated for your > components, and they will show up in the docs from with in the > application from the help menu. > > The documentation generation is part of NiFi itself, but those docs > are located on the filesystem in nifi-home/work/docs/<your-nar>. > > Thanks, > > Bryan > > > On Tue, Oct 24, 2017 at 12:58 PM, Rick Stroobosscher > <[email protected]> wrote: > > I'm looking for a tool that will generate documentation for all the > > processors, controllers services and reporting tasks contained in a NAR > > file. Is there something publicly available? It looks like such a tool > was > > used to generate the NiFi Documentation located here. Thanks, > > -- > > Rick Stroobosscher | Vital Images Inc. > > Mobile: +1 519 500 3500 > > 7 Father David Bauer Drive, Suite 201 > > Waterloo, ON, N2L 0A2, Canada > > www.vitalimages.com > > > > Notice - Confidential Information The information in this communication > and > > any attachments is strictly confidential and intended only for the use of > > the individual(s) or entity(ies) named above. If you are not the intended > > recipient, any dissemination, distribution, copying or other use of the > > information contained in this communication and/or any attachment is > > strictly prohibited. If you have received this communication in error, > > please first notify the sender immediately and then delete this > > communication from all data storage devices and destroy all hard copies. >
