zeppelin/docs
Jungtaek Lim f78d3096e0 ZEPPELIN-528 REST API: add "progress" to 'get notebook job' API
### What is this PR for?

To add 'progress' to 'get notebook job' REST API.
All paragraphs which status is 'running' will include 'progress' to their job status.

### What type of PR is it?

Improvement

### Todos

### Is there a relevant Jira issue?

https://issues.apache.org/jira/browse/ZEPPELIN-528

### How should this be tested?

1. Run a notebook or paragraph which takes some times. Paragraph which could show progress (%) would be more appreciated. Confirm that its status is 'RUNNING'.
2. Call ```http://<zeppelin host>:<zeppelin port>/api/notebook/job/<notebook id>``` to see if it has 'progress' field in JSON.

### Screenshots (if appropriate)

![notebook-2b68v95jm](https://cloud.githubusercontent.com/assets/1317309/11949192/cf176d8e-a8bf-11e5-9bb2-8f4dbd1666c8.png)
![notebook-job-api-result-2b68v95jm](https://cloud.githubusercontent.com/assets/1317309/11949191/cf16f7e6-a8bf-11e5-825b-97c6fa227d05.png)

### Questions:
* Does the licenses files need update? (No)
* Is there breaking changes for older versions? (No)
* Does this needs documentation? (Yes or no. Output of the JSON format could be updated, but it could be treated as not mandatory.)

Author: Jungtaek Lim <kabhwan@gmail.com>

Closes #563 from HeartSaVioR/ZEPPELIN-528 and squashes the following commits:

dc86b01 [Jungtaek Lim] ZEPPELIN-528 Add UT to get notebook job (especially 'progress' field)
69a58ab [Jungtaek Lim] Merge branch 'master' into ZEPPELIN-528
31a8e88 [Jungtaek Lim] ZEPPELIN-528 Explain new field 'progress' to JSON output
2597ebf [Jungtaek Lim] ZEPPELIN-528 Add 'progress' to paragraph information when running
2015-12-25 01:00:07 +09:00
..
_includes [Docs] Minor fixes for Elasticsearch documentation 2015-12-22 21:04:52 +09: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 [Docs] Minor fixes for Elasticsearch documentation 2015-12-22 21:04:52 +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-358: Jetty server is HTTP ERROR 404 2015-12-04 09:02:34 +09:00
interpreter [Docs] Minor fixes for Elasticsearch documentation 2015-12-22 21:04:52 +09:00
manual Remove unnecessary spaces from docs/manual/dynamicform.md 2015-12-16 07:42:12 +09:00
rest-api ZEPPELIN-528 REST API: add "progress" to 'get notebook job' API 2015-12-25 01:00:07 +09: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
docs.md [Docs] Minor fixes for Elasticsearch documentation 2015-12-22 21:04:52 +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 ZEPPELIN-448 Update documentation for Spark configuration and BASE_PATH change 2015-11-21 15:25:14 +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