Skip to content

Commit d0675e0

Browse files
committed
ZEPPELIN-546-docs: Fix some sentences
1 parent 266dac0 commit d0675e0

File tree

1 file changed

+11
-17
lines changed

1 file changed

+11
-17
lines changed

docs/manual/dynamicinterpreterload.md

Lines changed: 11 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -21,13 +21,13 @@ limitations under the License.
2121

2222
## Dynamic Interpreter Loading using REST API
2323

24-
Zeppelin provides pluggable interpreter architecture which results in a wide and variety of the supported backend system. In this section, we will introduce **Dynamic interpreter loading** using **REST API**. Actually this concept is come up with [Zeppelin Helium Proposal](https://cwiki.apache.org/confluence/display/ZEPPELIN/Helium+proposal).
25-
Before the start, if you are not clear about the concept of **Zeppelin interpreter**, you can ckeck out [Overview of Zeppelin interpreter](../manual/interpreters.html) first.
24+
Zeppelin provides pluggable interpreter architecture which results in a wide and variety of the supported backend system. In this section, we will introduce **Dynamic interpreter loading** using **REST API**. This concept actually comes from [Zeppelin Helium Proposal](https://cwiki.apache.org/confluence/display/ZEPPELIN/Helium+proposal).
25+
Before we start, if you are not familiar with the concept of **Zeppelin interpreter**, you can check out [Overview of Zeppelin interpreter](../manual/interpreters.html) first.
2626

2727
<br/>
2828
## Overview
29-
In the past, Zeppelin loads interpreter binaries from `/interpreter/[interpreter_name]` directory. And they are configured by `zeppelin.interpreters` property in `conf/zeppelin-site.xml` or `ZEPPELIN_INTERPRETERS` env variables in `conf/zeppelin-env.sh`. They are loaded when Zeppelin server is starting up and stay alive until the server is down.
30-
However, for using 3rd party interpreter much easier, we change this way to **dynamically** loading interpreters from **Maven Repository** using **REST API**. Hopefully, below picture helps you to understand the process easily.
29+
In the past, Zeppelin was loading interpreter binaries from `/interpreter/[interpreter_name]` directory. They were configured by `zeppelin.interpreters` property in `conf/zeppelin-site.xml` or `ZEPPELIN_INTERPRETERS` env variables in `conf/zeppelin-env.sh`. They were loaded on Zeppelin server startup and stayed alive until the server was stopped.
30+
In order to simplify using 3rd party interpreters, we changed this way to **dynamically** load interpreters from **Maven Repository** using **REST API**. Hopefully, the picture below will help you to understand the process.
3131
<center><img src="../assets/themes/zeppelin/img/docs-img/zeppelin_user.png" height="85%" width="85%"></center>
3232

3333
## Load & Unload Interpreters Using REST API
@@ -40,15 +40,15 @@ You can **load** interpreters located in Maven repository using REST API, like t
4040
```
4141
http://[zeppelin-server]:[zeppelin-port]/api/interpreter/load/[interpreter_group_name]/[interpreter_name]
4242
```
43-
The Restful method will be <code>**POST**</code>. And the parameters you need are like:
43+
The Restful method will be <code>**POST**</code>. And the parameters you need are:
4444

4545
1. **Artifact:** Maven artifact ( groupId:artifactId:version )
4646

4747
2. **Class Name:** Package name + Interpreter class name
4848

4949
3. **Repository ( optional ):** Additional maven repository address
5050

51-
For example, if you want to load `markdown` interpreter to your Zeppelin, above parameters and the URL you need may like:
51+
For example, if you want to load `markdown` interpreter to your Zeppelin, the parameters and URL you need may look like:
5252

5353
```
5454
http://127.0.0.1:8080/api/interpreter/load/md/markdown
@@ -89,22 +89,20 @@ If you want to **unload** the interpreters using REST API,
8989
```
9090
http://[zeppelin-server]:[zeppelin-port]/api/interpreter/unload/[interpreter_group_name]/[interpreter_name]
9191
```
92-
In this time, the Restful method will be <code>**DELETE**</code>.
92+
In this case, the Restful method will be <code>**DELETE**</code>.
9393

9494
<br/>
9595
## What is the next step after Loading ?
96-
97-
Maybe, you are curious several things about how you can actually use the interpreter in Zeppelin.
9896

9997
### Q1. Where is the location of interpreters you downloaded ?
10098

10199
Actually, the answer about this question is in the above picture. Once the REST API is called, the `.jar` files of interpreters you get are saved under `ZEPPELIN_HOME/local-repo` first. Then, they will be copied to `ZEPPELIN_HOME/interpreter` directory. So, please checkout your `ZEPPELIN_HOME/interpreter`.
102100

103101
### Q2. Then, how can I use this interpreter ?
104-
105-
After loading, you can create and configure the interpreter at the Zeppelin **Interpreter tab**. Then, what is the next ? Please follow these simple steps. It will be really straightforward.
106102

107-
Oh, you don't need to restart your Zeppelin server. Because it is **Dynamic Interpreter Loading**, you can configure and load it **at runtime** !
103+
After loading an interpreter, you can use it by creating and configuring it in Zeppelin's **Interpreter tab**.
104+
105+
Oh, you don't need to restart your Zeppelin server. Because it is **Dynamic Loading**, you can configure and load it **at runtime** !
108106

109107
1. After Zeppelin server up, browse Zeppelin home and click **Interpreter tab**.
110108
<center><img src="../assets/themes/zeppelin/img/docs-img/interpreter_setting_1.png" height="85%" width="85%"></center>
@@ -115,7 +113,7 @@ Oh, you don't need to restart your Zeppelin server. Because it is **Dynamic Inte
115113
3. Then, you can verify the interpreter list that you loaded.
116114
<center><img src="../assets/themes/zeppelin/img/docs-img/interpreter_setting_3.png" height="85%" width="85%"></center>
117115

118-
4. After choosing interpreter, you can configure and use it. Don't forget to save it.
116+
4. After choosing an interpreter, you can configure and use it. Don't forget to save it.
119117

120118
5. Create a new notebook in the **Notebook** section, then you can bind the interpreters from your interpreter list. Just drag and drop !
121119
<center><img src="../assets/themes/zeppelin/img/docs-img/interpreter_binding_1.png" height="85%" width="85%"></center>
@@ -124,7 +122,3 @@ Oh, you don't need to restart your Zeppelin server. Because it is **Dynamic Inte
124122
6. At last, you can use your interpreter !
125123

126124
If you want to get the specific information about respective interpreters, please checkout each interpreter documentation.
127-
128-
129-
130-

0 commit comments

Comments
 (0)