[
https://issues.apache.org/jira/browse/SPARK-13013?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Xin Ren updated SPARK-13013:
----------------------------
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.
{code}{% include_example scala ml.KMeansExample guide %}{code}
Jekyll will find
`examples/src/main/scala/org/apache/spark/examples/ml/KMeansExample.scala` and
pick code blocks marked "example" and put them under
{code}{% highlight %}{code}
in the markdown.
See more sub-tasks in parent ticket:
https://issues.apache.org/jira/browse/SPARK-11337
was:See examples in other finished sub-JIRAs.
> Replace example code in mllib-clustering.md using include_example
> -----------------------------------------------------------------
>
> Key: SPARK-13013
> URL: https://issues.apache.org/jira/browse/SPARK-13013
> Project: Spark
> Issue Type: Sub-task
> Components: Documentation
> Reporter: Xusen Yin
> Assignee: Xin Ren
> Priority: Minor
> Labels: starter
>
> 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.
> {code}{% include_example scala ml.KMeansExample guide %}{code}
> Jekyll will find
> `examples/src/main/scala/org/apache/spark/examples/ml/KMeansExample.scala`
> and pick code blocks marked "example" and put them under
> {code}{% highlight %}{code}
> in the markdown.
> See more sub-tasks in parent ticket:
> https://issues.apache.org/jira/browse/SPARK-11337
--
This message was sent by Atlassian JIRA
(v6.3.4#6332)
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscr...@spark.apache.org
For additional commands, e-mail: issues-h...@spark.apache.org
