Google Git
Sign in
apache / incubator-livy / 66b5833e413bc10e39e3b92b585f496444c147d4 / . / docs
tree: aaeb7b58b7e7cdcc5a114e580119686c125994f0 [path history] [tgz]
  1. _data/
  2. _includes/
  3. _layouts/
  4. _plugins/
  5. assets/
  6. _config.yml
  7. Gemfile
  8. Gemfile.lock
  9. index.md
  10. programmatic-api.md
  11. README.md
  12. rest-api.md
docs/README.md

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

API Docs (Scaladocs and Javadocs)

You can build just the Livy javadocs by running mvn javadoc:aggregate from the LIVY_HOME directory, or the Livy scaladocs by running mvn scala:doc in certain modules. (Scaladocs do not currently build in every module)

When you run jekyll build in the docs directory, it will also copy over the scaladocs and javadocs for the public APIs into the docs directory (and then also into the _site directory). We use a jekyll plugin to run the api builds before building the site so if you haven't run it (recently) it may take some time as it generates all of the scaladoc and javadoc using Maven.

NOTE: To skip the step of building and copying over the Scala and Java API docs, run SKIP_API=1 jekyll build.

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 nesesary, 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.