[
https://issues.apache.org/jira/browse/NIFI-5859?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16704855#comment-16704855
]
ASF GitHub Bot commented on NIFI-5859:
--------------------------------------
GitHub user markap14 opened a pull request:
https://github.com/apache/nifi/pull/3192
NIFI-5859: Added XML-based documentation writer that can be used to d…
…ocument 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.
Thank you for submitting a contribution to Apache NiFi.
In order to streamline the review of the contribution we ask you
to ensure the following steps have been taken:
### For all changes:
- [ ] Is there a JIRA ticket associated with this PR? Is it referenced
in the commit message?
- [ ] Does your PR title start with NIFI-XXXX where XXXX is the JIRA number
you are trying to resolve? Pay particular attention to the hyphen "-" character.
- [ ] Has your PR been rebased against the latest commit within the target
branch (typically master)?
- [ ] Is your initial contribution a single, squashed commit?
### For code changes:
- [ ] Have you ensured that the full suite of tests is executed via mvn
-Pcontrib-check clean install at the root nifi folder?
- [ ] Have you written or updated unit tests to verify your changes?
- [ ] If adding new dependencies to the code, are these dependencies
licensed in a way that is compatible for inclusion under [ASF
2.0](http://www.apache.org/legal/resolved.html#category-a)?
- [ ] If applicable, have you updated the LICENSE file, including the main
LICENSE file under nifi-assembly?
- [ ] If applicable, have you updated the NOTICE file, including the main
NOTICE file found under nifi-assembly?
- [ ] If adding new Properties, have you added .displayName in addition to
.name (programmatic access) for each of the new properties?
### For documentation related changes:
- [ ] Have you ensured that format looks appropriate for the output in
which it is rendered?
### Note:
Please ensure that once the PR is submitted, you check travis-ci for build
issues and submit an update to your PR as soon as possible.
You can merge this pull request into a Git repository by running:
$ git pull https://github.com/markap14/nifi NIFI-5859
Alternatively you can review and apply these changes as the patch at:
https://github.com/apache/nifi/pull/3192.patch
To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:
This closes #3192
----
commit e07d9be3b07ade875c87d6463487807ca2bf5246
Author: Mark Payne <markap14@...>
Date: 2018-11-15T17:07:08Z
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.
----
> 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)
