[
https://issues.apache.org/jira/browse/NIFI-441?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=14375879#comment-14375879
]
Mark Payne commented on NIFI-441:
---------------------------------
Dan - great call. Definitely something that needed to be done here. Only thing
that I may be a bit concerned about is the additionalDetails.html... by
default, it will create this so that if a user looks at the documentation they
will get a link for "Additional Details" and then when they click it, it will
just say "This is a place to provide additional text, images and references
that best describe how to use your processor. If this level of detail is not
necessary, you can remove this file."
Personally, I would be tempted to just not even include the
additionalDetails.html file. Though if you do want it, it could be convenient
to have.
Another possibility is to create a Code Template for your IDE that includes
this. I have some for Eclipse that I use constantly for creating Property
Descriptors, Relationships, and even entire Processor bodies. So with just a
couple of key presses, it will automatically create a skeleton Property
Descriptor for me where I can just type the name, hit tab, type the
description, hit tab, type default value, etc. We need to get these
stored/exposed somewhere, on a help/wiki on our webpage or something like that.
It may be good to have a template for the additionalDetails there as well
instead of the archetype.
Thoughts?
> Update archetype based on new component documentation feature
> -------------------------------------------------------------
>
> Key: NIFI-441
> URL: https://issues.apache.org/jira/browse/NIFI-441
> Project: Apache NiFi
> Issue Type: Improvement
> Components: Tools and Build
> Affects Versions: 0.1.0
> Reporter: Dan Bress
> Assignee: Dan Bress
> Priority: Trivial
> Fix For: 0.1.0
>
>
> The nifi-processor-bundle-archetype should be updated to make reference to
> the new documentation annotations and rename index.html to
> additionalDetails.html
--
This message was sent by Atlassian JIRA
(v6.3.4#6332)
