You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@nifi.apache.org by "ASF GitHub Bot (JIRA)" <ji...@apache.org> on 2017/01/25 16:48:26 UTC

[jira] [Commented] (NIFI-3392) Enhance documentation for provenance event type definitions

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

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

GitHub user andrewmlim opened a pull request:

    https://github.com/apache/nifi/pull/1445

    NIFI-3392 Enhance documentation for provenance event type definitions

    Added new "Provenance Events" sections to User and Dev Guides.  Made a minor edit in Admin guide for consistent use of "Provenance events".

You can merge this pull request into a Git repository by running:

    $ git pull https://github.com/andrewmlim/nifi NIFI-3392

Alternatively you can review and apply these changes as the patch at:

    https://github.com/apache/nifi/pull/1445.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 #1445
    
----
commit bd9eb0ac6009845de9d5a34bd5384ade1945befd
Author: Andrew Lim <an...@gmail.com>
Date:   2017-01-25T16:44:40Z

    NIFI-3392 Enhance documentation for provenance event type definitions

----


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