[
https://issues.apache.org/jira/browse/NIFI-5859?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16715007#comment-16715007
]
ASF subversion and git services commented on NIFI-5859:
-------------------------------------------------------
Commit 1ac5b93144ebd92c907fb49664a524e196ae20c6 in nifi's branch
refs/heads/master from [~markap14]
[ https://git-wip-us.apache.org/repos/asf?p=nifi.git;h=1ac5b93 ]
NIFI-5859: Added XML-based documentation writer that can be used to document a
component.
- Found several instances of nifi-framework-api's ProviderException being
thrown from processors. Changed those to IllegalStateException, as
ProviderException is not an appropriate Exception in those cases, and
extensions should not depend on nifi-framework-api.
- Performed some cleanup, moving Property Descriptors from Controller Service
API's/specs into the implementations. Adding to the Service API results in
bringing in nifi-utils to the nifi-standard-services-api-nar, which is a bad
practice. The 'main' service api nar should not have a dependency on a util
class.
NIFI-5859: Added javadocs. Fixed pom.xml that was left pointing to snapshot
version of nar maven plugin
NIFI-5859: Addressing review feedback: adding component type, multiple
additional details into separate file(s)
This closes #3192.
Signed-off-by: Bryan Bende <[email protected]>
> Update NAR maven plugin to include information about Extensions
> ---------------------------------------------------------------
>
> Key: NIFI-5859
> URL: https://issues.apache.org/jira/browse/NIFI-5859
> Project: Apache NiFi
> Issue Type: New Feature
> Components: Tools and Build
> Reporter: Mark Payne
> Assignee: Mark Payne
> Priority: Major
>
> In order to have the NiFi Registry host any extensions, the registry will
> need a way to know what extensions exist in a given NAR. Currently, that
> information is not available directly.
> The NAR maven plugin should be updated to provide a list of extensions and
> for each one, provide at least the following minimal information:
> * Extension Type
> * Extension Name
> * Capability Description
> * Whether or not the component is Restricted, "sub-restrictions" it has, and
> explanations of both
> * Any Tags that the component has
> * If the component is a Controller Service, any Controller Service API's
> that it provides
> Additionally, it would be ideal to provide all documentation for the
> component within the NAR. It is best, though, not to write the documentation
> in HTML as is done now but rather in XML or some sort of form that provides
> the information in a structured way without any styling. This would allow the
> documentation to be rendered consistently, even if the styling changes from 1
> version to the next.
--
This message was sent by Atlassian JIRA
(v7.6.3#76005)
