Elgato_dark/zeppelin
1
0
Fork 0
mirror of https://github.com/apache/zeppelin synced 2026-05-24 09:38:26 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 1
zeppelin/docs
History
Felix Cheung c484bf74ef [ZEPPELIN-632][DOC] Document steps to contribute a new interpreter 
### What is this PR for?
Instead of going through a list of items one by one in PR review, we should have a checklist of TODOs for a potential interpreter contributor to review and follow

### What type of PR is it?
Documentation

### Todos
* [x] - Update doc

### Is there a relevant Jira issue?
https://issues.apache.org/jira/browse/ZEPPELIN-632

### How should this be tested?
N/A

### Screenshots (if appropriate)
N/A

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

Author: Felix Cheung <felixcheung_m@hotmail.com>

Closes #675 from felixcheung/createinterpreterdoc and squashes the following commits:

0feb8fe [Felix Cheung] add link
2a4aa4b [Felix Cheung] add link to pom src
dc47a58 [Felix Cheung] small wording update
78d9127 [Felix Cheung] doc update
2016-02-06 10:57:12 -08:00
..
_includes HBase Shell Interpreter 2016-02-02 20:22:15 -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 [Zeppelin-630] Introduce new way of dependency loading to intepreter 2016-02-01 11:10:43 +09:00
development [ZEPPELIN-632][DOC] Document steps to contribute a new interpreter 2016-02-06 10:57:12 -08:00
displaysystem (Documentation): Utilities for Angular Display System 2016-02-01 11:02:07 +09:00
install Fix dead link and add table tab to Zeppelin Configuration section: docs/install/install.md 2016-02-04 09:47:30 -08:00
interpreter [DOC] Update doc for HBase interpreter 2016-02-03 17:16:03 -08:00
manual [ZEPPELIN-632][DOC] Document steps to contribute a new interpreter 2016-02-06 10:57:12 -08:00
rest-api [Zeppelin-630] Introduce new way of dependency loading to intepreter 2016-02-01 11:10:43 +09:00
storage ZEPPELIN-143: Git as a versioned notebook storage 2015-12-08 10:57:30 +09:00
tutorial Fix some typos, grammars and Increase readability documentation 2016-01-17 08:20:36 -08: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

README.md

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