livy/docs

Apache Livy Documentation

This documentation is generated using Jekyll.

How to deploy the documentation

Installing Jekyll and dependencies

The steps below will install the latest Jekyll version and any dependencies required to get this documentation built.

1. sudo gem install jekyll bundler
2. cd docs
3. sudo bundle install

For more information, see Installing Jekyll.

Running locally

Before opening a pull request, you can preview your contributions by running from within the directory:

1. cd docs
2. bundle exec jekyll serve --watch
3. Open http://localhost:4000

Publishing Docs to [livy.incubator.apache.org]

1. Build Livy Docs (cd docs then bundle exec jekyll build).
2. Copy the contents of docs/target/ excluding assets/ into a new directory (eg. 0.4.0/) and move it into the docs/ directory in your local fork of apache/incubator-livy-website.
3. If this is a major version, update the latest symlink to point to the new directory.
4. Open a pull request to apache/incubator-livy-website with the update.

Note: If you made any changes to files in the assets/ directory you will need to replicate those changes in the corresponding files in apache/incubator-livy-website in the pull request.