Inicio Explorar Axuda
Rexistro Iniciar sesión
ylproj
/
livy
2
0
Fork 0
Ficheiros Incidencias 0 Pull Requests 0 Wiki
Árbore: 1efc801806
Ramas Etiquetas
livy
/
docs
Alex Bozarth 5e0201f601 [MINOR] Missed Doc update during 0.4 release %!s(int64=7) %!d(string=hai) anos
..
_data a4760c6683 [MINOR] Fix two version number issues in doc %!s(int64=7) %!d(string=hai) anos
_includes be3fe03457 [LIVY-384][DOCS] Added ability to build Livy Docs %!s(int64=7) %!d(string=hai) anos
_layouts be3fe03457 [LIVY-384][DOCS] Added ability to build Livy Docs %!s(int64=7) %!d(string=hai) anos
assets be3fe03457 [LIVY-384][DOCS] Added ability to build Livy Docs %!s(int64=7) %!d(string=hai) anos
Gemfile be3fe03457 [LIVY-384][DOCS] Added ability to build Livy Docs %!s(int64=7) %!d(string=hai) anos
Gemfile.lock be3fe03457 [LIVY-384][DOCS] Added ability to build Livy Docs %!s(int64=7) %!d(string=hai) anos
README.md be3fe03457 [LIVY-384][DOCS] Added ability to build Livy Docs %!s(int64=7) %!d(string=hai) anos
_config.yml be3fe03457 [LIVY-384][DOCS] Added ability to build Livy Docs %!s(int64=7) %!d(string=hai) anos
index.md be3fe03457 [LIVY-384][DOCS] Added ability to build Livy Docs %!s(int64=7) %!d(string=hai) anos
programmatic-api.md 5e0201f601 [MINOR] Missed Doc update during 0.4 release %!s(int64=7) %!d(string=hai) anos
rest-api.md 80571b9e49 [MINOR] Doc Typos %!s(int64=7) %!d(string=hai) anos

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

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.