Do you think it would be worthwhile to revise the enrichment and parser illustrations to use storm component symbols instead of generic symbols? That may add additional clarity to people who aren't familiar with all of the different components and how they work together. Still running through the updated docs but so far it's great stuff.
Jon On Mon, Sep 19, 2016 at 6:18 PM Kevin Waterson <kevin.water...@gmail.com> wrote: > I have a revised document for installation that I would like to > contribute. (ubuntu). > What I have not found is an easily accessible of contributing. This may be > due to my time poor life where I simply do not have the time to be > searching for such a link. > Where can I find community contributions link? > > Kev > > > > On Tue, Sep 20, 2016 at 8:06 AM, Casey Stella <ceste...@gmail.com> wrote: > >> Hi all, >> >> I noticed that our public facing docs were really getting stale. This is >> a normal thing in a fast moving project, but I imagine it's really hard for >> the community to get engaged with a project that has such details caught up >> inside of code and unit tests. As such, I thought it is reasonable to >> spend a little time ensuring the docs are better organized and clear, so I >> spent the day focusing on that: >> > >> 1. they were nonexistent in a lot of places like model as a service >> which are new >> >> >> 1. they were stale (mostly around stellar functions) >> >> >> 1. they were incomplete (parsers take configs, we don't document >> that..we now do) >> >> >> 1. they were not clear. I added some clarification and pictures of >> the topologies >> >> >> 1. they were in the wrong place (e.g. enrichment config documentation >> was in metron-common instead of metron-enrichment) >> >> >> 1. there wasn't a starting place from the top level Readme into the >> scary subdepths of the individual projects >> >> I also gave a small fully worked example for some of the commonly >> confusing tasks, like doing a stellar enrichment or deploying a MaaS >> model. I wrote them up, but they were caught up inside of PR comments, >> this just brought them into the docs. >> > >> You can find the PR here >> <https://github.com/apache/incubator-metron/pull/260>. It's already >> gotten a +1, but I'd love to see some discussion around what ELSE we can do >> to make it easier to get community contributions. After all, there would >> be no Metron without its community. >> >> Best, >> >> Casey >> > > > > -- > -- > "Democracy is two wolves and a lamb voting on what to have for lunch. > Liberty is a well-armed lamb contesting the vote." > -- Jon
