[
https://issues.apache.org/jira/browse/NIFI-393?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Mark Payne updated NIFI-393:
----------------------------
Summary: Update developer guide based on feedback from community (was:
Update user guide based on feedback from community)
> 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)
