[ 
https://issues.apache.org/jira/browse/NIFI-5859?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16710179#comment-16710179
 ] 

ASF GitHub Bot commented on NIFI-5859:
--------------------------------------

Github user markap14 commented on a diff in the pull request:

    https://github.com/apache/nifi/pull/3192#discussion_r239102417
  
    --- Diff: 
nifi-nar-bundles/nifi-standard-services/nifi-standard-services-api-nar/pom.xml 
---
    @@ -26,6 +26,12 @@
             <source.skip>true</source.skip>
         </properties>
         <dependencies>
    +        <dependency>
    +            <groupId>org.apache.nifi</groupId>
    +            <artifactId>nifi-jetty-bundle</artifactId>
    +            <version>1.9.0-SNAPSHOT</version>
    +            <type>nar</type>
    --- End diff --
    
    It is needed if any component has a Custom UI. Otherwise, the NAR plugin is 
unable to generate the documentation needed. While NiFi will create the linkage 
for you, it can do so because it knows that the NAR is in the "lib" directory. 
Without this, the plugin doesn't know what version of the jetty bundle to use. 
This will be necessary for any component that contains a Custom UI. It is, 
however, considered a best practice already to include this in such a case, 
because you are explicitly depending on those classes being in the classpath, 
so you should explicitly declare it.


> 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)

Reply via email to