zeppelin/docs/README.md at 7b1b36accdfd790262905ff90085dd67f3fafd4f

mirror of https://github.com/apache/zeppelin synced 2026-05-24 09:38:26 +00:00

Mina Lee 4a4691fa59 [MINOR] Make nav zeppelin version to point ZEPPELIN_VERSION in _config.yml

### What is this PR for?
One less line to change when releasing docs by making `ZEPPELIN_VERSION` to be retrieved from `_config.yml`.

### Questions:
* Does the licenses files need update? No
* Is there breaking changes for older versions? No
* Does this needs documentation? Will be updated in https://cwiki.apache.org/confluence/display/ZEPPELIN/Preparing+Zeppelin+Release

Author: Mina Lee <minalee@apache.org>

Closes #997 from minahlee/docs/navZeppelinVersion and squashes the following commits:

dd547b2 [Mina Lee] Make nav zeppelin version to point ZEPPELIN_VERSION in _config.yml

2016-06-14 09:40:49 -07:00

1 KiB

Raw Blame History

Zeppelin documentation

This readme will walk you through building the Zeppelin documentation, which is included here with the Zeppelin source code.

Build documentation

See https://help.github.com/articles/using-jekyll-with-pages#installing-jekyll

tl;dr version:

    ruby --version >= 1.9.3
    gem install bundler
    # go to /docs under your Zeppelin source
    bundle install

On OS X 10.9 you may need to do "xcode-select --install"

Run website

bundle exec jekyll serve --watch

Adding a new page

rake page name="new-page.md"

Bumping up version in a new release

ZEPPELIN_VERSION and BASE_PATH property in _config.yml

Deploy to ASF svnpubsub infra (for committers only)

generate 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

1 KiB Raw Blame History