[jira] [Created] (FLINK-2981) Update README for building docs

classic Classic list List threaded Threaded
1 message Options
Reply | Threaded
Open this post in threaded view
|

[jira] [Created] (FLINK-2981) Update README for building docs

Shang Yuanchun (Jira)
Martin Junghanns created FLINK-2981:
---------------------------------------

             Summary: Update README for building docs
                 Key: FLINK-2981
                 URL: https://issues.apache.org/jira/browse/FLINK-2981
             Project: Flink
          Issue Type: Improvement
          Components: Documentation
    Affects Versions: 1.0
            Reporter: Martin Junghanns
            Assignee: Martin Junghanns
            Priority: Minor


I ran into some issues following the current docs/README.md

It should be stated which gem versions need to be installed. jekyll-3.0.0 (which is the latest) leads to errors when running build_docs.sh. Using jekyll 2.5.3, the build process runs as expected.

Furthermore, it should be mentioned that
pygmentize.rb and some javascript engine (e.g. therubyracer) must be installed.



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