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

Joseph K. Bradley updated SPARK-14815:
--------------------------------------
    Description: 
Check the user guide vs. a list of new APIs (classes, methods, data members) to 
see what items require updates to the user guide.

For each feature missing user guide doc:
* Create a JIRA for that feature, and assign it to the author of the feature
* Link it to (a) the original JIRA which introduced that feature ("related to") 
and (b) to this JIRA ("requires").

For MLlib:
* This task does not include major reorganizations for the programming guide; 
that will be under [SPARK-14817].
* We should now begin copying algorithm details from the spark.mllib guide to 
spark.ml as needed, rather than just linking back to the corresponding 
algorithms in the spark.mllib user guide.


  was:
Check the user guide vs. a list of new APIs (classes, methods, data members) to 
see what items require updates to the user guide.

For each feature missing user guide doc:
* Create a JIRA for that feature, and assign it to the author of the feature
* Link it to (a) the original JIRA which introduced that feature ("related to") 
and (b) to this JIRA ("requires").

For MLlib:
* Since spark.ml is becoming the primary API in 2.0, we will need to make this 
the case in the documentation organization.  However, that reorg should be done 
*after* docs are added for each feature (to minimize merge conflicts).
* We should now also begin copying algorithm details from the spark.mllib guide 
to spark.ml as needed, rather than just linking back to the corresponding 
algorithms in the spark.mllib user guide.



> ML, Graph, R 2.0 QA: Update user guide for new APIs
> ---------------------------------------------------
>
>                 Key: SPARK-14815
>                 URL: https://issues.apache.org/jira/browse/SPARK-14815
>             Project: Spark
>          Issue Type: Sub-task
>          Components: Documentation, GraphX, ML, MLlib, SparkR
>            Reporter: Joseph K. Bradley
>
> Check the user guide vs. a list of new APIs (classes, methods, data members) 
> to see what items require updates to the user guide.
> For each feature missing user guide doc:
> * Create a JIRA for that feature, and assign it to the author of the feature
> * Link it to (a) the original JIRA which introduced that feature ("related 
> to") and (b) to this JIRA ("requires").
> For MLlib:
> * This task does not include major reorganizations for the programming guide; 
> that will be under [SPARK-14817].
> * We should now begin copying algorithm details from the spark.mllib guide to 
> spark.ml as needed, rather than just linking back to the corresponding 
> algorithms in the spark.mllib user guide.



--
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