Uploaded image for project: 'Spark'
  1. Spark
  2. SPARK-8639

Instructions for executing jekyll in docs/README.md could be slightly more clear, typo in docs/api.md

    XMLWordPrintableJSON

Details

    • Documentation
    • Status: Resolved
    • Trivial
    • Resolution: Fixed
    • None
    • 1.4.1, 1.5.0
    • Documentation
    • None

    Description

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

      Attachments

        Activity

          People

            Rosstin Rosstin Murphy
            Rosstin Rosstin Murphy
            Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved: