I'm also partial to draw.io. Jon Zeolla
On Wed, Apr 17, 2019, 9:48 PM Otto Fowler <ottobackwa...@gmail.com> wrote: > Also, the section should either have a blurb and like for draw.io or a > reference footnote etc. > > > On April 17, 2019 at 21:36:03, Otto Fowler (ottobackwa...@gmail.com) > wrote: > > I think we should try draw.io, and should add ( with vote i think ) a new > section to the developer documention like: > Architecture Diagrams > > The project supports the XXXXXXX format along with accompanying image > version in XXXX format for architectural diagrams. > > Architectural diagrams are important because reasons, and while they may > not be required for a PR with architectural implications, they may be > requested as part of the review process when deemed prudent. > > ————— > > Along with that, we can discuss how to store them in git and have them > integrated with the documentation *and* the website. > > > > > On April 16, 2019 at 11:57:46, Michael Miklavcic ( > michael.miklav...@gmail.com) wrote: > > Hi devs, > > We've talked about this fairly ad hoc on PRs before, and I thought it worth > bringing up more formally. Architecture diagrams are a strategically useful > addition to the core developer documentation. Examples include: > > 1. > > https://github.com/apache/metron/tree/master/metron-platform/metron-parsing#parser-architecture > 2. > > https://github.com/apache/metron/tree/master/metron-platform/metron-enrichment/metron-enrichment-storm#enrichment-architecture > 3. > > https://github.com/apache/metron/tree/master/metron-platform/metron-job#job-state-statechart > 4. > > https://github.com/apache/metron/tree/master/metron-interface#knox-requestresponse-flow > > We currently have a couple formats for maintaining the source diagram files > across the project as well as a few diagrams with no source files. I've > personally used draw.io in the past because it's publicly available and > free to use. I also see Powerpoint. > > 1. No source file - > > https://github.com/apache/metron/blob/master/metron-analytics/metron-maas-service/maas_arch.png > 2. draw.io source - > > https://github.com/apache/metron/blob/master/metron-platform/metron-job/metron-job_state_statechart_diagram.xml > 3. powerpoint - > > https://github.com/apache/metron/blob/master/metron-interface/flow_diagrams.pptx > > I'm interested in what the developer community has access to and would > prefer. As I mentioned before, I'm partial to draw.io if only because it > does not require a fee to use. PowerPoint is probably easier to use, but it > does limit the contributors who can edit the images. Are there other > options that people have used they would prefer over any of the above? Are > we still interested in maintaining the source files (my personal vote is > yes)? > > Best, > Mike >
