[jira] [Commented] (SPARK-18073) Migrate wiki to spark.apache.org web site

["holdenk (JIRA)" <ji...@apache.org>]

    [ https://issues.apache.org/jira/browse/SPARK-18073?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15602152#comment-15602152 ] 

holdenk commented on SPARK-18073:
---------------------------------

I like the idea of migrating everything off of the wiki - the fact its locked down makes sense from a SPAM POV but one of the best places for people to "get their toes wet" is with documentation fixes and by making that experience more consistent across the different types of documentation seems like it could be quite beneficial. (Not to mention the resulting ability for more than just committers to contribute suggestions on how to improve these parts of our documentation).

> Migrate wiki to spark.apache.org web site
> -----------------------------------------
>
>                 Key: SPARK-18073
>                 URL: https://issues.apache.org/jira/browse/SPARK-18073
>             Project: Spark
>          Issue Type: Improvement
>          Components: Documentation
>    Affects Versions: 2.0.1
>            Reporter: Sean Owen
>
> Per http://apache-spark-developers-list.1001551.n3.nabble.com/Mini-Proposal-Make-it-easier-to-contribute-to-the-contributing-to-Spark-Guide-td19493.html , let's consider migrating all wiki pages to documents at github.com/apache/spark-webiste (i.e. spark.apache.org).
> Some reasons:
> * No pull request system or history for changes to the wiki
> * Separate, not-so-clear system for granting write access to wiki
> * Wiki doesn't change much
> * One less place to maintain or look for docs
> The idea would be to then update all wiki pages with a message pointing to the new home of the information (or message saying it's obsolete).
> Here are the current wikis and my general proposal for what to do with the content:
> * Additional Language Bindings -> roll this into wherever Third Party Projects ends up
> * Committers -> Migrate to a new /committers.html page, linked under Community menu (alread exists)
> * Contributing to Spark -> Make this CONTRIBUTING.md? or a new /contributing.html page under Community menu
> ** Jira Permissions Scheme -> obsolete
> ** Spark Code Style Guide -> roll this into new contributing.html page
> * Development Discussions -> obsolete?
> * Powered By Spark -> Make into new /powered-by.html linked by the existing Commnunity menu item
> * Preparing Spark Releases -> see below; roll into where "versioning policy" goes?
> * Profiling Spark Applications -> roll into where Useful Developer Tools goes
> ** Profiling Spark Applications Using YourKit -> ditto
> * Spark Internals -> all of these look somewhat to very stale; remove?
> ** Java API Internals
> ** PySpark Internals
> ** Shuffle Internals
> ** Spark SQL Internals
> ** Web UI Internals
> * Spark QA Infrastructure -> tough one. Good info to document; does it belong on the website? we can just migrate it
> * Spark Versioning Policy -> new page living under Community (?) that documents release policy and process (better menu?)
> ** spark-ec2 AMI list and install file version mappings -> obsolete
> ** Spark-Shark version mapping -> obsolete
> * Third Party Projects -> new Community menu item
> * Useful Developer Tools -> new page under new Developer menu? Community?
> ** Jenkins -> obsolete, remove
> Of course, another outcome is to just remove outdated wikis, migrate some, leave the rest.
> Thoughts?



--
This message was sent by Atlassian JIRA
(v6.3.4#6332)

---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@spark.apache.org
For additional commands, e-mail: issues-help@spark.apache.org