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").
Note: Now that we have algorithms in spark.ml which are not in spark.mllib, we should make subsections for the spark.ml API as needed. We can follow the structure of the spark.mllib user guide.
- The spark.ml user guide can provide: (a) code examples and (b) info on algorithms which do not exist in spark.mllib.
- We should not duplicate info in the spark.ml guides. Since spark.mllib is still the primary API, we should provide links to the corresponding algorithms in the spark.mllib user guide for more info.