[
https://issues.apache.org/jira/browse/NIFI-3392?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15838099#comment-15838099
]
ASF GitHub Bot commented on NIFI-3392:
--------------------------------------
Github user andrewmlim commented on the issue:
https://github.com/apache/nifi/pull/1445
When reviewing, please note that the tables added to the User and Dev
Guides, while similar, are actually different. The User Guide has more simple
descriptions of the provenance event types, whereas, the Dev Guide has more dev
relevant material included from
https://github.com/apache/nifi/blob/master/nifi-api/src/main/java/org/apache/nifi/provenance/ProvenanceEventType.java
> Enhance documentation for provenance event type definitions
> -----------------------------------------------------------
>
> Key: NIFI-3392
> URL: https://issues.apache.org/jira/browse/NIFI-3392
> Project: Apache NiFi
> Issue Type: Improvement
> Components: Documentation & Website
> Affects Versions: 1.1.1
> Reporter: Andy LoPresto
> Assignee: Andrew Lim
>
> The provenance events can be unfamiliar to new users, and the nuance of the
> event types can be confusing even to experienced users and developers. The
> documentation should be improved to contain a definition table of the various
> event types ({{CREATE}}, {{DROP}}, etc.), their meaning, and (for developers)
> when to use each type if writing their own provenance reporting code.
> A comprehensive list of event types is available (and discussed somewhat) in
> [{{ProvenanceEventType.java}}|https://github.com/apache/nifi/blob/master/nifi-api/src/main/java/org/apache/nifi/provenance/ProvenanceEventType.java].
>
--
This message was sent by Atlassian JIRA
(v6.3.4#6332)
