metron-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Zeolla@GMail.com" <zeo...@gmail.com>
Subject Re: [VOTE] Update dev guidelines with format for sharing architecture source files and rendered images
Date Fri, 03 May 2019 21:19:17 GMT
+1 non-binding

I would only prefer that we change "Appropriate architecture diagrams
should be created in" to "Appropriate architecture diagrams must be created
in" but I'm good either way.

- Jon Zeolla
Zeolla@GMail.Com


On Fri, May 3, 2019 at 10:18 AM Michael Miklavcic <
michael.miklavcic@gmail.com> wrote:

> Yes, it is free James. We made sure of that in the original discussion.
>
> On Thu, May 2, 2019 at 9:33 PM James Sirota <jsirota@apache.org> wrote:
>
> > i am ok with it as long as we are not forcing people to buy stuff
> >
> > 02.05.2019, 18:18, "Michael Miklavcic" <michael.miklavcic@gmail.com>:
> > > Here's the latest discussion on the subject:
> > >
> >
> https://lists.apache.org/thread.html/0aa2b0b9ed4a0f0b0d8bb018c618e62de196565f9af71f347e504076@%3Cdev.metron.apache.org%3E
> > >
> > > I'd like to propose a vote to change our dev guidelines which will
> > clarify
> > > the tooling we use to produce diagrams and share the source files for
> > those
> > > diagrams. I propose the dev guidelines
> > >
> >
> https://cwiki.apache.org/confluence/display/METRON/Development+Guidelines
> > and
> > > PR checklist
> > >
> >
> https://github.com/apache/metron/blob/master/.github/PULL_REQUEST_TEMPLATE.md#for-documentation-related-changes
> > > be
> > > changed in the following ways:
> > >
> > >    1. Under "1.1 Contributing A Code Change"
> > >       1. Change <<"New features and significant bug fixes should be
> > >       documented in the JIRA and appropriate architecture diagrams
> > should be
> > >       attached. Major features may require a vote.">> to <<"New
> features
> > >       and significant bug fixes should be documented in the JIRA.
> > Appropriate
> > >       architecture diagrams should be created in https://www.draw.io/
> > > and committed
> > >       to source control as per section 2.4. Diagrams may be requested
> of
> > PR
> > >       submitters during review either as documentation or as an aid to
> > the
> > >       reviewer. Major features may also require a vote.">>
> > >    2. Under "2.4 Documentation"
> > >       1. New line item <<"Diagrams - We save architecture diagram
> source
> > >       files in an xml format rendered by draw.io (instructions below).
> > This
> > >       is the free tool of choice that we've agreed to use for
> exchanging
> > >       diagrams and their source files in Metron.">>
> > >       2. New line item <<Image and diagram source files belong in
> > >       "<module-name>/images-source" and rendered diagrams and images
> > belong in
> > >       "<module-name>/images."
> > >       3. New subsection <<"Creating and Modifying Diagrams">>.
This
> > section
> > >       would provide basic instructions for downloading source files
> from
> > >       draw.io.
> > >    3. Add a new checkbox item under PR checklist heading "For
> > documentation
> > >    related changes" with the following text
> > >       1. Have you ensured that any documentation diagrams have been
> > >       updated, along with their source files, using draw.io? See
> > >
> >
> https://cwiki.apache.org/confluence/display/METRON/Development+Guidelines
> > > for
> > >       instructions.
> > >    4. Here is the Jira for migrating/redoing existing diagrams
> > >       1. https://issues.apache.org/jira/browse/METRON-2099
> > >
> > > We require a minimum of 72 hours for a vote, not typically including
> > > weekend days. I'd like to leave this vote open until Wednesday 5/8,
> 12PM
> > > EDT. Please vote +1, -1, or 0 to abstain, and also indicate if your
> vote
> > is
> > > binding or non-binding.
> >
> > -------------------
> > Thank you,
> >
> > James Sirota
> > PMC- Apache Metron
> > jsirota AT apache DOT org
> >
> >
>

Mime
  • Unnamed multipart/alternative (inline, None, 0 bytes)
View raw message