Definitely worthwhile. I discussed something similar (but more general) a little while back here <https://lists.apache.org/thread.html/17904a10b8f41a97dfac84dcb3c22a1a0229fa9db170fa762741c2fe@%3Cdev.metron.apache.org%3E>. Totally worth the effort IMO.
Jon On Mon, May 8, 2017 at 7:36 PM Casey Stella <ceste...@gmail.com> wrote: > +1 for parser docs > > On Mon, May 8, 2017 at 7:35 PM, Simon Elliston Ball < > si...@simonellistonball.com> wrote: > > > Quick thought, and please shoot me down if this has already been thought > > of, but…. > > > > Would it be worthwhile if we put some per parser docs into the repo, > > essentially a README.md per major parser class, which would in theory be > > picked up by the docbook? We don’t really have much documentation right > now > > on the effect of parserConfig settings for example. > > > > Similarly, is this something worth considering in the package format, or > > at least in the archetype proposed by METRON-777 (paging Ottto!) > > > > Worth the effort? I’m happy to do at least a few of the more recent ones > > I’ve spent meaningful time with. > > > > Simon > -- Jon
