You are viewing a plain text version of this content. The canonical link for it is here.
Posted to user@flink.apache.org by Vishnu Viswanath <vi...@gmail.com> on 2016/09/04 18:11:37 UTC
[SUGGESTION] Stack Overflow Documentation for Apache Flink
Hi All,
Why don't we make use of Stackoverflow's new documentation feature to do
some documentation of Apache Flink.
To start, at least 5 SO users should commit to document, who has at least150
reputation and have at least 1 positively scored answer in Flink tag.
http://stackoverflow.com/documentation/apache-flink
Regards,
Vishnu Viswanath
Re: [SUGGESTION] Stack Overflow Documentation for Apache Flink
Posted by Vishnu Viswanath <vi...@gmail.com>.
Hi,
This is my understanding of SO Documentation:
1. Any one in the community can contribute, others can validate and improve
2. Users can request a topic
3. As Max mentioned, the documentation is more example oriented and it
doesn't have to be as comprehensive as the Flink's primary documentation.
(Yes there might be some overlap and duplication)
e.g., this is one of the documentation of apache-spark tag :
http://stackoverflow.com/documentation/apache-spark/833/introduction-to-apache-spark#t=201609060203001533016
Thanks,
Vishnu
On Mon, Sep 5, 2016 at 8:37 AM, Robert Metzger <rm...@apache.org> wrote:
> It seems that the content on SO is licensed under cc by-sa 3.0 with
> attribution required
> The Apache Legal FAQ is not completely clear about that case
> http://www.apache.org/legal/resolved.html#cc-sa
>
> But if we want, we could at least ask the legal PMC if we can add some of
> the content from SO into the Flink documentation.
>
>
> On Mon, Sep 5, 2016 at 1:44 PM, Matthias J. Sax <mj...@apache.org> wrote:
>
>> I voted. It's live now.
>>
>> The advance of SO documentation is also, that people not familiar with
>> Apache might do some documentation (but would never open a PR). Of
>> course, as community, we should put the focus on web page docs. But
>> having something additional can't hurt.
>>
>> From my experience, it is also good if certain aspects are describe by
>> different people and thus with different point of view. It ofter helps
>> users to understand better.
>>
>> Also reoccurring SO question can be handled nicely by SO documentation.
>>
>> -Matthias
>>
>> On 09/05/2016 01:25 PM, Till Rohrmann wrote:
>> > I've understood the SO documentation approach similar to what Max has
>> > said. I see it as source of code examples which illustrate Flink
>> > concepts and which is maintained by the SO community.
>> >
>> > On Mon, Sep 5, 2016 at 1:09 PM, Maximilian Michels <mxm@apache.org
>> > <ma...@apache.org>> wrote:
>> >
>> > I thought it is not about outsourcing but about providing an
>> > example-based documentation on SO which can be easily edited by the
>> SO
>> > community. The work can be fed back to the official Flink
>> > documentation which will always be on flink.apache.org
>> > <http://flink.apache.org>.
>> >
>> > On Mon, Sep 5, 2016 at 12:42 PM, Fabian Hueske <fhueske@gmail.com
>> > <ma...@gmail.com>> wrote:
>> > > Thanks for the suggestion Vishnu!
>> > > Stackoverflow documentation looks great. I like the easy
>> > contribution and
>> > > versioning features.
>> > >
>> > > However, I am a bit skeptical. IMO, Flink's primary documentation
>> > must be
>> > > hosted by Apache. Out-sourcing such an important aspect of a
>> > project to an
>> > > external service is not an option for me.
>> > > This would mean, that documentation on SO would be an additional /
>> > secondary
>> > > documentation. I see two potential problems with that:
>> > >
>> > > - It is duplicate effort to keep two documentations up-to-date.
>> > Adding a new
>> > > feature of changing some behavior must be documented in two
>> places.
>> > > - Efforts to improve documentation might split up, i.e., the
>> primary
>> > > documentation might receive less improvements and contributions.
>> > >
>> > > Of course, this is just my opinion but I think it is worth to
>> > mention these
>> > > points.
>> > >
>> > > Thanks,
>> > > Fabian
>> > >
>> > > 2016-09-05 12:22 GMT+02:00 Ravikumar Hawaldar
>> > > <ravikumar.hawaldar@gmail.com <mailto:ravikumar.hawaldar@gma
>> il.com>>:
>> > >>
>> > >> Hi,
>> > >>
>> > >>
>> > >> I just committed to apache-flink documentation on SO, one more
>> commit
>> > >> required. Nice idea to document on SO Vishnu.
>> > >>
>> > >>
>> > >>
>> > >> Regards,
>> > >>
>> > >> Ravikumar
>> > >>
>> > >> On 5 September 2016 at 14:22, Maximilian Michels <mxm@apache.org
>> > <ma...@apache.org>> wrote:
>> > >>>
>> > >>> Hi!
>> > >>>
>> > >>> This looks neat. Let's try it out. I just voted.
>> > >>>
>> > >>> Cheers,
>> > >>> Max
>> > >>>
>> > >>> On Sun, Sep 4, 2016 at 8:11 PM, Vishnu Viswanath
>> > >>> <vishnu.viswanath25@gmail.com
>> > <ma...@gmail.com>> wrote:
>> > >>> > Hi All,
>> > >>> >
>> > >>> > Why don't we make use of Stackoverflow's new documentation
>> > feature to
>> > >>> > do
>> > >>> > some documentation of Apache Flink.
>> > >>> >
>> > >>> > To start, at least 5 SO users should commit to document, who
>> > has at
>> > >>> > least150
>> > >>> > reputation and have at least 1 positively scored answer in
>> > Flink tag.
>> > >>> >
>> > >>> > http://stackoverflow.com/documentation/apache-flink
>> > <http://stackoverflow.com/documentation/apache-flink>
>> > >>> >
>> > >>> > Regards,
>> > >>> > Vishnu Viswanath
>> > >>
>> > >>
>> > >
>> >
>> >
>>
>>
>
Re: [SUGGESTION] Stack Overflow Documentation for Apache Flink
Posted by Robert Metzger <rm...@apache.org>.
It seems that the content on SO is licensed under cc by-sa 3.0 with
attribution required
The Apache Legal FAQ is not completely clear about that case
http://www.apache.org/legal/resolved.html#cc-sa
But if we want, we could at least ask the legal PMC if we can add some of
the content from SO into the Flink documentation.
On Mon, Sep 5, 2016 at 1:44 PM, Matthias J. Sax <mj...@apache.org> wrote:
> I voted. It's live now.
>
> The advance of SO documentation is also, that people not familiar with
> Apache might do some documentation (but would never open a PR). Of
> course, as community, we should put the focus on web page docs. But
> having something additional can't hurt.
>
> From my experience, it is also good if certain aspects are describe by
> different people and thus with different point of view. It ofter helps
> users to understand better.
>
> Also reoccurring SO question can be handled nicely by SO documentation.
>
> -Matthias
>
> On 09/05/2016 01:25 PM, Till Rohrmann wrote:
> > I've understood the SO documentation approach similar to what Max has
> > said. I see it as source of code examples which illustrate Flink
> > concepts and which is maintained by the SO community.
> >
> > On Mon, Sep 5, 2016 at 1:09 PM, Maximilian Michels <mxm@apache.org
> > <ma...@apache.org>> wrote:
> >
> > I thought it is not about outsourcing but about providing an
> > example-based documentation on SO which can be easily edited by the
> SO
> > community. The work can be fed back to the official Flink
> > documentation which will always be on flink.apache.org
> > <http://flink.apache.org>.
> >
> > On Mon, Sep 5, 2016 at 12:42 PM, Fabian Hueske <fhueske@gmail.com
> > <ma...@gmail.com>> wrote:
> > > Thanks for the suggestion Vishnu!
> > > Stackoverflow documentation looks great. I like the easy
> > contribution and
> > > versioning features.
> > >
> > > However, I am a bit skeptical. IMO, Flink's primary documentation
> > must be
> > > hosted by Apache. Out-sourcing such an important aspect of a
> > project to an
> > > external service is not an option for me.
> > > This would mean, that documentation on SO would be an additional /
> > secondary
> > > documentation. I see two potential problems with that:
> > >
> > > - It is duplicate effort to keep two documentations up-to-date.
> > Adding a new
> > > feature of changing some behavior must be documented in two places.
> > > - Efforts to improve documentation might split up, i.e., the
> primary
> > > documentation might receive less improvements and contributions.
> > >
> > > Of course, this is just my opinion but I think it is worth to
> > mention these
> > > points.
> > >
> > > Thanks,
> > > Fabian
> > >
> > > 2016-09-05 12:22 GMT+02:00 Ravikumar Hawaldar
> > > <ravikumar.hawaldar@gmail.com <mailto:ravikumar.hawaldar@gmail.com
> >>:
> > >>
> > >> Hi,
> > >>
> > >>
> > >> I just committed to apache-flink documentation on SO, one more
> commit
> > >> required. Nice idea to document on SO Vishnu.
> > >>
> > >>
> > >>
> > >> Regards,
> > >>
> > >> Ravikumar
> > >>
> > >> On 5 September 2016 at 14:22, Maximilian Michels <mxm@apache.org
> > <ma...@apache.org>> wrote:
> > >>>
> > >>> Hi!
> > >>>
> > >>> This looks neat. Let's try it out. I just voted.
> > >>>
> > >>> Cheers,
> > >>> Max
> > >>>
> > >>> On Sun, Sep 4, 2016 at 8:11 PM, Vishnu Viswanath
> > >>> <vishnu.viswanath25@gmail.com
> > <ma...@gmail.com>> wrote:
> > >>> > Hi All,
> > >>> >
> > >>> > Why don't we make use of Stackoverflow's new documentation
> > feature to
> > >>> > do
> > >>> > some documentation of Apache Flink.
> > >>> >
> > >>> > To start, at least 5 SO users should commit to document, who
> > has at
> > >>> > least150
> > >>> > reputation and have at least 1 positively scored answer in
> > Flink tag.
> > >>> >
> > >>> > http://stackoverflow.com/documentation/apache-flink
> > <http://stackoverflow.com/documentation/apache-flink>
> > >>> >
> > >>> > Regards,
> > >>> > Vishnu Viswanath
> > >>
> > >>
> > >
> >
> >
>
>
Re: [SUGGESTION] Stack Overflow Documentation for Apache Flink
Posted by "Matthias J. Sax" <mj...@apache.org>.
I voted. It's live now.
The advance of SO documentation is also, that people not familiar with
Apache might do some documentation (but would never open a PR). Of
course, as community, we should put the focus on web page docs. But
having something additional can't hurt.
From my experience, it is also good if certain aspects are describe by
different people and thus with different point of view. It ofter helps
users to understand better.
Also reoccurring SO question can be handled nicely by SO documentation.
-Matthias
On 09/05/2016 01:25 PM, Till Rohrmann wrote:
> I've understood the SO documentation approach similar to what Max has
> said. I see it as source of code examples which illustrate Flink
> concepts and which is maintained by the SO community.
>
> On Mon, Sep 5, 2016 at 1:09 PM, Maximilian Michels <mxm@apache.org
> <ma...@apache.org>> wrote:
>
> I thought it is not about outsourcing but about providing an
> example-based documentation on SO which can be easily edited by the SO
> community. The work can be fed back to the official Flink
> documentation which will always be on flink.apache.org
> <http://flink.apache.org>.
>
> On Mon, Sep 5, 2016 at 12:42 PM, Fabian Hueske <fhueske@gmail.com
> <ma...@gmail.com>> wrote:
> > Thanks for the suggestion Vishnu!
> > Stackoverflow documentation looks great. I like the easy
> contribution and
> > versioning features.
> >
> > However, I am a bit skeptical. IMO, Flink's primary documentation
> must be
> > hosted by Apache. Out-sourcing such an important aspect of a
> project to an
> > external service is not an option for me.
> > This would mean, that documentation on SO would be an additional /
> secondary
> > documentation. I see two potential problems with that:
> >
> > - It is duplicate effort to keep two documentations up-to-date.
> Adding a new
> > feature of changing some behavior must be documented in two places.
> > - Efforts to improve documentation might split up, i.e., the primary
> > documentation might receive less improvements and contributions.
> >
> > Of course, this is just my opinion but I think it is worth to
> mention these
> > points.
> >
> > Thanks,
> > Fabian
> >
> > 2016-09-05 12:22 GMT+02:00 Ravikumar Hawaldar
> > <ravikumar.hawaldar@gmail.com <ma...@gmail.com>>:
> >>
> >> Hi,
> >>
> >>
> >> I just committed to apache-flink documentation on SO, one more commit
> >> required. Nice idea to document on SO Vishnu.
> >>
> >>
> >>
> >> Regards,
> >>
> >> Ravikumar
> >>
> >> On 5 September 2016 at 14:22, Maximilian Michels <mxm@apache.org
> <ma...@apache.org>> wrote:
> >>>
> >>> Hi!
> >>>
> >>> This looks neat. Let's try it out. I just voted.
> >>>
> >>> Cheers,
> >>> Max
> >>>
> >>> On Sun, Sep 4, 2016 at 8:11 PM, Vishnu Viswanath
> >>> <vishnu.viswanath25@gmail.com
> <ma...@gmail.com>> wrote:
> >>> > Hi All,
> >>> >
> >>> > Why don't we make use of Stackoverflow's new documentation
> feature to
> >>> > do
> >>> > some documentation of Apache Flink.
> >>> >
> >>> > To start, at least 5 SO users should commit to document, who
> has at
> >>> > least150
> >>> > reputation and have at least 1 positively scored answer in
> Flink tag.
> >>> >
> >>> > http://stackoverflow.com/documentation/apache-flink
> <http://stackoverflow.com/documentation/apache-flink>
> >>> >
> >>> > Regards,
> >>> > Vishnu Viswanath
> >>
> >>
> >
>
>
Re: [SUGGESTION] Stack Overflow Documentation for Apache Flink
Posted by Till Rohrmann <tr...@apache.org>.
I've understood the SO documentation approach similar to what Max has said.
I see it as source of code examples which illustrate Flink concepts and
which is maintained by the SO community.
On Mon, Sep 5, 2016 at 1:09 PM, Maximilian Michels <mx...@apache.org> wrote:
> I thought it is not about outsourcing but about providing an
> example-based documentation on SO which can be easily edited by the SO
> community. The work can be fed back to the official Flink
> documentation which will always be on flink.apache.org.
>
> On Mon, Sep 5, 2016 at 12:42 PM, Fabian Hueske <fh...@gmail.com> wrote:
> > Thanks for the suggestion Vishnu!
> > Stackoverflow documentation looks great. I like the easy contribution and
> > versioning features.
> >
> > However, I am a bit skeptical. IMO, Flink's primary documentation must be
> > hosted by Apache. Out-sourcing such an important aspect of a project to
> an
> > external service is not an option for me.
> > This would mean, that documentation on SO would be an additional /
> secondary
> > documentation. I see two potential problems with that:
> >
> > - It is duplicate effort to keep two documentations up-to-date. Adding a
> new
> > feature of changing some behavior must be documented in two places.
> > - Efforts to improve documentation might split up, i.e., the primary
> > documentation might receive less improvements and contributions.
> >
> > Of course, this is just my opinion but I think it is worth to mention
> these
> > points.
> >
> > Thanks,
> > Fabian
> >
> > 2016-09-05 12:22 GMT+02:00 Ravikumar Hawaldar
> > <ra...@gmail.com>:
> >>
> >> Hi,
> >>
> >>
> >> I just committed to apache-flink documentation on SO, one more commit
> >> required. Nice idea to document on SO Vishnu.
> >>
> >>
> >>
> >> Regards,
> >>
> >> Ravikumar
> >>
> >> On 5 September 2016 at 14:22, Maximilian Michels <mx...@apache.org>
> wrote:
> >>>
> >>> Hi!
> >>>
> >>> This looks neat. Let's try it out. I just voted.
> >>>
> >>> Cheers,
> >>> Max
> >>>
> >>> On Sun, Sep 4, 2016 at 8:11 PM, Vishnu Viswanath
> >>> <vi...@gmail.com> wrote:
> >>> > Hi All,
> >>> >
> >>> > Why don't we make use of Stackoverflow's new documentation feature to
> >>> > do
> >>> > some documentation of Apache Flink.
> >>> >
> >>> > To start, at least 5 SO users should commit to document, who has at
> >>> > least150
> >>> > reputation and have at least 1 positively scored answer in Flink tag.
> >>> >
> >>> > http://stackoverflow.com/documentation/apache-flink
> >>> >
> >>> > Regards,
> >>> > Vishnu Viswanath
> >>
> >>
> >
>
Re: [SUGGESTION] Stack Overflow Documentation for Apache Flink
Posted by Maximilian Michels <mx...@apache.org>.
I thought it is not about outsourcing but about providing an
example-based documentation on SO which can be easily edited by the SO
community. The work can be fed back to the official Flink
documentation which will always be on flink.apache.org.
On Mon, Sep 5, 2016 at 12:42 PM, Fabian Hueske <fh...@gmail.com> wrote:
> Thanks for the suggestion Vishnu!
> Stackoverflow documentation looks great. I like the easy contribution and
> versioning features.
>
> However, I am a bit skeptical. IMO, Flink's primary documentation must be
> hosted by Apache. Out-sourcing such an important aspect of a project to an
> external service is not an option for me.
> This would mean, that documentation on SO would be an additional / secondary
> documentation. I see two potential problems with that:
>
> - It is duplicate effort to keep two documentations up-to-date. Adding a new
> feature of changing some behavior must be documented in two places.
> - Efforts to improve documentation might split up, i.e., the primary
> documentation might receive less improvements and contributions.
>
> Of course, this is just my opinion but I think it is worth to mention these
> points.
>
> Thanks,
> Fabian
>
> 2016-09-05 12:22 GMT+02:00 Ravikumar Hawaldar
> <ra...@gmail.com>:
>>
>> Hi,
>>
>>
>> I just committed to apache-flink documentation on SO, one more commit
>> required. Nice idea to document on SO Vishnu.
>>
>>
>>
>> Regards,
>>
>> Ravikumar
>>
>> On 5 September 2016 at 14:22, Maximilian Michels <mx...@apache.org> wrote:
>>>
>>> Hi!
>>>
>>> This looks neat. Let's try it out. I just voted.
>>>
>>> Cheers,
>>> Max
>>>
>>> On Sun, Sep 4, 2016 at 8:11 PM, Vishnu Viswanath
>>> <vi...@gmail.com> wrote:
>>> > Hi All,
>>> >
>>> > Why don't we make use of Stackoverflow's new documentation feature to
>>> > do
>>> > some documentation of Apache Flink.
>>> >
>>> > To start, at least 5 SO users should commit to document, who has at
>>> > least150
>>> > reputation and have at least 1 positively scored answer in Flink tag.
>>> >
>>> > http://stackoverflow.com/documentation/apache-flink
>>> >
>>> > Regards,
>>> > Vishnu Viswanath
>>
>>
>
Re: [SUGGESTION] Stack Overflow Documentation for Apache Flink
Posted by Fabian Hueske <fh...@gmail.com>.
Thanks for the suggestion Vishnu!
Stackoverflow documentation looks great. I like the easy contribution and
versioning features.
However, I am a bit skeptical. IMO, Flink's primary documentation must be
hosted by Apache. Out-sourcing such an important aspect of a project to an
external service is not an option for me.
This would mean, that documentation on SO would be an additional /
secondary documentation. I see two potential problems with that:
- It is duplicate effort to keep two documentations up-to-date. Adding a
new feature of changing some behavior must be documented in two places.
- Efforts to improve documentation might split up, i.e., the primary
documentation might receive less improvements and contributions.
Of course, this is just my opinion but I think it is worth to mention these
points.
Thanks,
Fabian
2016-09-05 12:22 GMT+02:00 Ravikumar Hawaldar <ra...@gmail.com>
:
> Hi,
>
>
> I just committed to apache-flink documentation on SO, one more commit
> required. Nice idea to document on SO Vishnu.
>
>
>
> Regards,
>
> Ravikumar
>
> On 5 September 2016 at 14:22, Maximilian Michels <mx...@apache.org> wrote:
>
>> Hi!
>>
>> This looks neat. Let's try it out. I just voted.
>>
>> Cheers,
>> Max
>>
>> On Sun, Sep 4, 2016 at 8:11 PM, Vishnu Viswanath
>> <vi...@gmail.com> wrote:
>> > Hi All,
>> >
>> > Why don't we make use of Stackoverflow's new documentation feature to do
>> > some documentation of Apache Flink.
>> >
>> > To start, at least 5 SO users should commit to document, who has at
>> least150
>> > reputation and have at least 1 positively scored answer in Flink tag.
>> >
>> > http://stackoverflow.com/documentation/apache-flink
>> >
>> > Regards,
>> > Vishnu Viswanath
>>
>
>
Re: [SUGGESTION] Stack Overflow Documentation for Apache Flink
Posted by Ravikumar Hawaldar <ra...@gmail.com>.
Hi,
I just committed to apache-flink documentation on SO, one more commit
required. Nice idea to document on SO Vishnu.
Regards,
Ravikumar
On 5 September 2016 at 14:22, Maximilian Michels <mx...@apache.org> wrote:
> Hi!
>
> This looks neat. Let's try it out. I just voted.
>
> Cheers,
> Max
>
> On Sun, Sep 4, 2016 at 8:11 PM, Vishnu Viswanath
> <vi...@gmail.com> wrote:
> > Hi All,
> >
> > Why don't we make use of Stackoverflow's new documentation feature to do
> > some documentation of Apache Flink.
> >
> > To start, at least 5 SO users should commit to document, who has at
> least150
> > reputation and have at least 1 positively scored answer in Flink tag.
> >
> > http://stackoverflow.com/documentation/apache-flink
> >
> > Regards,
> > Vishnu Viswanath
>
Re: [SUGGESTION] Stack Overflow Documentation for Apache Flink
Posted by Maximilian Michels <mx...@apache.org>.
Hi!
This looks neat. Let's try it out. I just voted.
Cheers,
Max
On Sun, Sep 4, 2016 at 8:11 PM, Vishnu Viswanath
<vi...@gmail.com> wrote:
> Hi All,
>
> Why don't we make use of Stackoverflow's new documentation feature to do
> some documentation of Apache Flink.
>
> To start, at least 5 SO users should commit to document, who has at least150
> reputation and have at least 1 positively scored answer in Flink tag.
>
> http://stackoverflow.com/documentation/apache-flink
>
> Regards,
> Vishnu Viswanath