[ 
https://issues.apache.org/jira/browse/SPARK-14817?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
 ]

Joseph K. Bradley updated SPARK-14817:
--------------------------------------
    Description: 
Before the release, we need to update the MLlib, GraphX, and SparkR Programming 
Guides.  Updates will include:
* Add migration guide subsection.
** Use the results of the QA audit JIRAs and [SPARK-13448].
* Check phrasing, especially in main sections (for outdated items such as "In 
this release, ...")

For MLlib, we will make the DataFrame-based API (spark.ml) front-and-center, to 
make it clear the RDD-based API is the older, maintenance-mode one.
* No docs for spark.mllib will be deleted; they will just be reorganized and 
put in a subsection.
* If spark.ml docs are less complete, or if spark.ml docs say "refer to the 
spark.mllib docs for details," then we should copy those details to the 
spark.ml docs.  This per-feature work can happen under [SPARK-14815].
* This big reorganization should be done *after* docs are added for each 
feature (to minimize merge conflicts).

  was:
Before the release, we need to update the MLlib Programming Guide.  Updates 
will include:
* Make the DataFrame-based API (spark.ml) front-and-center, to make it clear 
the RDD-based API is the older, maintenance-mode one.
** No docs for spark.mllib will be deleted; they will just be reorganized and 
put in a subsection.
** If spark.ml docs are less complete, or if spark.ml docs say "refer to the 
spark.mllib docs for details," then we should copy those details to the 
spark.ml docs.
* Add migration guide subsection.
** Use the results of the QA audit JIRAs.
* Check phrasing, especially in main sections (for outdated items such as "In 
this release, ...")

If you would like to work on this task, please comment, and we can create & 
link JIRAs for parts of this work (which should be broken into pieces for this 
larger 2.0 release).


> ML, Graph, R 2.0 QA: Programming guide update and migration guide
> -----------------------------------------------------------------
>
>                 Key: SPARK-14817
>                 URL: https://issues.apache.org/jira/browse/SPARK-14817
>             Project: Spark
>          Issue Type: Sub-task
>          Components: Documentation, GraphX, ML, MLlib, SparkR
>            Reporter: Joseph K. Bradley
>
> Before the release, we need to update the MLlib, GraphX, and SparkR 
> Programming Guides.  Updates will include:
> * Add migration guide subsection.
> ** Use the results of the QA audit JIRAs and [SPARK-13448].
> * Check phrasing, especially in main sections (for outdated items such as "In 
> this release, ...")
> For MLlib, we will make the DataFrame-based API (spark.ml) front-and-center, 
> to make it clear the RDD-based API is the older, maintenance-mode one.
> * No docs for spark.mllib will be deleted; they will just be reorganized and 
> put in a subsection.
> * If spark.ml docs are less complete, or if spark.ml docs say "refer to the 
> spark.mllib docs for details," then we should copy those details to the 
> spark.ml docs.  This per-feature work can happen under [SPARK-14815].
> * This big reorganization should be done *after* docs are added for each 
> feature (to minimize merge conflicts).



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

---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]

Reply via email to