Kristin, Thanks for forwarding that as it does make it more clear what you're looking for. I think it is safe to say we do not have documentation or diagrams to the level of detail shown in the png/drawing. Our overview and docs provided on the site are probably the best we have right now that I know of. We do generate javadocs during the build process and they do get published to the maven artifact repository.
I believe there are code analysis tools that will generate UML or similar diagrams but not sure. There is value in generating such documentation as it makes hacking on the core a more approachable problem. We've emphasized the points of extension as places where to put solid documentation more so than the core but that is something we should try to round out over time. I don't personally view the production of that level of documentation as being related to any particular version (0.x, 1.0..). For the nifi-api we should have, in my opinion, extremely good and thorough Javadocs and explanation of packages. That forms the most intentional public-api of the project. Thanks Joe On Thu, Jun 18, 2015 at 9:57 AM, Clemens, Kristin E. <[email protected]> wrote: > Joe, I found something even more specific to what I'd like, if it exists: > > http://www.simsoup.info/SimSoup/Design/SimSoup_System_Diagram.png > > -----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
