[jira] [Updated] (SPARK-10382) Implement a Jekyll tag to include example code in user guide

["Xiangrui Meng (JIRA)" <ji...@apache.org>]

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

Xiangrui Meng updated SPARK-10382:
----------------------------------
    Summary: Implement a Jekyll tag to include example code in user guide  (was: Make example code in user guide testable)

> Implement a Jekyll tag to include example code in user guide
> ------------------------------------------------------------
>
>                 Key: SPARK-10382
>                 URL: https://issues.apache.org/jira/browse/SPARK-10382
>             Project: Spark
>          Issue Type: Sub-task
>          Components: Documentation, ML, MLlib
>            Reporter: Xiangrui Meng
>            Assignee: Xusen Yin
>            Priority: Critical
>             Fix For: 1.6.0
>
>
> 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.
> One option I propose 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 "guide" and put them under `{% highlight %}` in the markdown. We can discuss the syntax for marker comments.
> Just one way to implement this. It would be nice to hear more ideas.



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

---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@spark.apache.org
For additional commands, e-mail: issues-help@spark.apache.org