mirror of https://github.com/apache/zeppelin synced 2026-05-24 09:38:26 +00:00

1ambda 4b6d3e5574 [ZEPPELIN-2596] Improving documentation page

### What is this PR for?

Improving documentation page. Please check *TODO* and *Screenshots* sections for detail.
The motivation is described in [the JIRA ticket](https://issues.apache.org/jira/browse/ZEPPELIN-2583) and discussion is ongoing on the mailing list.

### What type of PR is it?
[Improvement | Documentation]

### Todos
* [x] - improved the navbar style
* [x] - improved the main page
* [x] - re-organized content structure
* [x] - added tutorial pages: `spark_with_zeppelin.md`, `python_with_zeppelin.md`, `sql_with_zeppelin.md` for overview
* [x] - added `multi_user_support.md` page to provide overview
* [x] - added the empty `interpreter_binding_mode` page. This will be handed in the different issue: [ZEPPELIN-2582](https://issues.apache.org/jira/browse/ZEPPELIN-2582)
* [x] - added the empty `trouble_shooting` page. This can be filled in the following PRs.
* [x] - added the empty `useful_developer_tools` page. This can be filled in the following PRs.

### What is the Jira issue?

[ZEPPELIN-2596](https://issues.apache.org/jira/browse/ZEPPELIN-2596)

### How should this be tested?

1. checkout
2. `cd docs`
3. `bundle install` (make sure that you have ruby 2.1.0+ and bundle)
4. `bundle exec jekyll serve --watch`
5. open `localhost:4000`

### Screenshots (if appropriate)

#### better navbar: before
![2596_before_nav](https://cloud.githubusercontent.com/assets/4968473/26542353/89004e7a-4494-11e7-89c0-28d608f5f375.gif)

#### better navbar: after

![2596_after_nav](https://cloud.githubusercontent.com/assets/4968473/26542356/8bfb7b90-4494-11e7-9979-0bcaef8ba97b.gif)

#### improved main page: before

![2596_before_main](https://cloud.githubusercontent.com/assets/4968473/26542358/8f35b0be-4494-11e7-8a6c-e74ec52fc384.gif)

#### improved main page: after

![2596_after_main](https://cloud.githubusercontent.com/assets/4968473/26542366/93b333c8-4494-11e7-981f-3f7b4545868f.gif)

#### organized content structure: before

![2596_before_content](https://cloud.githubusercontent.com/assets/4968473/26542398/ad81ac26-4494-11e7-9a17-70dff41396fb.gif)

#### organized content structure: after

![2596_after_content](https://cloud.githubusercontent.com/assets/4968473/26542403/b0a42ad2-4494-11e7-8bd3-8a5bd194c6af.gif)

### Questions:
* Does the licenses files need update? - NO
* Is there breaking changes for older versions? - NO
* Does this needs documentation? -  related with docs

Author: 1ambda <1amb4a@gmail.com>

Closes #2371 from 1ambda/updating-version-doc and squashes the following commits:

eb02fa967 [1ambda] fix: navbar focus color applies after folding
026379ed6 [1ambda] fix: Remove docs/.listen_test
a7dd4737b [1ambda] fix: sora's comment 1.2
18c5058f7 [1ambda] fix: resolve description in python_with_zeppelin.md
d3ad67c73 [1ambda] fix: sora's comment 4
d133dbbcc [1ambda] fix: resolve sora's comment 3
513c6ff2c [1ambda] fix: resolve sora's comment 1.1
4c2946928 [1ambda] fix: resovle sora's comment 2
1c3946ac6 [1ambda] fix: sora's comment 1
4d6e4267f [1ambda] fix: Resolve sola's comment 3
d0524cafe [1ambda] fix: Set less shadow for nav
5f1f998ba [1ambda] docs: Add useful_develop_tools.md
9dfd62c74 [1ambda] fix: Typo in installation.md
30f7d7e06 [1ambda] fix: Typo in helium ctrl
d6877e792 [1ambda] docs: Add python_with_zeppelin.md
7027e96c0 [1ambda] docs: Improve python conda, docker doc style
e55b50a9d [1ambda] fix: Invalid URLs
75ddeeaff [1ambda] docs: replace URIs in interpreter
5b43993a4 [1ambda] docs: Add sql_with_zeppelin
053794e84 [1ambda] docs: Add spark_with_zeppelin.md
d4d88b9c7 [1ambda] docs: Improve proxy doc
b46cdd126 [1ambda] docs: Add empty interpreter_binding_mode.md
06fcb239e [1ambda] docs: Add empty personalized_mode.md
4991cf0a7 [1ambda] docs: Update upgrading.md
53142b7a0 [1ambda] fix: Simplify install.md
8a5c1e721 [1ambda] docs: Add multi_user_support.md
34095775e [1ambda] fix: Increase font size to 15px
a03b04b33 [1ambda] fix: Remove sample text from trouble_shooting.md
199842590 [1ambda] fix: Remove docker doc link
66a2a7d26 [1ambda] docs: Improve impersonation page
0a6e3fc1d [1ambda] docs: Improve install doc
ccd999ed5 [1ambda] docs: Improve helium doc
f8d742d08 [1ambda] fix: an invalid link in navbar
b7aa5f884 [1ambda] fix: URLs in development
61a175d94 [1ambda] docs: Update install.md
4c56de5c4 [1ambda] fix: URLs in setup
0b1d63513 [1ambda] fix: URLs in quickstart
28970a4fe [1ambda] feat: Add docs/usage
735946bca [1ambda] feat: rename /quickstart
b351cf237 [1ambda] fix: Add missing links
b70770b4f [1ambda] feat: Change URLs in nav, index
94e80aef6 [1ambda] fix: doens't display navbar version in small
6e0cab110 [1ambda] feat: Update doc section names
b9ce256ff [1ambda] feat: Hide version in navbar when md
f8bab52be [1ambda] fix: Better image display in index.md
eeb37d5b5 [1ambda] fix: Add RL padding for mobile browser
ceb60b5ee [1ambda] feat: Style collapsed nav for mobile browser
4ebafb4b6 [1ambda] commit

2017-06-23 17:44:13 +09:00

7.1 KiB

Raw Blame History

layout	title	description	group
page	Installing Interpreters	Apache Zeppelin provides Interpreter Installation mechanism for whom downloaded Zeppelin netinst binary package, or just want to install another 3rd party interpreters.	usage/interpreter

{% include JB/setup %}

Installing Interpreters

Apache Zeppelin provides Interpreter Installation mechanism for whom downloaded Zeppelin netinst binary package, or just want to install another 3rd party interpreters.

Community managed interpreters

Apache Zeppelin provides several interpreters as community managed interpreters. If you downloaded netinst binary package, you need to install by using below commands.

Install all community managed interpreters

./bin/install-interpreter.sh --all

Install specific interpreters

./bin/install-interpreter.sh --name md,shell,jdbc,python

You can get full list of community managed interpreters by running

./bin/install-interpreter.sh --list

Install interpreter built with Scala 2.10

Zeppelin support both Scala 2.10 and 2.11 for several interpreters as below:

Name	Maven Artifact for Scala 2.10	Maven Artifact for Scala 2.11
cassandra	org.apache.zeppelin:zeppelin-cassandra_2.10:0.7.0	org.apache.zeppelin:zeppelin-cassandra_2.11:0.7.0
flink	org.apache.zeppelin:zeppelin-flink_2.10:0.7.0	org.apache.zeppelin:zeppelin-flink_2.11:0.7.0
ignite	org.apache.zeppelin:zeppelin-ignite_2.10:0.7.0	org.apache.zeppelin:zeppelin-ignite_2.11:0.7.0
scio	org.apache.zeppelin:zeppelin-scio_2.10:0.7.0	org.apache.zeppelin:zeppelin-scio_2.11:0.7.0
spark	org.apache.zeppelin:zeppelin-spark_2.10:0.7.0	org.apache.zeppelin:zeppelin-spark_2.11:0.7.0

If you install one of these interpreters only with --name option, installer will download interpreter built with Scala 2.11 by default. If you want to specify Scala version, you will need to add --artifact option. Here is the example of installing flink interpreter built with Scala 2.10.

./bin/install-interpreter.sh --name flink --artifact org.apache.zeppelin:zeppelin-flink_2.10:0.7.0

Install Spark interpreter built with Scala 2.10

Spark distribution package has been built with Scala 2.10 until 1.6.2. If you have SPARK_HOME set pointing to Spark version earlier than 2.0.0, you need to download Spark interpreter packaged with Scala 2.10. To do so, use follow command:

rm -rf ./interpreter/spark
./bin/install-interpreter.sh --name spark --artifact org.apache.zeppelin:zeppelin-spark_2.10:0.7.0

Once you have installed interpreters, you need to restart Zeppelin. And then [create interpreter setting](./overview.html#what-is-zeppelin-interpreter) and [bind it with your notebook](./overview.html#what-is-zeppelin-interpreter-setting).

3rd party interpreters

You can also install 3rd party interpreters located in the maven repository by using below commands.

Install 3rd party interpreters

./bin/install-interpreter.sh --name interpreter1 --artifact groupId1:artifact1:version1

The above command will download maven artifact groupId1:artifact1:version1 and all of its transitive dependencies into interpreter/interpreter1 directory.

After restart Zeppelin, then create interpreter setting and bind it with your note.

Install multiple 3rd party interpreters at once

./bin/install-interpreter.sh --name interpreter1,interpreter2 --artifact groupId1:artifact1:version1,groupId2:artifact2:version2

--name and --artifact arguments will recieve comma separated list.

Available community managed interpreters

You can also find the below community managed interpreter list in conf/interpreter-list file.

Name	Maven Artifact	Description
alluxio	org.apache.zeppelin:zeppelin-alluxio:0.7.0	Alluxio interpreter
angular	org.apache.zeppelin:zeppelin-angular:0.7.0	HTML and AngularJS view rendering
beam	org.apache.zeppelin:zeppelin-beam:0.7.0	Beam interpreter
bigquery	org.apache.zeppelin:zeppelin-bigquery:0.7.0	BigQuery interpreter
cassandra	org.apache.zeppelin:zeppelin-cassandra\_2.11:0.7.0	Cassandra interpreter built with Scala 2.11
elasticsearch	org.apache.zeppelin:zeppelin-elasticsearch:0.7.0	Elasticsearch interpreter
file	org.apache.zeppelin:zeppelin-file:0.7.0	HDFS file interpreter
flink	org.apache.zeppelin:zeppelin-flink\_2.11:0.7.0	Flink interpreter built with Scala 2.11
hbase	org.apache.zeppelin:zeppelin-hbase:0.7.0	Hbase interpreter
ignite	org.apache.zeppelin:zeppelin-ignite\_2.11:0.7.0	Ignite interpreter built with Scala 2.11
jdbc	org.apache.zeppelin:zeppelin-jdbc:0.7.0	Jdbc interpreter
kylin	org.apache.zeppelin:zeppelin-kylin:0.7.0	Kylin interpreter
lens	org.apache.zeppelin:zeppelin-lens:0.7.0	Lens interpreter
livy	org.apache.zeppelin:zeppelin-livy:0.7.0	Livy interpreter
md	org.apache.zeppelin:zeppelin-markdown:0.7.0	Markdown support
pig	org.apache.zeppelin:zeppelin-pig:0.7.0	Pig interpreter
python	org.apache.zeppelin:zeppelin-python:0.7.0	Python interpreter
scio	org.apache.zeppelin:zeppelin-scio\_2.11:0.7.0	Scio interpreter built with Scala 2.11
shell	org.apache.zeppelin:zeppelin-shell:0.7.0	Shell command

7.1 KiB Raw Blame History