[jira] [Commented] (SPARK-8639) Instructions for executing jekyll in docs/README.md could be slightly more clear, typo in docs/api.md

["Sean Owen (JIRA)" <ji...@apache.org>]

    [ https://issues.apache.org/jira/browse/SPARK-8639?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=14601768#comment-14601768 ] 

Sean Owen commented on SPARK-8639:
----------------------------------

OK, I almost don't see the difference in the first one. Yes the second is a typo. It's trivial but you can make a PR.

> Instructions for executing jekyll in docs/README.md could be slightly more clear, typo in docs/api.md
> -----------------------------------------------------------------------------------------------------
>
>                 Key: SPARK-8639
>                 URL: https://issues.apache.org/jira/browse/SPARK-8639
>             Project: Spark
>          Issue Type: Documentation
>          Components: Documentation
>            Reporter: Rosstin Murphy
>            Priority: Trivial
>
> In docs/README.md, the text states around line 31
> Execute 'jekyll' from the 'docs/' directory. Compiling the site with Jekyll will create a directory called '_site' containing index.html as well as the rest of the compiled files.
> It might be more clear if we said
> Execute 'jekyll build' from the 'docs/' directory to compile the site. Compiling the site with Jekyll will create a directory called '_site' containing index.html as well as the rest of the compiled files.
> In docs/api.md: "Here you can API docs for Spark and its submodules."
> should be something like: "Here you can read API docs for Spark and its submodules."



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