zeppelin/docs
Lee moon soo 72c0d66b90 Use apache git mirror instead of github for repository url
### What is this PR for?
Use apache git mirror instead of github for repository url

### What type of PR is it?
Bug Fix

### Questions:
* Does the licenses files need update? no
* Is there breaking changes for older versions? no
* Does this needs documentation? no

Author: Lee moon soo <moon@apache.org>

Closes #616 from Leemoonsoo/remove_github and squashes the following commits:

9efcf0e [Lee moon soo] Add write access git url
f4b2c9f [Lee moon soo] Fix CONTRIBUTING.md
5c49b04 [Lee moon soo] Change repo url to apache git.apache.org from github.com
2016-01-11 22:26:29 +09:00
..
_includes Add a link for interpreter.md to navbar menu 2016-01-03 08:00:03 -08:00
_layouts ZEPPELIN-279: move website w/ docs to master branch 2015-09-05 19:48:22 +09:00
_plugins ZEPPELIN-279: move website w/ docs to master branch 2015-09-05 19:48:22 +09:00
assets/themes/zeppelin Display aggregation result with Elasticsearch interpreter 2016-01-05 17:44:23 +09:00
development ZEPPELIN-448 Update documentation for Spark configuration and BASE_PATH change 2015-11-21 15:25:14 +09:00
displaysystem ZEPPELIN-448 Update documentation for Spark configuration and BASE_PATH change 2015-11-21 15:25:14 +09:00
install [Zeppelin 537] Improve behavior of reloading notebooks from storage 2016-01-03 07:54:38 -08:00
interpreter Display aggregation result with Elasticsearch interpreter 2016-01-05 17:44:23 +09:00
manual Remove unnecessary spaces from docs/manual/dynamicform.md 2015-12-16 07:42:12 +09:00
rest-api ZEPPELIN-511 REST API: Insert / Retrieve / Move / Delete operation for paragraph 2015-12-27 11:29:20 -08:00
storage ZEPPELIN-143: Git as a versioned notebook storage 2015-12-08 10:57:30 +09:00
tutorial ZEPPELIN-412 Documentation based on Zeppelin version 2015-11-18 09:08:54 +09:00
404.html ZEPPELIN-279: move website w/ docs to master branch 2015-09-05 19:48:22 +09:00
_config.yml [Docs] Minor fixes for Elasticsearch documentation 2015-12-22 21:04:52 +09:00
atom.xml ZEPPELIN-279: move website w/ docs to master branch 2015-09-05 19:48:22 +09:00
doap.rdf [Website] adding DOAP file for projects.apache.org 2015-09-21 11:34:36 +09:00
Gemfile Apply #407 into master branch 2015-11-13 21:12:36 +09:00
Gemfile.lock Apply #407 into master branch 2015-11-13 21:12:36 +09:00
index.md Use apache git mirror instead of github for repository url 2016-01-11 22:26:29 +09:00
pleasecontribute.md ZEPPELIN-412 Documentation based on Zeppelin version 2015-11-18 09:08:54 +09:00
Rakefile ZEPPELIN-279: move website w/ docs to master branch 2015-09-05 19:48:22 +09:00
README.md ZEPPELIN-448 Update documentation for Spark configuration and BASE_PATH change 2015-11-21 15:25:14 +09:00
robot.txt Apply #407 into master branch 2015-11-13 21:12:36 +09:00
rss.xml ZEPPELIN-279: move website w/ docs to master branch 2015-09-05 19:48:22 +09:00
screenshots.md Apply #407 into master branch 2015-11-13 21:12:36 +09:00
sitemap.txt ZEPPELIN-279: move website w/ docs to master branch 2015-09-05 19:48:22 +09:00

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)

  1. generate static website in ./_site

    bundle exec jekyll build --safe
    
  2. checkout ASF repo

    svn co https://svn.apache.org/repos/asf/incubator/zeppelin asf-zepplelin
    
  3. copy zeppelin/_site to asf-zepplelin/site/docs/[VERSION]

  4. svn commit

Adding a new page

rake page name="new-page.md"

Bumping up version

  • BASE_PATH property in _config.yml
  • ZEPPELIN <small>([VERSION])</small> in _includes/themes/zeppelin/_navigation.html

need to be updated