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

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

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

    https://github.com/apache/nifi/pull/1445#discussion_r97922611
  
    --- Diff: nifi-docs/src/main/asciidoc/developer-guide.adoc ---
    @@ -848,6 +848,31 @@ Because this documentation is in an HTML format, you 
may include images and tabl
     to best describe this component.  The same methods can be used to provide 
advanced
     documentation for Processors, ControllerServices and ReportingTasks.
     
    +[[provenance_events]]
    +== Provenance Events
    +
    +The different event types for provenance reporting are:
    +
    +[options="header"]
    +|======================
    +|Provenance Event        |Description
    --- End diff --
    
    Making line endings consistent (removing all trailing '.'). 


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

Reply via email to