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 <r...@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 < > shiva...@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 <matei.zaha...@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 <c...@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 <hol...@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-unsubscr...@spark.apache.org >> >> >
