Rosstin Murphy created SPARK-8639:
-------------------------------------

             Summary: 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: [email protected]
For additional commands, e-mail: [email protected]

Reply via email to