Re: Component documentation improvements

2016-01-18 Thread Joshua Davis
Oleg, Interesting document, what impact would it have on existing installations of NIFI? What would be the upgrade path for Custom Processors? Are we breaking compatibility with the previous way of doing documentation? Why not create a simple content repository that can hold the documentation

Re: Component documentation improvements

2016-01-18 Thread Oleg Zhurakousky
Josh FWIW, let’s use WIKI comments to maintain a discussion. It will be simpler in the end to compile a resolution and move on. Yet, I’ll reply here anyway. Yes, there will be breaking changes. Its not a question of IF, but rather WHEN. What we can do is make it less painful by introducing

Re: Component documentation improvements

2016-01-18 Thread Joe Witt
Very much agreed Dan. I submitted my comments on the wiki. On Mon, Jan 18, 2016 at 6:06 PM, dan bress wrote: > I just tossed some comments on the wikipage. > > TL;DR I took a look at generating docs as part of the build months ago. I > think its doable, and someone should

Re: Component documentation improvements

2016-01-18 Thread Matthew Burgess
I’d like to add comments to the wiki, may I have permissions for that? Thanks in advance, Matt On 1/18/16, 6:27 PM, "Joe Witt" wrote: >Very much agreed Dan. I submitted my comments on the wiki. > >On Mon, Jan 18, 2016 at 6:06 PM, dan bress wrote: >>

Re: Component documentation improvements

2016-01-18 Thread Oleg Zhurakousky
Joe As a general rule, breaking changes will happen in any and every framework and/or product - as a general fact of life. And that is what I meant with my statement. Having said that I do admit that reading it again comes across as if the decision about the approach proposed in the wiki has

Re: Component documentation improvements

2016-01-18 Thread Joe Witt
doing now. Try again in 30 secs. On Mon, Jan 18, 2016 at 6:54 PM, Matthew Burgess wrote: > I’d like to add comments to the wiki, may I have permissions for that? > > Thanks in advance, > Matt > > > > On 1/18/16, 6:27 PM, "Joe Witt" wrote: > >>Very much

Re: Component documentation improvements

2016-01-18 Thread Matthew Burgess
I’m in! Thanks :) On 1/18/16, 6:54 PM, "Joe Witt" wrote: >doing now. Try again in 30 secs. > >On Mon, Jan 18, 2016 at 6:54 PM, Matthew Burgess wrote: >> I’d like to add comments to the wiki, may I have permissions for that? >> >> Thanks in advance,

Re: Component documentation improvements

2016-01-18 Thread Joe Witt
Oleg, "Yes, there will be breaking changes. Its not a question of IF, but rather WHEN." I disagree. It is always a question of IF. We have to be extremely judicious in the use of breaking changes and we owe the user/developer based excellent justification in such cases. I will comment on the

Re: Component documentation improvements

2016-01-18 Thread dan bress
I just tossed some comments on the wikipage. TL;DR I took a look at generating docs as part of the build months ago. I think its doable, and someone should pursue it. On Mon, Jan 18, 2016 at 2:38 PM Joe Witt wrote: > Oleg, > > "Yes, there will be breaking changes. Its not