First would be to migrate docs from the wiki into the site-book so we have
a more concise place to point people to regarding documentation, because
there is some good stuff in the wiki, and some good things in the
site-books, but attempts to link them together is currently broken all over
the place (perfect example - this
<https://cwiki.apache.org/confluence/display/METRON/Metron+Architecture> is
the architecture page on the wiki).  I am thinking about some more concise
areas.  An example would cover things like "an intro to the environment"
(Maybe an architecture sub-bullet?) and goes through Storm, Kafka, HDFS,
etc. and covers "How its used" in a more succinct way.  Ignoring that, I
was thinking about things like:

https://cwiki.apache.org/confluence/display/METRON/Data+Loads
https://cwiki.apache.org/confluence/display/METRON/UI
https://cwiki.apache.org/confluence/display/METRON/Deployment+Scripts

Like I said before, some of this is covered in one location
<https://metron.apache.org/current-book/metron-interface/metron-alerts/index.html>,
but not another <https://cwiki.apache.org/confluence/display/METRON/UI>,
which is extremely confusing.  If I found a place where documentation said
it was coming soon, I wouldn't necessarily keep digging to find
documentation for that item.

Another thing I noticed via my recent perusal was that
https://cwiki.apache.org/confluence/display/METRON/Streaming is not
accurate.  Missing indexing, errors, etc.  I'm sure there are plenty more
examples as well, and I don't think it's reasonable to point people to the
wiki almost at all any longer (the squid walk-through is a good example of
something still very valuable) because doing so is overly confusing/nuanced
- we really need to get it migrated to the site-book.

Jon

On Fri, Oct 6, 2017 at 2:22 PM James Sirota <jsir...@apache.org> wrote:

> Can you give an example?  My personal view is that our docs explain Metron
> fundamentals pretty well.  If this is not the case, then would be willing
> to take a look and see how we can make them more consumable.  The problem
> with videos is that they become out of date very quickly and it's a lot of
> effort to re-record them.
>
> Thanks,
> James
>
> 06.10.2017, 11:05, "zeo...@gmail.com" <zeo...@gmail.com>:
> > To generalize a bit, I think it would be helpful to have a single or
> series
> > of recordings, write-ups, or even just pointers to some good high-level
> > docs to introduce people to each component used in Metron, and then a
> > description of how it's used in the Metron environment. I know I spend a
> > lot of time talking with people hitting the fundamentals, which is to be
> > expected for a growing project like ours. That helps provide a super
> > high-level context for what is happening in the cluster and where to look
> > if you're seeing certain types of issues.
> >
> > Jon
> >
> > On Fri, Oct 6, 2017 at 1:56 PM James Sirota <jsir...@apache.org> wrote:
> >
> >>  Hi Guys,
> >>
> >>  How about a meeting at 11 AM PST on this? Can everyone who needs to
> make
> >>  the meeting? If you could come with a Hadoop cluster (including Kafka,
> >>  storm, HDFS, Hbase) pre-installed I can walk you through the steps
> required
> >>  to install Metron. Does that seem reasonable?
> >>
> >>  Thanks,
> >>  James
> >>
> >>  04.10.2017, 23:01, "Ronirose Caryll De Castro" <
> >>  ronirose.decas...@pointwest.com.ph>:
> >>  > That's wonderful and very generous of the team.
> >>  >
> >>  > Here's on my end:
> >>  >
> >>  > ​- What environment are you installing on (a single VM, multiple VMs,
> >>  bare
> >>  > metal, AWS, etc)
> >>  > == Single VM, but I'm trying to install on multiple VMs
> >>  > - What OS are you using
> >>  > ​ ==​ Ubuntu Xenial and Zesty, but trying to use CentOS
> >>  > - How many sensors are you going to be consuming
> >>  > ​ == Unidentified. I was doing a test install at the moment.
> >>  >
> >>  > *Thank you!*
> >>  > *Caryll*
> >>  >
> >>  > On Thu, Oct 5, 2017 at 4:01 AM, James Sirota <jsir...@apache.org>
> wrote:
> >>  >
> >>  >> Yes the intent is for everyone that has any type of metron
> installation
> >>  >> issue or question attend the meeting
> >>  >>
> >>  >> 03.10.2017, 17:35, "Ronirose Caryll De Castro" <
> >>  >> ronirose.decas...@pointwest.com.ph>:
> >>  >> > Can those who are planning to install Metron join the meeting?
> >>  >> >
> >>  >> > *Thank you!*
> >>  >> > *Caryll*
> >>  >> >
> >>  >> > On Wed, Oct 4, 2017 at 7:11 AM, James Sirota <jsir...@apache.org>
> >>  wrote:
> >>  >> >
> >>  >> >> Hi Guys,
> >>  >> >>
> >>  >> >> How many people do we have with questions about installing
> Metron? I
> >>  >> can
> >>  >> >> take some time later in the week to schedule a meeting and get
> >>  everyone
> >>  >> >> unstuck
> >>  >> >>
> >>  >> >> -------------------
> >>  >> >> Thank you,
> >>  >> >>
> >>  >> >> James Sirota
> >>  >> >> PMC- Apache Metron
> >>  >> >> jsirota AT apache DOT org
> >>  >> >
> >>  >> > --
> >>  >> -------------------
> >>  >> Thank you,
> >>  >>
> >>  >> James Sirota
> >>  >> PPMC- Apache Metron (Incubating)
> >>  >> jsirota AT apache DOT org
> >>  >
> >>  > --
> >>  > CONFIDENTIALITY NOTICE: This email may contain confidential and
> >>  privileged
> >>  > material for the sole use of the intended recipient(s). Any review,
> use,
> >>  > distribution or disclosure by others is strictly prohibited. If you
> have
> >>  > received this communication in error, please notify the sender
> >>  immediately
> >>  > by e-mail and delete the message and any file attachments from your
> >>  > computer. There is no warranty that this email is error, virus or
> defect
> >>  > free. If this is a private communication it does not represent the
> views
> >>  of
> >>  > Pointwest Technologies Corporation or their related entities.
> >>
> >>  -------------------
> >>  Thank you,
> >>
> >>  James Sirota
> >>  PPMC- Apache Metron (Incubating)
> >>  jsirota AT apache DOT org
> > --
> >
> > Jon
>
> -------------------
> Thank you,
>
> James Sirota
> PPMC- Apache Metron (Incubating)
> jsirota AT apache DOT org
>
-- 

Jon

Reply via email to