Repository: zeppelin Updated Branches: refs/heads/master 032f9a90f -> 6bd4ede7e
[DOC][MINOR] Add shell interpreter docs to _navigation.html ### What is this PR for? After #1087 merged, a new docs `shell.md` was added. But in the docs website, still Shell interpreter link points to `pleasecontribute.html`. So I changed this link, applied TOC and added more descriptions. ### What type of PR is it? Documentation ### Todos * [x] - Change `pleasecontribute.html` -> `shell.html` * [x] - Apply TOC(table of contents) * [x] - Add more description to `shell.md` ### Questions: * Does the licenses files need update? no * Is there breaking changes for older versions? no * Does this needs documentation? no Author: AhyoungRyu <[email protected]> Closes #1138 from AhyoungRyu/improve/shell-docs and squashes the following commits: 69d567d [AhyoungRyu] Address @felixcheung feedback fca76a6 [AhyoungRyu] Apply TOC to rest-credential.md c8e988b [AhyoungRyu] Change docs group manual -> interpreter a0bf1d5 [AhyoungRyu] Add shell.html to _navigation.html Project: http://git-wip-us.apache.org/repos/asf/zeppelin/repo Commit: http://git-wip-us.apache.org/repos/asf/zeppelin/commit/6bd4ede7 Tree: http://git-wip-us.apache.org/repos/asf/zeppelin/tree/6bd4ede7 Diff: http://git-wip-us.apache.org/repos/asf/zeppelin/diff/6bd4ede7 Branch: refs/heads/master Commit: 6bd4ede7e5e51ed43d4355a63ffe707639376009 Parents: 032f9a9 Author: AhyoungRyu <[email protected]> Authored: Thu Jul 7 14:03:59 2016 +0900 Committer: Jongyoul Lee <[email protected]> Committed: Wed Jul 13 00:08:06 2016 +0900 ---------------------------------------------------------------------- docs/_includes/themes/zeppelin/_navigation.html | 2 +- docs/interpreter/alluxio.md | 2 +- docs/interpreter/cassandra.md | 2 +- docs/interpreter/elasticsearch.md | 2 +- docs/interpreter/flink.md | 2 +- docs/interpreter/geode.md | 2 +- docs/interpreter/hbase.md | 2 +- docs/interpreter/hdfs.md | 2 +- docs/interpreter/hive.md | 2 +- docs/interpreter/ignite.md | 2 +- docs/interpreter/jdbc.md | 2 +- docs/interpreter/lens.md | 2 +- docs/interpreter/livy.md | 2 +- docs/interpreter/markdown.md | 2 +- docs/interpreter/postgresql.md | 2 +- docs/interpreter/python.md | 2 +- docs/interpreter/r.md | 2 +- docs/interpreter/scalding.md | 2 +- docs/interpreter/shell.md | 34 ++++++++++++++++---- docs/interpreter/spark.md | 2 +- docs/rest-api/rest-credential.md | 22 +++++++------ 21 files changed, 59 insertions(+), 35 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/zeppelin/blob/6bd4ede7/docs/_includes/themes/zeppelin/_navigation.html ---------------------------------------------------------------------- diff --git a/docs/_includes/themes/zeppelin/_navigation.html b/docs/_includes/themes/zeppelin/_navigation.html index 9feda62..6c09e2b 100644 --- a/docs/_includes/themes/zeppelin/_navigation.html +++ b/docs/_includes/themes/zeppelin/_navigation.html @@ -64,7 +64,7 @@ <li><a href="{{BASE_PATH}}/interpreter/postgresql.html">Postgresql, HAWQ</a></li> <li><a href="{{BASE_PATH}}/interpreter/r.html">R</a></li> <li><a href="{{BASE_PATH}}/interpreter/scalding.html">Scalding</a></li> - <li><a href="{{BASE_PATH}}/pleasecontribute.html">Shell</a></li> + <li><a href="{{BASE_PATH}}/interpreter/shell.html">Shell</a></li> <li><a href="{{BASE_PATH}}/interpreter/spark.html">Spark</a></li> </ul> </li> http://git-wip-us.apache.org/repos/asf/zeppelin/blob/6bd4ede7/docs/interpreter/alluxio.md ---------------------------------------------------------------------- diff --git a/docs/interpreter/alluxio.md b/docs/interpreter/alluxio.md index c8ecf93..c3ad14a 100644 --- a/docs/interpreter/alluxio.md +++ b/docs/interpreter/alluxio.md @@ -2,7 +2,7 @@ layout: page title: "Alluxio Interpreter" description: "Alluxio Interpreter" -group: manual +group: interpreter --- {% include JB/setup %} http://git-wip-us.apache.org/repos/asf/zeppelin/blob/6bd4ede7/docs/interpreter/cassandra.md ---------------------------------------------------------------------- diff --git a/docs/interpreter/cassandra.md b/docs/interpreter/cassandra.md index 33cff19..89b4ea5 100644 --- a/docs/interpreter/cassandra.md +++ b/docs/interpreter/cassandra.md @@ -2,7 +2,7 @@ layout: page title: "Cassandra Interpreter" description: "Cassandra Interpreter" -group: manual +group: interpreter --- {% include JB/setup %} http://git-wip-us.apache.org/repos/asf/zeppelin/blob/6bd4ede7/docs/interpreter/elasticsearch.md ---------------------------------------------------------------------- diff --git a/docs/interpreter/elasticsearch.md b/docs/interpreter/elasticsearch.md index 4721bcd..7c6e2ce 100644 --- a/docs/interpreter/elasticsearch.md +++ b/docs/interpreter/elasticsearch.md @@ -2,7 +2,7 @@ layout: page title: "Elasticsearch Interpreter" description: "" -group: manual +group: interpreter --- {% include JB/setup %} http://git-wip-us.apache.org/repos/asf/zeppelin/blob/6bd4ede7/docs/interpreter/flink.md ---------------------------------------------------------------------- diff --git a/docs/interpreter/flink.md b/docs/interpreter/flink.md index a678480..95ed641 100644 --- a/docs/interpreter/flink.md +++ b/docs/interpreter/flink.md @@ -2,7 +2,7 @@ layout: page title: "Flink Interpreter" description: "" -group: manual +group: interpreter --- {% include JB/setup %} http://git-wip-us.apache.org/repos/asf/zeppelin/blob/6bd4ede7/docs/interpreter/geode.md ---------------------------------------------------------------------- diff --git a/docs/interpreter/geode.md b/docs/interpreter/geode.md index 84a026e..24abf2e 100644 --- a/docs/interpreter/geode.md +++ b/docs/interpreter/geode.md @@ -2,7 +2,7 @@ layout: page title: "Geode OQL Interpreter" description: "" -group: manual +group: interpreter --- {% include JB/setup %} http://git-wip-us.apache.org/repos/asf/zeppelin/blob/6bd4ede7/docs/interpreter/hbase.md ---------------------------------------------------------------------- diff --git a/docs/interpreter/hbase.md b/docs/interpreter/hbase.md index 1aeb77b..4598f2f 100644 --- a/docs/interpreter/hbase.md +++ b/docs/interpreter/hbase.md @@ -2,7 +2,7 @@ layout: page title: "HBase Shell Interpreter" description: "" -group: manual +group: interpreter --- {% include JB/setup %} http://git-wip-us.apache.org/repos/asf/zeppelin/blob/6bd4ede7/docs/interpreter/hdfs.md ---------------------------------------------------------------------- diff --git a/docs/interpreter/hdfs.md b/docs/interpreter/hdfs.md index 7cde31a..7369ba0 100644 --- a/docs/interpreter/hdfs.md +++ b/docs/interpreter/hdfs.md @@ -2,7 +2,7 @@ layout: page title: "HDFS File System Interpreter" description: "" -group: manual +group: interpreter --- {% include JB/setup %} http://git-wip-us.apache.org/repos/asf/zeppelin/blob/6bd4ede7/docs/interpreter/hive.md ---------------------------------------------------------------------- diff --git a/docs/interpreter/hive.md b/docs/interpreter/hive.md index a1fc4e1..037055b 100644 --- a/docs/interpreter/hive.md +++ b/docs/interpreter/hive.md @@ -2,7 +2,7 @@ layout: page title: "Hive Interpreter" description: "" -group: manual +group: interpreter --- {% include JB/setup %} http://git-wip-us.apache.org/repos/asf/zeppelin/blob/6bd4ede7/docs/interpreter/ignite.md ---------------------------------------------------------------------- diff --git a/docs/interpreter/ignite.md b/docs/interpreter/ignite.md index 8a25fd7..d157d31 100644 --- a/docs/interpreter/ignite.md +++ b/docs/interpreter/ignite.md @@ -2,7 +2,7 @@ layout: page title: "Ignite Interpreter" description: "Ignite user guide" -group: manual +group: interpreter --- {% include JB/setup %} http://git-wip-us.apache.org/repos/asf/zeppelin/blob/6bd4ede7/docs/interpreter/jdbc.md ---------------------------------------------------------------------- diff --git a/docs/interpreter/jdbc.md b/docs/interpreter/jdbc.md index 830dd97..4615b14 100644 --- a/docs/interpreter/jdbc.md +++ b/docs/interpreter/jdbc.md @@ -2,7 +2,7 @@ layout: page title: "Generic JDBC Interpreter" description: "JDBC user guide" -group: manual +group: interpreter --- {% include JB/setup %} http://git-wip-us.apache.org/repos/asf/zeppelin/blob/6bd4ede7/docs/interpreter/lens.md ---------------------------------------------------------------------- diff --git a/docs/interpreter/lens.md b/docs/interpreter/lens.md index b4bcda4..20b2c0c 100644 --- a/docs/interpreter/lens.md +++ b/docs/interpreter/lens.md @@ -2,7 +2,7 @@ layout: page title: "Lens Interpreter" description: "Lens user guide" -group: manual +group: interpreter --- {% include JB/setup %} http://git-wip-us.apache.org/repos/asf/zeppelin/blob/6bd4ede7/docs/interpreter/livy.md ---------------------------------------------------------------------- diff --git a/docs/interpreter/livy.md b/docs/interpreter/livy.md index ef7c8ce..2f47364 100644 --- a/docs/interpreter/livy.md +++ b/docs/interpreter/livy.md @@ -2,7 +2,7 @@ layout: page title: "Livy Interpreter" description: "" -group: manual +group: interpreter --- {% include JB/setup %} http://git-wip-us.apache.org/repos/asf/zeppelin/blob/6bd4ede7/docs/interpreter/markdown.md ---------------------------------------------------------------------- diff --git a/docs/interpreter/markdown.md b/docs/interpreter/markdown.md index 21184dc..42ab86b 100644 --- a/docs/interpreter/markdown.md +++ b/docs/interpreter/markdown.md @@ -2,7 +2,7 @@ layout: page title: "Markdown Interpreter" description: "Markdown Interpreter" -group: manual +group: interpreter --- {% include JB/setup %} http://git-wip-us.apache.org/repos/asf/zeppelin/blob/6bd4ede7/docs/interpreter/postgresql.md ---------------------------------------------------------------------- diff --git a/docs/interpreter/postgresql.md b/docs/interpreter/postgresql.md index 107fda1..a83731b 100644 --- a/docs/interpreter/postgresql.md +++ b/docs/interpreter/postgresql.md @@ -2,7 +2,7 @@ layout: page title: "PostgreSQL and HAWQ Interpreter" description: "" -group: manual +group: interpreter --- {% include JB/setup %} http://git-wip-us.apache.org/repos/asf/zeppelin/blob/6bd4ede7/docs/interpreter/python.md ---------------------------------------------------------------------- diff --git a/docs/interpreter/python.md b/docs/interpreter/python.md index c2a38f5..cb9fded 100644 --- a/docs/interpreter/python.md +++ b/docs/interpreter/python.md @@ -2,7 +2,7 @@ layout: page title: "Python Interpreter" description: "Python Interpreter" -group: manual +group: interpreter --- {% include JB/setup %} http://git-wip-us.apache.org/repos/asf/zeppelin/blob/6bd4ede7/docs/interpreter/r.md ---------------------------------------------------------------------- diff --git a/docs/interpreter/r.md b/docs/interpreter/r.md index dce8bd1..bc94fff 100644 --- a/docs/interpreter/r.md +++ b/docs/interpreter/r.md @@ -2,7 +2,7 @@ layout: page title: "R Interpreter" description: "" -group: manual +group: interpreter --- {% include JB/setup %} http://git-wip-us.apache.org/repos/asf/zeppelin/blob/6bd4ede7/docs/interpreter/scalding.md ---------------------------------------------------------------------- diff --git a/docs/interpreter/scalding.md b/docs/interpreter/scalding.md index e8774df..d2e86e7 100644 --- a/docs/interpreter/scalding.md +++ b/docs/interpreter/scalding.md @@ -2,7 +2,7 @@ layout: page title: "Scalding Interpreter" description: "" -group: manual +group: interpreter --- {% include JB/setup %} http://git-wip-us.apache.org/repos/asf/zeppelin/blob/6bd4ede7/docs/interpreter/shell.md ---------------------------------------------------------------------- diff --git a/docs/interpreter/shell.md b/docs/interpreter/shell.md index 11e73b7..f86e830 100644 --- a/docs/interpreter/shell.md +++ b/docs/interpreter/shell.md @@ -2,19 +2,39 @@ layout: page title: "Shell Interpreter" description: "Shell Interpreter" -group: manual +group: interpreter --- {% include JB/setup %} -## Shell interpreter for Apache Zeppelin +# Shell interpreter for Apache Zeppelin -### Overview -Shell interpreter uses [Apache Commons Exec](https://commons.apache.org/proper/commons-exec) to execute external processes. +<div id="toc"></div> +## Overview +Shell interpreter uses [Apache Commons Exec](https://commons.apache.org/proper/commons-exec) to execute external processes. In Zeppelin notebook, you can use ` %sh ` in the beginning of a paragraph to invoke system shell and run commands. -Note: Currently each command runs as Zeppelin user. -### Example +> **Note :** Currently each command runs as the user Zeppelin server is running as. + +## Configuration +At the "Interpreters" menu in Zeppelin dropdown menu, you can set the property value for Shell interpreter. + +<table class="table-configuration"> + <tr> + <th>Name</th> + <th>Value</th> + <th>Description</th> + </tr> + <tr> + <td>shell.command.timeout.millisecs</td> + <td>60000</td> + <td>Shell command time out in millisecs</td> + </tr> +</table> + +## Example The following example demonstrates the basic usage of Shell in a Zeppelin notebook. -<img src="{{BASE_PATH}}/assets/themes/zeppelin/img/docs-img/shell-example.png" width="70%" /> +<img src="{{BASE_PATH}}/assets/themes/zeppelin/img/docs-img/shell-example.png" /> + +If you need further information about **Zeppelin Interpreter Setting** for using Shell interpreter, please read [What is interpreter setting?](../manual/interpreters.html#what-is-interpreter-setting) section first. \ No newline at end of file http://git-wip-us.apache.org/repos/asf/zeppelin/blob/6bd4ede7/docs/interpreter/spark.md ---------------------------------------------------------------------- diff --git a/docs/interpreter/spark.md b/docs/interpreter/spark.md index a183033..81f4844 100644 --- a/docs/interpreter/spark.md +++ b/docs/interpreter/spark.md @@ -2,7 +2,7 @@ layout: page title: "Spark Interpreter Group" description: "" -group: manual +group: interpreter --- {% include JB/setup %} http://git-wip-us.apache.org/repos/asf/zeppelin/blob/6bd4ede7/docs/rest-api/rest-credential.md ---------------------------------------------------------------------- diff --git a/docs/rest-api/rest-credential.md b/docs/rest-api/rest-credential.md index a01f335..0191674 100644 --- a/docs/rest-api/rest-credential.md +++ b/docs/rest-api/rest-credential.md @@ -19,14 +19,18 @@ limitations under the License. --> {% include JB/setup %} -## Zeppelin REST API - Zeppelin provides several REST APIs for interaction and remote activation of zeppelin functionality. +# Apache Zeppelin Credential REST API - All REST APIs are available starting with the following endpoint `http://[zeppelin-server]:[zeppelin-port]/api`. Note that zeppelin REST APIs receive or return JSON objects, it is recommended for you to install some JSON viewers such as [JSONView](https://chrome.google.com/webstore/detail/jsonview/chklaanhfefbnpoihckbnefhakgolnmc). +<div id="toc"></div> - If you work with Zeppelin and find a need for an additional REST API, please [file an issue or send us mail](http://zeppelin.apache.org/community.html). +## Overview +Apache Zeppelin provides several REST APIs for interaction and remote activation of zeppelin functionality. +All REST APIs are available starting with the following endpoint `http://[zeppelin-server]:[zeppelin-port]/api`. +Note that Apache Zeppelin REST APIs receive or return JSON objects, it is recommended for you to install some JSON viewers such as [JSONView](https://chrome.google.com/webstore/detail/jsonview/chklaanhfefbnpoihckbnefhakgolnmc). - <br /> +If you work with Apache Zeppelin and find a need for an additional REST API, please [file an issue or send us an email](http://zeppelin.apache.org/community.html). + +<br /> ## Credential REST API List ### List Credential information @@ -34,7 +38,7 @@ limitations under the License. <col width="200"> <tr> <td>Description</td> - <td>This ```GET``` method returns all key/value pairs of credential information on the server.</td> + <td>This ```GET``` method returns all key/value pairs of the credential information on the server.</td> </tr> <tr> <td>URL</td> @@ -78,7 +82,7 @@ limitations under the License. <col width="200"> <tr> <td>Description</td> - <td>This ```PUT``` method creates an credential information with new properties.</td> + <td>This ```PUT``` method creates the credential information with new properties.</td> </tr> <tr> <td>URL</td> @@ -124,7 +128,7 @@ limitations under the License. <col width="200"> <tr> <td>Description</td> - <td>This ```DELETE``` method deletes credential information.</td> + <td>This ```DELETE``` method deletes the credential information.</td> </tr> <tr> <td>URL</td> @@ -154,7 +158,7 @@ limitations under the License. <col width="200"> <tr> <td>Description</td> - <td>This ```DELETE``` method deletes an given credential entity.</td> + <td>This ```DELETE``` method deletes a given credential entity.</td> </tr> <tr> <td>URL</td>
