nifi-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Mark Payne (JIRA)" <j...@apache.org>
Subject [jira] [Commented] (NIFI-393) Update developer guide based on feedback from community
Date Thu, 05 Mar 2015 20:08:38 GMT

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

Mark Payne commented on NIFI-393:
---------------------------------

Jenn,


Sorry, it’s for the developer guide. I updated the title of the ticket.


Thanks

-Mark






From: Lovekesh Garg (JIRA)
Sent: ‎Thursday‎, ‎March‎ ‎5‎, ‎2015 ‎2‎:‎55‎ ‎PM
To: Mark Payne






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

Jennifer Patricia Barnabee commented on NIFI-393:
-------------------------------------------------

Is this for the Developer Guide or the User Guide? If the former, then we'll probably want
to create a similar ticket for the latter -- just to capture that as well.




--
This message was sent by Atlassian JIRA
(v6.3.4#6332)


> Update developer guide based on feedback from community
> -------------------------------------------------------
>
>                 Key: NIFI-393
>                 URL: https://issues.apache.org/jira/browse/NIFI-393
>             Project: Apache NiFi
>          Issue Type: Improvement
>          Components: Documentation & Website
>            Reporter: Mark Payne
>
> Ryan provided some great feedback about his experience when implementing NIFI-238. We
should incorporate his feedback into the developer guide to improve the experience. His feedback
is provided here:
> The reviews and help were great, since I started before the guide was 
> available. Even with the guide, it was a little difficult to know what I 
> should let the framework handle for me, especially given that the review 
> comments helped me fix some things I copied from elsewhere (like 
> catching Throwable). Maybe a good example processor would help.
> Overall, the API makes sense and works well. It is somewhat strange to 
> use a callback to write data (though I can see why) and maybe some 
> explanation would help there.
> There is some great stuff in the developer guide, but it is a big chunk 
> of text. I think it could use some diagrams and maybe be broken into 
> several pages that are cross-linked. Examples are always good too, like 
> when you would use certain annotations and what to watch out for (like 
> using volatile for fields set in @OnScheduled).
> I hope that helps, I'll have to take a closer look at the current guide 
> since I had already gotten started when I read it. Thanks for all your help!
> rb
> -- 
> Ryan Blue
> Software Engineer
> Cloudera, Inc.



--
This message was sent by Atlassian JIRA
(v6.3.4#6332)

Mime
View raw message