Uploaded image for project: 'Spark'
  1. Spark
  2. SPARK-18073

Migrate wiki to spark.apache.org web site

    Details

    • Type: Improvement
    • Status: Resolved
    • Priority: Critical
    • Resolution: Fixed
    • Affects Version/s: 2.0.1
    • Fix Version/s: 2.1.0
    • Component/s: Documentation
    • Labels:
      None
    • Target Version/s:

      Description

      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-website (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:

      • (Main wiki page) -> roll into "versioning policy" (below) as all it really has is release cadence info
      • Additional Language Bindings -> roll this into Third Party Projects
      • Committers -> Migrate to a new /committers.html page; wiki already linked under Communitiy menu
      • Contributing to Spark -> a new /contributing.html page under Community menu
        • Jira Permissions Scheme -> long since obsolete; delete it
        • Spark Code Style Guide -> roll this into new /contributing.html page
      • Development Discussions -> looks obsolete and didn't really get underway; delete it
      • Powered By Spark -> new /powered-by.html linked by the existing Communnity menu item
      • Preparing Spark Releases -> see below; roll into "versioning policy"
      • Profiling Spark Applications -> roll into Useful Developer Tools
        • Profiling Spark Applications Using YourKit -> roll into Useful Developer Tools
      • Spark Internals -> leave in place and don't port, but note that it's no longer up to date
        • Java API Internals
        • PySpark Internals
        • Shuffle Internals
        • Spark SQL Internals
        • Web UI Internals
      • Spark QA Infrastructure -> leave in place and don't port, but note that it's no longer up to date
      • Spark Versioning Policy -> Combine into new /release-process.html under Developer
        • spark-ec2 AMI list and install file version mappings -> leave in place and don't port, but note that it's no longer up to date
        • Spark-Shark version mapping -> leave in place and don't port, but note that it's no longer up to date
      • Third Party Projects -> new page; already linked as Community menu item
      • Useful Developer Tools -> new page under new Developer menu
        • Jenkins -> leave in place and don't port, but note that it's no longer up to date

        Attachments

          Issue Links

            Activity

              People

              • Assignee:
                srowen Sean Owen
                Reporter:
                srowen Sean Owen
              • Votes:
                2 Vote for this issue
                Watchers:
                10 Start watching this issue

                Dates

                • Created:
                  Updated:
                  Resolved: