[SPARK-13015] Replace example code in mllib-data-types.md using include_example

• Type: Sub-task
• Status: Resolved
• Priority: Minor
• Resolution: Won't Fix
• Component/s: Documentation
• Labels: starter
• Target Version/s: 2.0.0
• Assignee: Xin Ren
• Reporter: Xusen Yin
• Shepherd: Xusen Yin
• Created: 26/Jan/16 22:31
• Updated: 04/Jul/16 22:55
• Resolved: 25/Apr/16 18:31

Description

The example code in the user guide is embedded in the markdown and hence it is not easy to test. It would be nice to automatically test them. This JIRA is to discuss options to automate example code testing and see what we can do in Spark 1.6.

Goal is to move actual example code to spark/examples and test compilation in Jenkins builds. Then in the markdown, we can reference part of the code to show in the user guide. This requires adding a Jekyll tag that is similar to https://github.com/jekyll/jekyll/blob/master/lib/jekyll/tags/include.rb, e.g., called include_example.

{% include_example scala/org/apache/spark/examples/mllib/LocalVectorExample.scala %}

Jekyll will find `examples/src/main/scala/org/apache/spark/examples/mllib/LocalVectorExample.scala` and pick code blocks marked "example" and replace code block in

{% highlight %}

in the markdown.

See more sub-tasks in parent ticket: https://issues.apache.org/jira/browse/SPARK-11337

Issue Links

• is a clone of: SPARK-13012 Replace example code in ml-guide.md using include_example
• is blocked by: SPARK-16372 Retag RDD to tallSkinnyQR of RowMatrix
• is blocked by: SPARK-16369 tallSkinnyQR of RowMatrix should aware of empty partition
• links to: [Github] Pull Request #11128 (keypointt)
• links to: [Github] Pull Request #14006 (yinxusen)