Repository: incubator-zeppelin Updated Branches: refs/heads/master a959cbc53 -> 025acd364
Fix dead link and add table tab to Zeppelin Configuration section: docs/install/install.md ### What is this PR for? As mentioned at [ZEPPELIN-638](https://issues.apache.org/jira/browse/ZEPPELIN-638), there is a dead link in `docs/install/install.md`. So I fixed it. Plus, I also add a table tab to **Zeppelin Configuration** section because current one is not good to look. ### What type of PR is it? Improvement | Documentation ### Todos * [x] - Fix dead link * [x] - Add table tab to Zeppelin Configuration section ### Is there a relevant Jira issue? [ZEPPELIN-638](https://issues.apache.org/jira/browse/ZEPPELIN-638) (only for fixing dead link) ### How should this be tested? After applying this PR, you can check this page `Quick Start` -> `Install` at Zeppelin documentation. ### Screenshots (if appropriate) * Before  * After  ### Questions: * Does the licenses files need update? No * Is there breaking changes for older versions? No * Does this needs documentation? No Author: Ryu Ah young <[email protected]> Closes #679 from AhyoungRyu/ZEPPELIN-638 and squashes the following commits: ec469e7 [Ryu Ah young] ZEPPELIN-638: Modify 'environment variable' -> 'environment variables' 686559f [Ryu Ah young] ZEPPELIN-638: Fix some sentences 39da527 [Ryu Ah young] ZEPPELIN-638: Fix hyperlink a4e6816 [Ryu Ah young] ZEPPELIN-638: Fix some sentences for a clarifying explanation b76d1a5 [Ryu Ah young] ZEPPELIN-638: Resolve confliction 8ea5a99 [Ryu Ah young] ZEPPELIN-638: Change the configuration table ace7f1e [Ryu Ah young] Fix a dead link and add a table tab to Zeppelin Configuration section 17ea00e [Ryu Ah young] Fix dead link and add table tab to Zeppelin Configuration section Project: http://git-wip-us.apache.org/repos/asf/incubator-zeppelin/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-zeppelin/commit/025acd36 Tree: http://git-wip-us.apache.org/repos/asf/incubator-zeppelin/tree/025acd36 Diff: http://git-wip-us.apache.org/repos/asf/incubator-zeppelin/diff/025acd36 Branch: refs/heads/master Commit: 025acd3641cab7c3f848a98f91f8b3f1d31cfcf7 Parents: a959cbc Author: Ryu Ah young <[email protected]> Authored: Thu Feb 4 10:38:47 2016 +0900 Committer: Damien CORNEAU <[email protected]> Committed: Thu Feb 4 09:47:30 2016 -0800 ---------------------------------------------------------------------- docs/install/install.md | 53 +++++++++++++++++++++----------------------- 1 file changed, 25 insertions(+), 28 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-zeppelin/blob/025acd36/docs/install/install.md ---------------------------------------------------------------------- diff --git a/docs/install/install.md b/docs/install/install.md index 493a96d..8afc244 100644 --- a/docs/install/install.md +++ b/docs/install/install.md @@ -1,6 +1,6 @@ --- layout: page -title: "Install Zeppelin" +title: "Zeppelin Installation" description: "" group: install --- @@ -21,21 +21,23 @@ limitations under the License. -## From binary package +## Zeppelin Installation +Welcome to your first trial to explore Zeppelin ! - Download latest binary package from [Download](../download.html). +In this documentation, we will explain how you can install Zeppelin from **Binary Package** or build from **Source** by yourself. Plus, you can see all of Zeppelin's configurations in the **Zeppelin Configuration** section below. +### Install with Binary Package -## Build from source +If you want to install Zeppelin with latest binary package, please visit [this page](http://zeppelin.incubator.apache.org/download.html). - Check instructions in [README](https://github.com/apache/incubator-zeppelin/blob/master/README.md) to build from source. +### Build from Zeppelin Source +You can also build Zeppelin from the source. Please check instructions in `README.md` in [Zeppelin github](https://github.com/apache/incubator-zeppelin/blob/master/README.md). -## Configure - -Configuration can be done by both environment variable(conf/zeppelin-env.sh) and java properties(conf/zeppelin-site.xml). If both defined, environment vaiable is used. +## Zeppelin Configuration +You can configure Zeppelin with both **environment variables** in `conf/zeppelin-env.sh` and **java properties** in `conf/zeppelin-site.xml`. If both are defined, then the **environment variables** will be used priorly. <table class="table-configuration"> <tr> @@ -48,7 +50,7 @@ Configuration can be done by both environment variable(conf/zeppelin-env.sh) and <td>ZEPPELIN_PORT</td> <td>zeppelin.server.port</td> <td>8080</td> - <td>Zeppelin server port.</td> + <td>Zeppelin server port</td> </tr> <tr> <td>ZEPPELIN_MEM</td> @@ -66,19 +68,19 @@ Configuration can be done by both environment variable(conf/zeppelin-env.sh) and <td>ZEPPELIN_JAVA_OPTS</td> <td>N/A</td> <td></td> - <td>JVM Options</td> + <td>JVM options</td> </tr> <tr> <td>ZEPPELIN_ALLOWED_ORIGINS</td> <td>zeppelin.server.allowed.origins</td> <td>*</td> - <td>Allows a way to specify a ',' separated list of allowed origins for rest and websockets. i.e. http://localhost:8080</td> + <td>Enables a way to specify a ',' separated list of allowed origins for rest and websockets. <br /> i.e. http://localhost:8080 </td> </tr> <tr> <td>ZEPPELIN_SERVER_CONTEXT_PATH</td> <td>zeppelin.server.context.path</td> <td>/</td> - <td>Context Path of the Web Application</td> + <td>A context path of the web application</td> </tr> <tr> <td>ZEPPELIN_SSL</td> @@ -138,37 +140,37 @@ Configuration can be done by both environment variable(conf/zeppelin-env.sh) and <td>ZEPPELIN_NOTEBOOK_HOMESCREEN</td> <td>zeppelin.notebook.homescreen</td> <td></td> - <td>Id of notebook to be displayed in homescreen ex) 2A94M5J1Z</td> + <td>A notebook id displayed in Zeppelin homescreen <br />i.e. 2A94M5J1Z</td> </tr> <tr> <td>ZEPPELIN_NOTEBOOK_HOMESCREEN_HIDE</td> <td>zeppelin.notebook.homescreen.hide</td> <td>false</td> - <td>hide homescreen notebook from list when this value set to "true"</td> + <td>This value can be "true" when to hide the notebook id set by <code>ZEPPELIN_NOTEBOOK_HOMESCREEN</code> on the Zeppelin homescreen. <br />For the further information, please read <a href="../manual/notebookashomepage.html">Customize your Zeppelin homepage</a>.</td> </tr> <tr> <td>ZEPPELIN_WAR_TEMPDIR</td> <td>zeppelin.war.tempdir</td> <td>webapps</td> - <td>The location of jetty temporary directory.</td> + <td>A location of jetty temporary directory</td> </tr> <tr> <td>ZEPPELIN_NOTEBOOK_DIR</td> <td>zeppelin.notebook.dir</td> <td>notebook</td> - <td>Where notebook file is saved</td> + <td>The root directory where Zeppelin notebook directories are saved</td> </tr> <tr> <td>ZEPPELIN_NOTEBOOK_S3_BUCKET</td> <td>zeppelin.notebook.s3.bucket</td> <td>zeppelin</td> - <td>Bucket where notebook saved</td> + <td>S3 Bucket where Zeppelin notebook files will be saved</td> </tr> <tr> <td>ZEPPELIN_NOTEBOOK_S3_USER</td> <td>zeppelin.notebook.s3.user</td> <td>user</td> - <td>User in bucket where notebook saved. For example bucket/user/notebook/2A94M5J1Z/note.json</td> + <td>A user name of S3 bucket<br />i.e. <code>bucket/user/notebook/2A94M5J1Z/note.json</code></td> </tr> <tr> <td>ZEPPELIN_NOTEBOOK_STORAGE</td> @@ -183,7 +185,7 @@ Configuration can be done by both environment variable(conf/zeppelin-env.sh) and <td>org.apache.zeppelin.spark.SparkInterpreter,<br />org.apache.zeppelin.spark.PySparkInterpreter,<br />org.apache.zeppelin.spark.SparkSqlInterpreter,<br />org.apache.zeppelin.spark.DepInterpreter,<br />org.apache.zeppelin.markdown.Markdown,<br />org.apache.zeppelin.shell.ShellInterpreter,<br />org.apache.zeppelin.hive.HiveInterpreter<br /> ... </td> - <td>Comma separated interpreter configurations [Class]. First interpreter become a default</td> + <td>Comma separated interpreter configurations [Class] <br /> The first interpreter will be a default value. <br /> It means only the first interpreter in this list can be available without <code>%interpreter_name</code> annotation in Zeppelin notebook paragraph. </td> </tr> <tr> <td>ZEPPELIN_INTERPRETER_DIR</td> @@ -193,24 +195,19 @@ Configuration can be done by both environment variable(conf/zeppelin-env.sh) and </tr> </table> -<br /> -You'll also need to configure individual interpreter. Information can be found in 'Interpreter' section in this documentation. - -For example [Spark](../interpreter/spark.html). +Maybe you need to configure individual interpreter. If so, please check **Interpreter** section in Zeppelin documentation. +[Spark Interpreter for Apache Zeppelin](../interpreter/spark.html) will be a good example. -<br /> -## Start/Stop +## Zeppelin Start / Stop #### Start Zeppelin ``` bin/zeppelin-daemon.sh start ``` -After successful start, visit http://localhost:8080 with your web browser. +After successful start, visit [http://localhost:8080](http://localhost:8080) with your web browser. #### Stop Zeppelin ``` bin/zeppelin-daemon.sh stop ``` - -
