Return-Path: X-Original-To: apmail-nifi-commits-archive@minotaur.apache.org Delivered-To: apmail-nifi-commits-archive@minotaur.apache.org Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by minotaur.apache.org (Postfix) with SMTP id A80F6172EC for ; Thu, 5 Mar 2015 13:10:59 +0000 (UTC) Received: (qmail 34932 invoked by uid 500); 5 Mar 2015 13:10:59 -0000 Delivered-To: apmail-nifi-commits-archive@nifi.apache.org Received: (qmail 34892 invoked by uid 500); 5 Mar 2015 13:10:59 -0000 Mailing-List: contact commits-help@nifi.incubator.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@nifi.incubator.apache.org Delivered-To: mailing list commits@nifi.incubator.apache.org Received: (qmail 34883 invoked by uid 99); 5 Mar 2015 13:10:59 -0000 Received: from athena.apache.org (HELO athena.apache.org) (140.211.11.136) by apache.org (qpsmtpd/0.29) with ESMTP; Thu, 05 Mar 2015 13:10:59 +0000 X-ASF-Spam-Status: No, hits=-2000.0 required=5.0 tests=ALL_TRUSTED,T_RP_MATCHES_RCVD X-Spam-Check-By: apache.org Received: from [140.211.11.3] (HELO mail.apache.org) (140.211.11.3) by apache.org (qpsmtpd/0.29) with SMTP; Thu, 05 Mar 2015 13:10:58 +0000 Received: (qmail 34730 invoked by uid 99); 5 Mar 2015 13:10:38 -0000 Received: from arcas.apache.org (HELO arcas.apache.org) (140.211.11.28) by apache.org (qpsmtpd/0.29) with ESMTP; Thu, 05 Mar 2015 13:10:38 +0000 Date: Thu, 5 Mar 2015 13:10:38 +0000 (UTC) From: "Mark Payne (JIRA)" To: commits@nifi.incubator.apache.org Message-ID: In-Reply-To: References: Subject: [jira] [Created] (NIFI-393) Update user guide based on feedback from community MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 7bit X-JIRA-FingerPrint: 30527f35849b9dde25b450d4833f0394 X-Virus-Checked: Checked by ClamAV on apache.org Mark Payne created NIFI-393: ------------------------------- Summary: Update user 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)