Sean, that helps quite a lot, thank you! I missed that in my perusal of the documentation. I'm talking about something more elaborate, though. I don't believe we have everything documented yet with Javadoc, do we?
Joe, I'm thinking something along the lines (eventually) of online Javadoc [1], but even with a fully documented API it would be useful to have something like the design document for the NextGen Hadoop MR Framework architecture [2]. Were there any design docs created at any point? The HDFS Architecture Guide [3] is also nice, but still overly broad as it only touches on HDFS rather than the Hadoop codebase itself. 1. https://hadoop.apache.org/docs/r2.6.0/api/ 2. https://issues.apache.org/jira/secure/attachment/12486023/MapReduce_NextGen_Architecture.pdf 3. http://hadoop.apache.org/docs/current/hadoop-project-dist/hadoop-hdfs/HdfsDesign.html -----Original Message----- From: Joe Witt [mailto:[email protected]] Sent: Wednesday, June 17, 2015 9:37 PM To: [email protected] Subject: Re: System Architecture, Workflow, etc., Knowledgebase Kristin, Can you point to docs like what you're thinking of from other projects? Just want to be sure I understand what you're thinking of. Thanks Joe On Wed, Jun 17, 2015 at 12:52 PM, Sean Busbey <[email protected]> wrote: > do you mean something like this overview that got added: > > http://nifi.incubator.apache.org/docs/nifi-docs/html/overview.html#nif > i-architecture > > Or example system diagrams that show how NiFi would integrate into a > larger deployment? > > On Wed, Jun 17, 2015 at 11:04 AM, Clemens, Kristin E. < > [email protected]> wrote: > >> Hi all! >> >> While getting to know this project I originally came to many faulty >> conclusions based on my limited knowledge of enterprise-scope >> projects. I can only imagine that much of this would have been >> avoided, or at least dealt with more swiftly, if there had been some >> sort of knowledge base with diagrams and the like detailing the >> structure of the entire system. Even package diagrams would be >> helpful, as would explanations for decisions about where certain classes >> were placed in the overall module tree. >> >> Does anything like this exist already? If so, could it be uploaded >> to confluence in at least piecemeal form? If not, what do others >> think about making this an important to-do before v1.0.0? I'd be >> happy to help when I have free time, especially since I've had to do >> quite a lot of manual stepping through various data- and workflows, >> but it's quite a large undertaking and I don't think I'd be up for >> spearheading something of that magnitude at this point. >> >> Thanks! >> Kristin Clemens >> > > > > -- > Sean
