mirror of
https://github.com/apache/zeppelin
synced 2026-05-24 09:38:26 +00:00
| .. | ||
| _includes | ||
| _layouts | ||
| _plugins | ||
| assets/themes/zeppelin | ||
| development | ||
| displaysystem | ||
| install | ||
| interpreter | ||
| manual | ||
| rest-api | ||
| storage | ||
| tutorial | ||
| 404.html | ||
| _config.yml | ||
| atom.xml | ||
| doap.rdf | ||
| docs.md | ||
| Gemfile | ||
| Gemfile.lock | ||
| index.md | ||
| pleasecontribute.md | ||
| Rakefile | ||
| README.md | ||
| robot.txt | ||
| rss.xml | ||
| screenshots.md | ||
| sitemap.txt | ||
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
bundle install
On OS X 10.9 you may need to do "xcode-select --install"
Run website
bundle exec jekyll serve --watch
Deploy to ASF svnpubsub infra (commiters only)
-
generate static website in
./_sitebundle exec jekyll build --safe -
checkout ASF repo
svn co https://svn.apache.org/repos/asf/incubator/zeppelin asf-zepplelin -
copy zeppelin/_site to asf-zepplelin/site/docs/[VERSION]
-
svn commit
Adding a new page
rake page name="new-page.md"
Bumping up version
BASE_PATHproperty in _config.ymlZEPPELIN <small>([VERSION])</small>in _includes/themes/zeppelin/_navigation.html
need to be updated