Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
172 changes: 125 additions & 47 deletions docs/Gemfile.lock
Original file line number Diff line number Diff line change
@@ -1,55 +1,133 @@
GEM
remote: https://rubygems.org/
specs:
RedCloth (4.2.9)
classifier (1.3.3)
fast-stemmer (>= 1.0.0)
colorator (0.1)
commander (4.1.5)
highline (~> 1.6.11)
fast-stemmer (1.0.2)
ffi (1.9.3)
github-pages (10)
RedCloth (= 4.2.9)
jekyll (= 1.3.0)
kramdown (= 1.2.0)
liquid (= 2.5.4)
maruku (= 0.6.1)
rdiscount (= 2.1.7)
redcarpet (= 2.3.0)
highline (1.6.20)
jekyll (1.3.0)
classifier (~> 1.3)
colorator (~> 0.1)
commander (~> 4.1.3)
liquid (~> 2.5.2)
listen (~> 1.3)
maruku (~> 0.6.0)
pygments.rb (~> 0.5.0)
redcarpet (~> 2.3.0)
safe_yaml (~> 1.0.4)
kramdown (1.2.0)
liquid (2.5.4)
listen (1.3.1)
activesupport (4.2.7)
i18n (~> 0.7)
json (~> 1.7, >= 1.7.7)
minitest (~> 5.1)
thread_safe (~> 0.3, >= 0.3.4)
tzinfo (~> 1.1)
addressable (2.4.0)
coffee-script (2.4.1)
coffee-script-source
execjs
coffee-script-source (1.10.0)
colorator (1.1.0)
ethon (0.9.1)
ffi (>= 1.3.0)
execjs (2.7.0)
faraday (0.9.2)
multipart-post (>= 1.2, < 3)
ffi (1.9.14)
forwardable-extended (2.6.0)
gemoji (2.1.0)
github-pages (98)
activesupport (= 4.2.7)
github-pages-health-check (= 1.2.0)
jekyll (= 3.2.1)
jekyll-coffeescript (= 1.0.1)
jekyll-feed (= 0.5.1)
jekyll-gist (= 1.4.0)
jekyll-github-metadata (= 2.1.1)
jekyll-mentions (= 1.2.0)
jekyll-paginate (= 1.1.0)
jekyll-redirect-from (= 0.11.0)
jekyll-sass-converter (= 1.3.0)
jekyll-seo-tag (= 2.0.0)
jekyll-sitemap (= 0.10.0)
jekyll-swiss (= 0.4.0)
jemoji (= 0.7.0)
kramdown (= 1.11.1)
liquid (= 3.0.6)
listen (= 3.0.6)
mercenary (~> 0.3)
minima (= 1.2.0)
rouge (= 1.11.1)
terminal-table (~> 1.4)
github-pages-health-check (1.2.0)
addressable (~> 2.3)
net-dns (~> 0.8)
octokit (~> 4.0)
public_suffix (~> 1.4)
typhoeus (~> 0.7)
html-pipeline (2.4.2)
activesupport (>= 2)
nokogiri (>= 1.4)
i18n (0.7.0)
jekyll (3.2.1)
colorator (~> 1.0)
jekyll-sass-converter (~> 1.0)
jekyll-watch (~> 1.1)
kramdown (~> 1.3)
liquid (~> 3.0)
mercenary (~> 0.3.3)
pathutil (~> 0.9)
rouge (~> 1.7)
safe_yaml (~> 1.0)
jekyll-coffeescript (1.0.1)
coffee-script (~> 2.2)
jekyll-feed (0.5.1)
jekyll-gist (1.4.0)
octokit (~> 4.2)
jekyll-github-metadata (2.1.1)
jekyll (~> 3.1)
octokit (~> 4.0)
jekyll-mentions (1.2.0)
activesupport (~> 4.0)
html-pipeline (~> 2.3)
jekyll (~> 3.0)
jekyll-paginate (1.1.0)
jekyll-redirect-from (0.11.0)
jekyll (>= 2.0)
jekyll-sass-converter (1.3.0)
sass (~> 3.2)
jekyll-seo-tag (2.0.0)
jekyll (~> 3.1)
jekyll-sitemap (0.10.0)
jekyll-swiss (0.4.0)
jekyll-watch (1.5.0)
listen (~> 3.0, < 3.1)
jemoji (0.7.0)
activesupport (~> 4.0)
gemoji (~> 2.0)
html-pipeline (~> 2.2)
jekyll (>= 3.0)
json (1.8.3)
kramdown (1.11.1)
liquid (3.0.6)
listen (3.0.6)
rb-fsevent (>= 0.9.3)
rb-inotify (>= 0.9)
rb-kqueue (>= 0.2)
maruku (0.6.1)
syntax (>= 1.0.0)
posix-spawn (0.3.6)
pygments.rb (0.5.4)
posix-spawn (~> 0.3.6)
yajl-ruby (~> 1.1.0)
rb-fsevent (0.9.3)
rb-inotify (0.9.2)
rb-inotify (>= 0.9.7)
mercenary (0.3.6)
mini_portile2 (2.1.0)
minima (1.2.0)
minitest (5.9.1)
multipart-post (2.0.0)
net-dns (0.8.0)
nokogiri (1.6.8.1)
mini_portile2 (~> 2.1.0)
octokit (4.3.0)
sawyer (~> 0.7.0, >= 0.5.3)
pathutil (0.14.0)
forwardable-extended (~> 2.6)
public_suffix (1.5.3)
rb-fsevent (0.9.7)
rb-inotify (0.9.7)
ffi (>= 0.5.0)
rb-kqueue (0.2.0)
ffi (>= 0.5.0)
rdiscount (2.1.7)
redcarpet (2.3.0)
rouge (1.11.1)
safe_yaml (1.0.4)
syntax (1.0.0)
yajl-ruby (1.1.0)
sass (3.4.22)
sawyer (0.7.0)
addressable (>= 2.3.5, < 2.5)
faraday (~> 0.8, < 0.10)
terminal-table (1.7.3)
unicode-display_width (~> 1.1.1)
thread_safe (0.3.5)
typhoeus (0.8.0)
ethon (>= 0.8.0)
tzinfo (1.2.2)
thread_safe (~> 0.1)
unicode-display_width (1.1.1)

PLATFORMS
ruby
Expand All @@ -58,4 +136,4 @@ DEPENDENCIES
github-pages

BUNDLED WITH
1.10.4
1.11.2
11 changes: 6 additions & 5 deletions docs/_config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,11 @@
permalink: /:categories/:year/:month/:day/:title

exclude: [".rvmrc", ".rbenv-version", "README.md", "Rakefile", "changelog.md", "vendor", "node_modules", "scss"]
pygments: true
markdown: redcarpet
redcarpet:
extensions: ["tables"]
highlighter: true
markdown: kramdown
kramdown:
input: GFM
syntax_highlighter: rouge
encoding: utf-8

# Themes are encouraged to use these universal variables
Expand Down Expand Up @@ -69,7 +70,7 @@ JB :
# http://s3.amazonaws.com/yoursite/themes/watermelon
# /assets
#
ASSET_PATH : false
ASSET_PATH : /assets/themes/zeppelin

# These paths are to the main pages Jekyll-Bootstrap ships with.
# Some JB helpers refer to these paths; change them here if needed.
Expand Down
2 changes: 1 addition & 1 deletion docs/atom.xml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
layout: nil
layout: null
title :
---
<?xml version="1.0" encoding="utf-8"?>
Expand Down
17 changes: 8 additions & 9 deletions docs/development/howtocontribute.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,13 +51,13 @@ First of all, you need Zeppelin source code. The official location of Zeppelin i

Get the source code on your development machine using git.

```
```bash
git clone git://git.apache.org/zeppelin.git zeppelin
```

You may also want to develop against a specific branch. For example, for branch-0.5.6

```
```bash
git clone -b branch-0.5.6 git://git.apache.org/zeppelin.git zeppelin
```

Expand All @@ -66,27 +66,27 @@ If you want to not only build Zeppelin but also make any changes, then you need

### Build

```
```bash
mvn install
```

To skip test

```
```bash
mvn install -DskipTests
```

To build with specific spark / hadoop version

```
```bash
mvn install -Dspark.version=x.x.x -Dhadoop.version=x.x.x
```

For the further

### Run Zeppelin server in development mode

```
```bash
cd zeppelin-server
HADOOP_HOME=YOUR_HADOOP_HOME JAVA_HOME=YOUR_JAVA_HOME mvn exec:java -Dexec.mainClass="org.apache.zeppelin.server.ZeppelinServer" -Dexec.args=""
```
Expand All @@ -95,7 +95,7 @@ HADOOP_HOME=YOUR_HADOOP_HOME JAVA_HOME=YOUR_JAVA_HOME mvn exec:java -Dexec.mainC

or use daemon script

```
```bash
bin/zeppelin-daemon start
```

Expand All @@ -107,8 +107,7 @@ Some portions of the Zeppelin code are generated by [Thrift](http://thrift.apach

To regenerate the code, install **thrift-0.9.2** and change directory into Zeppelin source directory. and then run following command


```
```bash
thrift -out zeppelin-interpreter/src/main/java/ --gen java zeppelin-interpreter/src/main/thrift/RemoteInterpreterService.thrift
```

Expand Down
8 changes: 6 additions & 2 deletions docs/development/howtocontributewebsite.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,13 +39,18 @@ Documentation website is hosted in 'master' branch under `/docs/` dir.
First of all, you need the website source code. The official location of mirror for Zeppelin is [http://git.apache.org/zeppelin.git](http://git.apache.org/zeppelin.git).
Get the source code on your development machine using git.

```
```bash
git clone git://git.apache.org/zeppelin.git
cd docs
```

Apache Zeppelin follows [Fork & Pull](https://github.com/sevntu-checkstyle/sevntu.checkstyle/wiki/Development-workflow-with-Git:-Fork,-Branching,-Commits,-and-Pull-Request) as a source control workflow.
If you want to not only build Zeppelin but also make any changes, then you need to fork [Zeppelin github mirror repository](https://github.com/apache/zeppelin) and make a pull request.

### Kramdown

Documentation based on jekyll 3.x and kramdown (tweaked markdown for github pages and so on). You have to get used to editing `.md` files with [kramdown](http://kramdown.gettalong.org/quickref.html)

### Build

You'll need to install some prerequisites to build the code. Please check [Build documentation](https://github.com/apache/zeppelin/blob/master/docs/README.md#build-documentation) section in [docs/README.md](https://github.com/apache/zeppelin/blob/master/docs/README.md).
Expand All @@ -59,7 +64,6 @@ Then you'll be able to access it on [http://localhost:4000](http://localhost:400

When you are ready, just make a pull-request.


## Alternative way

You can directly edit `.md` files in `/docs/` directory at the web interface of github and make pull-request immediately.
Expand Down
9 changes: 0 additions & 9 deletions docs/development/writingzeppelinapplication.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,13 +27,11 @@ limitations under the License.

Apache Zeppelin Application is a package that runs on Interpreter process and displays it's output inside of the notebook. While application runs on Interpreter process, it's able to access resources provided by Interpreter through ResourcePool. Output is always rendered by AngularDisplaySystem. Therefore application provides all the possiblities of making interactive graphical application that uses data and processing power of any Interpreter.


## Make your own Application

Writing Application means extending `org.apache.zeppelin.helium.Application`. You can use your favorite IDE and language while Java class files are packaged into jar. `Application` class looks like

```java

/**
* Constructor. Invoked when application is loaded
*/
Expand All @@ -52,18 +50,15 @@ public abstract void run(ResourceSet args);
public abstract void unload();
```


You can check example applications under [./zeppelin-examples](https://github.com/apache/incubator-zeppelin/tree/master/zeppelin-examples) directory.


## Development mode

In the development mode, you can run your Application in your IDE as a normal java application and see the result inside of Zeppelin notebook.

`org.apache.zeppelin.interpreter.dev.ZeppelinApplicationDevServer` can run Zeppelin Application in development mode.

```java

// entry point for development mode
public static void main(String[] args) throws Exception {

Expand All @@ -82,10 +77,8 @@ public static void main(String[] args) throws Exception {
}
```


In the Zeppelin notebook, run `%dev run` will connect to application running in development mode.


## Package file

Package file is a json file that provides information about the application.
Expand All @@ -103,7 +96,6 @@ Json file contains the following information
],
icon : "<i class="icon"></i>"
}

```

#### name
Expand Down Expand Up @@ -174,7 +166,6 @@ resources: [
]
```


#### icon

Icon to be used on the application button. String in this field will be rendered as a HTML tag.
Expand Down
Loading