bvaradar commented on a change in pull request #4: Improve aesthetics of site & added README for docs URL: https://github.com/apache/incubator-hudi/pull/4#discussion_r257372889
########## File path: docs/README.md ########## @@ -0,0 +1,29 @@ +## Site Documentation + +This folder contains resources that build the [Apache Hudi website](https://hudi.apache.org) + + +### Building docs + +The site is based on a [Jekyll](https://jekyllrb.com/) theme hosted [here](idratherbewriting.com/documentation-theme-jekyll/) with detailed instructions. + +To build the docs, first you need to install + +- gem, ruby (using apt-get/brew) +- bundler (`gem install bundler`) +- jekyll (`gem install jekyll`) + +and then run the following from `docs` folder to serve a local site + Review comment: FYI: I had to run bundle update --bundler once before running bundle exec ---------------------------------------------------------------- This is an automated message from the Apache Git Service. To respond to the message, please log on GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: [email protected] With regards, Apache Git Services
