This README will walk you through building the documentation of Apache Zeppelin. The documentation is included here with Apache Zeppelin source code. The online documentation at https://zeppelin.apache.org/docs/<ZEPPELIN_VERSION> is also generated from the files found in here.
Zeppelin is using Jekyll which is a static site generator and Github Pages as a site publisher. For the more details, see help.github.com/articles/about-github-pages-and-jekyll/.
Requirements
# ruby --version >= 2.0.0 # Install Bundler using gem gem install bundler cd $ZEPPELIN_HOME/docs # Install all dependencies declared in the Gemfile bundle install
For the further information about requirements, please see here.
On OS X 10.9, you may need to do
xcode-select --install
Docker
Local docker environments are also supported and have been tested using:
If you don't want to encounter ugly rendered pages, run the documentation site in your local environment first.
In $ZEPPELIN_HOME/docs, run one of the desired commands:
Run locally
bundle exec jekyll serve --watch
Run locally using docker
docker run --rm -it \
-v $PWD:/docs \
-w /docs \
-p '4000:4000' \
ruby:2.0.0 \
bash -c "bundle install && bundle exec jekyll serve --watch"
Using the above command, Jekyll will start a web server at http://localhost:4000 and watch the /docs directory for updates.
If you wish to help us and contribute to Zeppelin Documentation, please look at Zeppelin Documentation's contribution guideline.
ZEPPELIN_VERSION and BASE_PATH property in _config.ymlgenerate static website in ./_site
# go to /docs under Zeppelin source bundle exec jekyll build --safe
checkout ASF repo
svn co https://svn.apache.org/repos/asf/zeppelin asf-zeppelin
copy zeppelin/docs/_site to asf-zeppelin/site/docs/[VERSION]
svn commit