Mini-Proposal: Make it easier to contribute to the contributing to Spark Guide

[Holden Karau <ho...@pigscanfly.ca>]

Right now the wiki isn't particularly accessible to updates by external
contributors. We've already got a contributing to spark page which just
links to the wiki - how about if we just move the wiki contents over? This
way contributors can contribute to our documentation about how to
contribute probably helping clear up points of confusion for new
contributors which the rest of us may be blind to.

If we do this we would probably want to update the wiki page to point to
the documentation generated from markdown. It would also mean that the
results of any update to the contributing guide take a full release cycle
to be visible. Another alternative would be opening up the wiki to a
broader set of people.

I know a lot of people are probably getting ready for Spark Summit EU (and
I hope to catch up with some of y'all there) but I figured this a
relatively minor proposal.
-- 
Cell : 425-233-8271
Twitter: https://twitter.com/holdenkarau

Re: Mini-Proposal: Make it easier to contribute to the contributing to Spark Guide

[Mark Hamstra <ma...@clearstorydata.com>]

The advice to avoid idioms that may not be universally understood is good.
My further issue with the misuse of "straw-man" (which really is not, or
should not be, separable from "straw-man argument") is that a "straw-man"
in the established usage is something that is always intended to be a
failure or designed to be obviously and fatally flawed.  That's what makes
it fundamentally different from a trial balloon or a first crack at
something or a prototype or an initial design proposal -- these are all
intended, despite any remaining flaws, to have merits that are likely worth
pursuing further, whereas a straw-man is only intended to be knocked apart
as a way to preclude and put an end to further consideration of something.


On Mon, Oct 24, 2016 at 10:38 AM, Sean Owen <so...@cloudera.com> wrote:

> Well, it's more of a reference to the fallacy than anything. Writing down
> a proposed action implicitly claims it's what others are arguing for. It's
> self-deprecating to call it a "straw man", suggesting that it may not at
> all be what others are arguing for, and is done to openly invite criticism
> and feedback. The logical fallacy is "attacking a straw man", and that's
> not what was written here.
>
> Really, the important thing is that we understand each other, and I'm
> guessing you did. Although I think the usage here is fine, casually,
> avoiding idioms is best, where plain language suffices, especially given we
> have people from lots of language backgrounds here.
>
>
> On Mon, Oct 24, 2016 at 6:11 PM Mark Hamstra <ma...@clearstorydata.com>
> wrote:
>
>> <rant>Alright, that does it!  Who is responsible for this "straw-man"
>> abuse that is becoming too commonplace in the Spark community?  "Straw-man"
>> does not mean something like "trial balloon" or "run it up the flagpole and
>> see if anyone salutes", and I would really appreciate it if Spark
>> developers would stop using "straw-man" to mean anything other than its
>> established meaning: The logical fallacy of declaring victory by knocking
>> down an easily defeated argument or position that the opposition has never
>> actually made.</rant>
>>
>> On Mon, Oct 24, 2016 at 5:51 AM, Sean Owen <so...@cloudera.com> wrote:
>>
>> BTW I wrote up a straw-man proposal for migrating the wiki content:
>>
>> https://issues.apache.org/jira/browse/SPARK-18073
>>
>> On Tue, Oct 18, 2016 at 12:25 PM Holden Karau <ho...@pigscanfly.ca>
>> wrote:
>>
>> Right now the wiki isn't particularly accessible to updates by external
>> contributors. We've already got a contributing to spark page which just
>> links to the wiki - how about if we just move the wiki contents over? This
>> way contributors can contribute to our documentation about how to
>> contribute probably helping clear up points of confusion for new
>> contributors which the rest of us may be blind to.
>>
>> If we do this we would probably want to update the wiki page to point to
>> the documentation generated from markdown. It would also mean that the
>> results of any update to the contributing guide take a full release cycle
>> to be visible. Another alternative would be opening up the wiki to a
>> broader set of people.
>>
>> I know a lot of people are probably getting ready for Spark Summit EU
>> (and I hope to catch up with some of y'all there) but I figured this a
>> relatively minor proposal.
>> --
>> Cell : 425-233-8271
>> Twitter: https://twitter.com/holdenkarau
>>
>>
>>

Re: Mini-Proposal: Make it easier to contribute to the contributing to Spark Guide

[Sean Owen <so...@cloudera.com>]

Well, it's more of a reference to the fallacy than anything. Writing down a
proposed action implicitly claims it's what others are arguing for. It's
self-deprecating to call it a "straw man", suggesting that it may not at
all be what others are arguing for, and is done to openly invite criticism
and feedback. The logical fallacy is "attacking a straw man", and that's
not what was written here.

Really, the important thing is that we understand each other, and I'm
guessing you did. Although I think the usage here is fine, casually,
avoiding idioms is best, where plain language suffices, especially given we
have people from lots of language backgrounds here.


On Mon, Oct 24, 2016 at 6:11 PM Mark Hamstra <ma...@clearstorydata.com>
wrote:

> <rant>Alright, that does it!  Who is responsible for this "straw-man"
> abuse that is becoming too commonplace in the Spark community?  "Straw-man"
> does not mean something like "trial balloon" or "run it up the flagpole and
> see if anyone salutes", and I would really appreciate it if Spark
> developers would stop using "straw-man" to mean anything other than its
> established meaning: The logical fallacy of declaring victory by knocking
> down an easily defeated argument or position that the opposition has never
> actually made.</rant>
>
> On Mon, Oct 24, 2016 at 5:51 AM, Sean Owen <so...@cloudera.com> wrote:
>
> BTW I wrote up a straw-man proposal for migrating the wiki content:
>
> https://issues.apache.org/jira/browse/SPARK-18073
>
> On Tue, Oct 18, 2016 at 12:25 PM Holden Karau <ho...@pigscanfly.ca>
> wrote:
>
> Right now the wiki isn't particularly accessible to updates by external
> contributors. We've already got a contributing to spark page which just
> links to the wiki - how about if we just move the wiki contents over? This
> way contributors can contribute to our documentation about how to
> contribute probably helping clear up points of confusion for new
> contributors which the rest of us may be blind to.
>
> If we do this we would probably want to update the wiki page to point to
> the documentation generated from markdown. It would also mean that the
> results of any update to the contributing guide take a full release cycle
> to be visible. Another alternative would be opening up the wiki to a
> broader set of people.
>
> I know a lot of people are probably getting ready for Spark Summit EU (and
> I hope to catch up with some of y'all there) but I figured this a
> relatively minor proposal.
> --
> Cell : 425-233-8271
> Twitter: https://twitter.com/holdenkarau
>
>
>

Re: Mini-Proposal: Make it easier to contribute to the contributing to Spark Guide

[Mark Hamstra <ma...@clearstorydata.com>]

<rant>Alright, that does it!  Who is responsible for this "straw-man" abuse
that is becoming too commonplace in the Spark community?  "Straw-man" does
not mean something like "trial balloon" or "run it up the flagpole and see
if anyone salutes", and I would really appreciate it if Spark developers
would stop using "straw-man" to mean anything other than its established
meaning: The logical fallacy of declaring victory by knocking down an
easily defeated argument or position that the opposition has never actually
made.</rant>

On Mon, Oct 24, 2016 at 5:51 AM, Sean Owen <so...@cloudera.com> wrote:

> BTW I wrote up a straw-man proposal for migrating the wiki content:
>
> https://issues.apache.org/jira/browse/SPARK-18073
>
> On Tue, Oct 18, 2016 at 12:25 PM Holden Karau <ho...@pigscanfly.ca>
> wrote:
>
>> Right now the wiki isn't particularly accessible to updates by external
>> contributors. We've already got a contributing to spark page which just
>> links to the wiki - how about if we just move the wiki contents over? This
>> way contributors can contribute to our documentation about how to
>> contribute probably helping clear up points of confusion for new
>> contributors which the rest of us may be blind to.
>>
>> If we do this we would probably want to update the wiki page to point to
>> the documentation generated from markdown. It would also mean that the
>> results of any update to the contributing guide take a full release cycle
>> to be visible. Another alternative would be opening up the wiki to a
>> broader set of people.
>>
>> I know a lot of people are probably getting ready for Spark Summit EU
>> (and I hope to catch up with some of y'all there) but I figured this a
>> relatively minor proposal.
>> --
>> Cell : 425-233-8271
>> Twitter: https://twitter.com/holdenkarau
>>
>

Re: Mini-Proposal: Make it easier to contribute to the contributing to Spark Guide

[Sean Owen <so...@cloudera.com>]

BTW I wrote up a straw-man proposal for migrating the wiki content:

https://issues.apache.org/jira/browse/SPARK-18073

On Tue, Oct 18, 2016 at 12:25 PM Holden Karau <ho...@pigscanfly.ca> wrote:

> Right now the wiki isn't particularly accessible to updates by external
> contributors. We've already got a contributing to spark page which just
> links to the wiki - how about if we just move the wiki contents over? This
> way contributors can contribute to our documentation about how to
> contribute probably helping clear up points of confusion for new
> contributors which the rest of us may be blind to.
>
> If we do this we would probably want to update the wiki page to point to
> the documentation generated from markdown. It would also mean that the
> results of any update to the contributing guide take a full release cycle
> to be visible. Another alternative would be opening up the wiki to a
> broader set of people.
>
> I know a lot of people are probably getting ready for Spark Summit EU (and
> I hope to catch up with some of y'all there) but I figured this a
> relatively minor proposal.
> --
> Cell : 425-233-8271
> Twitter: https://twitter.com/holdenkarau
>

Re: Mini-Proposal: Make it easier to contribute to the contributing to Spark Guide

[Fred Reiss <fr...@gmail.com>]

Great idea! If the developer docs are in github, then new contributors who
find errors or omissions can update the docs as an introduction to the PR
process.

Fred

On Wed, Oct 19, 2016 at 5:46 PM, Reynold Xin <rx...@databricks.com> wrote:

> For the contributing guide I think it makes more sense to put it in
> apache/spark github, since that's where contributors start. I'd also link
> to it from the website ...
>
>
> On Tue, Oct 18, 2016 at 10:03 AM, Shivaram Venkataraman <
> shivaram@eecs.berkeley.edu> wrote:
>
>> +1 - Given that our website is now on github
>> (https://github.com/apache/spark-website), I think we can move most of
>> our wiki into the main website. That way we'll only have two sources
>> of documentation to maintain: A release specific one in the main repo
>> and the website which is more long lived.
>>
>> Thanks
>> Shivaram
>>
>> On Tue, Oct 18, 2016 at 9:59 AM, Matei Zaharia <ma...@gmail.com>
>> wrote:
>> > Is there any way to tie wiki accounts with JIRA accounts? I found it
>> weird
>> > that they're not tied at the ASF.
>> >
>> > Otherwise, moving this into the docs might make sense.
>> >
>> > Matei
>> >
>> > On Oct 18, 2016, at 6:19 AM, Cody Koeninger <co...@koeninger.org> wrote:
>> >
>> > +1 to putting docs in one clear place.
>> >
>> >
>> > On Oct 18, 2016 6:40 AM, "Sean Owen" <so...@cloudera.com> wrote:
>> >>
>> >> I'm OK with that. The upside to the wiki is that it can be edited
>> directly
>> >> outside of a release cycle. However, in practice I find that the wiki
>> is
>> >> rarely changed. To me it also serves as a place for information that
>> isn't
>> >> exactly project documentation like "powered by" listings.
>> >>
>> >> In a way I'd like to get rid of the wiki to have one less place for
>> docs,
>> >> that doesn't have the same accessibility (I don't know who can give
>> edit
>> >> access), and doesn't have a review process.
>> >>
>> >> For now I'd settle for bringing over a few key docs like the one you
>> >> mention. I spent a little time a while ago removing some duplication
>> across
>> >> the wiki and project docs and think there's a bit more than could be
>> done.
>> >>
>> >>
>> >> On Tue, Oct 18, 2016 at 12:25 PM Holden Karau <ho...@pigscanfly.ca>
>> >> wrote:
>> >>>
>> >>> Right now the wiki isn't particularly accessible to updates by
>> external
>> >>> contributors. We've already got a contributing to spark page which
>> just
>> >>> links to the wiki - how about if we just move the wiki contents over?
>> This
>> >>> way contributors can contribute to our documentation about how to
>> contribute
>> >>> probably helping clear up points of confusion for new contributors
>> which the
>> >>> rest of us may be blind to.
>> >>>
>> >>> If we do this we would probably want to update the wiki page to point
>> to
>> >>> the documentation generated from markdown. It would also mean that the
>> >>> results of any update to the contributing guide take a full release
>> cycle to
>> >>> be visible. Another alternative would be opening up the wiki to a
>> broader
>> >>> set of people.
>> >>>
>> >>> I know a lot of people are probably getting ready for Spark Summit EU
>> >>> (and I hope to catch up with some of y'all there) but I figured this a
>> >>> relatively minor proposal.
>> >>> --
>> >>> Cell : 425-233-8271
>> >>> Twitter: https://twitter.com/holdenkarau
>> >
>> >
>>
>> ---------------------------------------------------------------------
>> To unsubscribe e-mail: dev-unsubscribe@spark.apache.org
>>
>>
>

Re: Mini-Proposal: Make it easier to contribute to the contributing to Spark Guide

[Reynold Xin <rx...@databricks.com>]

For the contributing guide I think it makes more sense to put it in
apache/spark github, since that's where contributors start. I'd also link
to it from the website ...


On Tue, Oct 18, 2016 at 10:03 AM, Shivaram Venkataraman <
shivaram@eecs.berkeley.edu> wrote:

> +1 - Given that our website is now on github
> (https://github.com/apache/spark-website), I think we can move most of
> our wiki into the main website. That way we'll only have two sources
> of documentation to maintain: A release specific one in the main repo
> and the website which is more long lived.
>
> Thanks
> Shivaram
>
> On Tue, Oct 18, 2016 at 9:59 AM, Matei Zaharia <ma...@gmail.com>
> wrote:
> > Is there any way to tie wiki accounts with JIRA accounts? I found it
> weird
> > that they're not tied at the ASF.
> >
> > Otherwise, moving this into the docs might make sense.
> >
> > Matei
> >
> > On Oct 18, 2016, at 6:19 AM, Cody Koeninger <co...@koeninger.org> wrote:
> >
> > +1 to putting docs in one clear place.
> >
> >
> > On Oct 18, 2016 6:40 AM, "Sean Owen" <so...@cloudera.com> wrote:
> >>
> >> I'm OK with that. The upside to the wiki is that it can be edited
> directly
> >> outside of a release cycle. However, in practice I find that the wiki is
> >> rarely changed. To me it also serves as a place for information that
> isn't
> >> exactly project documentation like "powered by" listings.
> >>
> >> In a way I'd like to get rid of the wiki to have one less place for
> docs,
> >> that doesn't have the same accessibility (I don't know who can give edit
> >> access), and doesn't have a review process.
> >>
> >> For now I'd settle for bringing over a few key docs like the one you
> >> mention. I spent a little time a while ago removing some duplication
> across
> >> the wiki and project docs and think there's a bit more than could be
> done.
> >>
> >>
> >> On Tue, Oct 18, 2016 at 12:25 PM Holden Karau <ho...@pigscanfly.ca>
> >> wrote:
> >>>
> >>> Right now the wiki isn't particularly accessible to updates by external
> >>> contributors. We've already got a contributing to spark page which just
> >>> links to the wiki - how about if we just move the wiki contents over?
> This
> >>> way contributors can contribute to our documentation about how to
> contribute
> >>> probably helping clear up points of confusion for new contributors
> which the
> >>> rest of us may be blind to.
> >>>
> >>> If we do this we would probably want to update the wiki page to point
> to
> >>> the documentation generated from markdown. It would also mean that the
> >>> results of any update to the contributing guide take a full release
> cycle to
> >>> be visible. Another alternative would be opening up the wiki to a
> broader
> >>> set of people.
> >>>
> >>> I know a lot of people are probably getting ready for Spark Summit EU
> >>> (and I hope to catch up with some of y'all there) but I figured this a
> >>> relatively minor proposal.
> >>> --
> >>> Cell : 425-233-8271
> >>> Twitter: https://twitter.com/holdenkarau
> >
> >
>
> ---------------------------------------------------------------------
> To unsubscribe e-mail: dev-unsubscribe@spark.apache.org
>
>

Re: Mini-Proposal: Make it easier to contribute to the contributing to Spark Guide

[Hyukjin Kwon <gu...@gmail.com>]

+1 if the docs can be exposed more.

On 19 Oct 2016 2:04 a.m., "Shivaram Venkataraman" <
shivaram@eecs.berkeley.edu> wrote:

> +1 - Given that our website is now on github
> (https://github.com/apache/spark-website), I think we can move most of
> our wiki into the main website. That way we'll only have two sources
> of documentation to maintain: A release specific one in the main repo
> and the website which is more long lived.
>
> Thanks
> Shivaram
>
> On Tue, Oct 18, 2016 at 9:59 AM, Matei Zaharia <ma...@gmail.com>
> wrote:
> > Is there any way to tie wiki accounts with JIRA accounts? I found it
> weird
> > that they're not tied at the ASF.
> >
> > Otherwise, moving this into the docs might make sense.
> >
> > Matei
> >
> > On Oct 18, 2016, at 6:19 AM, Cody Koeninger <co...@koeninger.org> wrote:
> >
> > +1 to putting docs in one clear place.
> >
> >
> > On Oct 18, 2016 6:40 AM, "Sean Owen" <so...@cloudera.com> wrote:
> >>
> >> I'm OK with that. The upside to the wiki is that it can be edited
> directly
> >> outside of a release cycle. However, in practice I find that the wiki is
> >> rarely changed. To me it also serves as a place for information that
> isn't
> >> exactly project documentation like "powered by" listings.
> >>
> >> In a way I'd like to get rid of the wiki to have one less place for
> docs,
> >> that doesn't have the same accessibility (I don't know who can give edit
> >> access), and doesn't have a review process.
> >>
> >> For now I'd settle for bringing over a few key docs like the one you
> >> mention. I spent a little time a while ago removing some duplication
> across
> >> the wiki and project docs and think there's a bit more than could be
> done.
> >>
> >>
> >> On Tue, Oct 18, 2016 at 12:25 PM Holden Karau <ho...@pigscanfly.ca>
> >> wrote:
> >>>
> >>> Right now the wiki isn't particularly accessible to updates by external
> >>> contributors. We've already got a contributing to spark page which just
> >>> links to the wiki - how about if we just move the wiki contents over?
> This
> >>> way contributors can contribute to our documentation about how to
> contribute
> >>> probably helping clear up points of confusion for new contributors
> which the
> >>> rest of us may be blind to.
> >>>
> >>> If we do this we would probably want to update the wiki page to point
> to
> >>> the documentation generated from markdown. It would also mean that the
> >>> results of any update to the contributing guide take a full release
> cycle to
> >>> be visible. Another alternative would be opening up the wiki to a
> broader
> >>> set of people.
> >>>
> >>> I know a lot of people are probably getting ready for Spark Summit EU
> >>> (and I hope to catch up with some of y'all there) but I figured this a
> >>> relatively minor proposal.
> >>> --
> >>> Cell : 425-233-8271
> >>> Twitter: https://twitter.com/holdenkarau
> >
> >
>
> ---------------------------------------------------------------------
> To unsubscribe e-mail: dev-unsubscribe@spark.apache.org
>
>

Re: Mini-Proposal: Make it easier to contribute to the contributing to Spark Guide

[Shivaram Venkataraman <sh...@eecs.berkeley.edu>]

+1 - Given that our website is now on github
(https://github.com/apache/spark-website), I think we can move most of
our wiki into the main website. That way we'll only have two sources
of documentation to maintain: A release specific one in the main repo
and the website which is more long lived.

Thanks
Shivaram

On Tue, Oct 18, 2016 at 9:59 AM, Matei Zaharia <ma...@gmail.com> wrote:
> Is there any way to tie wiki accounts with JIRA accounts? I found it weird
> that they're not tied at the ASF.
>
> Otherwise, moving this into the docs might make sense.
>
> Matei
>
> On Oct 18, 2016, at 6:19 AM, Cody Koeninger <co...@koeninger.org> wrote:
>
> +1 to putting docs in one clear place.
>
>
> On Oct 18, 2016 6:40 AM, "Sean Owen" <so...@cloudera.com> wrote:
>>
>> I'm OK with that. The upside to the wiki is that it can be edited directly
>> outside of a release cycle. However, in practice I find that the wiki is
>> rarely changed. To me it also serves as a place for information that isn't
>> exactly project documentation like "powered by" listings.
>>
>> In a way I'd like to get rid of the wiki to have one less place for docs,
>> that doesn't have the same accessibility (I don't know who can give edit
>> access), and doesn't have a review process.
>>
>> For now I'd settle for bringing over a few key docs like the one you
>> mention. I spent a little time a while ago removing some duplication across
>> the wiki and project docs and think there's a bit more than could be done.
>>
>>
>> On Tue, Oct 18, 2016 at 12:25 PM Holden Karau <ho...@pigscanfly.ca>
>> wrote:
>>>
>>> Right now the wiki isn't particularly accessible to updates by external
>>> contributors. We've already got a contributing to spark page which just
>>> links to the wiki - how about if we just move the wiki contents over? This
>>> way contributors can contribute to our documentation about how to contribute
>>> probably helping clear up points of confusion for new contributors which the
>>> rest of us may be blind to.
>>>
>>> If we do this we would probably want to update the wiki page to point to
>>> the documentation generated from markdown. It would also mean that the
>>> results of any update to the contributing guide take a full release cycle to
>>> be visible. Another alternative would be opening up the wiki to a broader
>>> set of people.
>>>
>>> I know a lot of people are probably getting ready for Spark Summit EU
>>> (and I hope to catch up with some of y'all there) but I figured this a
>>> relatively minor proposal.
>>> --
>>> Cell : 425-233-8271
>>> Twitter: https://twitter.com/holdenkarau
>
>

---------------------------------------------------------------------
To unsubscribe e-mail: dev-unsubscribe@spark.apache.org

Re: Mini-Proposal: Make it easier to contribute to the contributing to Spark Guide

[Matei Zaharia <ma...@gmail.com>]

Is there any way to tie wiki accounts with JIRA accounts? I found it weird that they're not tied at the ASF.

Otherwise, moving this into the docs might make sense.

Matei

> On Oct 18, 2016, at 6:19 AM, Cody Koeninger <co...@koeninger.org> wrote:
> 
> +1 to putting docs in one clear place.
> 
> On Oct 18, 2016 6:40 AM, "Sean Owen" <sowen@cloudera.com <ma...@cloudera.com>> wrote:
> I'm OK with that. The upside to the wiki is that it can be edited directly outside of a release cycle. However, in practice I find that the wiki is rarely changed. To me it also serves as a place for information that isn't exactly project documentation like "powered by" listings.
> 
> In a way I'd like to get rid of the wiki to have one less place for docs, that doesn't have the same accessibility (I don't know who can give edit access), and doesn't have a review process.
> 
> For now I'd settle for bringing over a few key docs like the one you mention. I spent a little time a while ago removing some duplication across the wiki and project docs and think there's a bit more than could be done.
> 
> 
> On Tue, Oct 18, 2016 at 12:25 PM Holden Karau <holden@pigscanfly.ca <ma...@pigscanfly.ca>> wrote:
> Right now the wiki isn't particularly accessible to updates by external contributors. We've already got a contributing to spark page which just links to the wiki - how about if we just move the wiki contents over? This way contributors can contribute to our documentation about how to contribute probably helping clear up points of confusion for new contributors which the rest of us may be blind to.
> 
> If we do this we would probably want to update the wiki page to point to the documentation generated from markdown. It would also mean that the results of any update to the contributing guide take a full release cycle to be visible. Another alternative would be opening up the wiki to a broader set of people.
> 
> I know a lot of people are probably getting ready for Spark Summit EU (and I hope to catch up with some of y'all there) but I figured this a relatively minor proposal.
> -- 
> Cell : 425-233-8271 <tel:425-233-8271>
> Twitter: https://twitter.com/holdenkarau <https://twitter.com/holdenkarau>

Re: Mini-Proposal: Make it easier to contribute to the contributing to Spark Guide

[Cody Koeninger <co...@koeninger.org>]

+1 to putting docs in one clear place.

On Oct 18, 2016 6:40 AM, "Sean Owen" <so...@cloudera.com> wrote:

> I'm OK with that. The upside to the wiki is that it can be edited directly
> outside of a release cycle. However, in practice I find that the wiki is
> rarely changed. To me it also serves as a place for information that isn't
> exactly project documentation like "powered by" listings.
>
> In a way I'd like to get rid of the wiki to have one less place for docs,
> that doesn't have the same accessibility (I don't know who can give edit
> access), and doesn't have a review process.
>
> For now I'd settle for bringing over a few key docs like the one you
> mention. I spent a little time a while ago removing some duplication across
> the wiki and project docs and think there's a bit more than could be done.
>
>
> On Tue, Oct 18, 2016 at 12:25 PM Holden Karau <ho...@pigscanfly.ca>
> wrote:
>
>> Right now the wiki isn't particularly accessible to updates by external
>> contributors. We've already got a contributing to spark page which just
>> links to the wiki - how about if we just move the wiki contents over? This
>> way contributors can contribute to our documentation about how to
>> contribute probably helping clear up points of confusion for new
>> contributors which the rest of us may be blind to.
>>
>> If we do this we would probably want to update the wiki page to point to
>> the documentation generated from markdown. It would also mean that the
>> results of any update to the contributing guide take a full release cycle
>> to be visible. Another alternative would be opening up the wiki to a
>> broader set of people.
>>
>> I know a lot of people are probably getting ready for Spark Summit EU
>> (and I hope to catch up with some of y'all there) but I figured this a
>> relatively minor proposal.
>> --
>> Cell : 425-233-8271
>> Twitter: https://twitter.com/holdenkarau
>>
>

Re: Mini-Proposal: Make it easier to contribute to the contributing to Spark Guide

[Sean Owen <so...@cloudera.com>]

I'm OK with that. The upside to the wiki is that it can be edited directly
outside of a release cycle. However, in practice I find that the wiki is
rarely changed. To me it also serves as a place for information that isn't
exactly project documentation like "powered by" listings.

In a way I'd like to get rid of the wiki to have one less place for docs,
that doesn't have the same accessibility (I don't know who can give edit
access), and doesn't have a review process.

For now I'd settle for bringing over a few key docs like the one you
mention. I spent a little time a while ago removing some duplication across
the wiki and project docs and think there's a bit more than could be done.


On Tue, Oct 18, 2016 at 12:25 PM Holden Karau <ho...@pigscanfly.ca> wrote:

> Right now the wiki isn't particularly accessible to updates by external
> contributors. We've already got a contributing to spark page which just
> links to the wiki - how about if we just move the wiki contents over? This
> way contributors can contribute to our documentation about how to
> contribute probably helping clear up points of confusion for new
> contributors which the rest of us may be blind to.
>
> If we do this we would probably want to update the wiki page to point to
> the documentation generated from markdown. It would also mean that the
> results of any update to the contributing guide take a full release cycle
> to be visible. Another alternative would be opening up the wiki to a
> broader set of people.
>
> I know a lot of people are probably getting ready for Spark Summit EU (and
> I hope to catch up with some of y'all there) but I figured this a
> relatively minor proposal.
> --
> Cell : 425-233-8271
> Twitter: https://twitter.com/holdenkarau
>