Repository: incubator-zeppelin Updated Branches: refs/heads/gh-pages f51a9d1f4 -> e7bcfb955
Minor editing in documentation pages Here're some minor editorial fixes of text in documentation pages of Zeppelin. Author: Khalid Huseynov <[email protected]> This patch had conflicts when merged, resolved by Committer: Lee moon soo <[email protected]> Closes #43 from khalidhuseynov/gh-pages and squashes the following commits: 15a72fc [Khalid Huseynov] minor fixes to docs/development/howtocontribute 62ee47c [Khalid Huseynov] minor fixes to docs/development/writingzeppelininterpreter c691558 [Khalid Huseynov] minor fixes to docs/display 59e4f8d [Khalid Huseynov] minor fixes to docs/dynamicform 8f0ba72 [Khalid Huseynov] minor fixes to docs/interpreter/spark Project: http://git-wip-us.apache.org/repos/asf/incubator-zeppelin/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-zeppelin/commit/e7bcfb95 Tree: http://git-wip-us.apache.org/repos/asf/incubator-zeppelin/tree/e7bcfb95 Diff: http://git-wip-us.apache.org/repos/asf/incubator-zeppelin/diff/e7bcfb95 Branch: refs/heads/gh-pages Commit: e7bcfb955dcf21872f0e10f8d439022ca937b2fe Parents: f51a9d1 Author: Khalid Huseynov <[email protected]> Authored: Mon Apr 20 11:27:58 2015 +0900 Committer: Lee moon soo <[email protected]> Committed: Sat Apr 25 08:40:20 2015 +0900 ---------------------------------------------------------------------- docs/development/howtocontribute.md | 4 ++-- docs/development/writingzeppelininterpreter.md | 10 +++++----- docs/display.md | 12 ++++++------ docs/dynamicform.md | 10 +++++----- docs/interpreter/spark.md | 10 +++++----- 5 files changed, 23 insertions(+), 23 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-zeppelin/blob/e7bcfb95/docs/development/howtocontribute.md ---------------------------------------------------------------------- diff --git a/docs/development/howtocontribute.md b/docs/development/howtocontribute.md index 647a3b6..db026dc 100644 --- a/docs/development/howtocontribute.md +++ b/docs/development/howtocontribute.md @@ -13,7 +13,7 @@ Any contribution to Zeppelin (Source code, Documents, Image, Website) means you ### Setting up -Here are some things you will need to build and test Zeppelin. +Here are some things you will need to do to build and test Zeppelin. #### Software Configuration Management(SCM) @@ -49,7 +49,7 @@ git clone -b branch-0.1 https://github.com/apache/incubator-zeppelin.git zeppeli #### Fork repository -If you want not only build Zeppelin but also make change, then you need fork Zeppelin repository and make pull request. +If you want not only build Zeppelin but also make changes, then you need to fork Zeppelin repository and make pull request. ###Build http://git-wip-us.apache.org/repos/asf/incubator-zeppelin/blob/e7bcfb95/docs/development/writingzeppelininterpreter.md ---------------------------------------------------------------------- diff --git a/docs/development/writingzeppelininterpreter.md b/docs/development/writingzeppelininterpreter.md index ed969c6..266cecb 100644 --- a/docs/development/writingzeppelininterpreter.md +++ b/docs/development/writingzeppelininterpreter.md @@ -8,17 +8,17 @@ group: development ### What is Zeppelin Interpreter -Zeppelin Interpreter is language backend. For example to use scala code in Zeppelin, you need scala interpreter. -Every Interpreter's are belongs to InterpreterGroup. InterpreterGroup is unit of start/stop interpreter. -Interpreters in the same InterpreterGroup can reference each other. For example, SparkSqlInterpreter can refernece SparkInterpreter to get SparkContext from it while they're in the same group. +Zeppelin Interpreter is a language backend. For example to use scala code in Zeppelin, you need scala interpreter. +Every Interpreter belongs to an InterpreterGroup. InterpreterGroup is a unit of start/stop interpreter. +Interpreters in the same InterpreterGroup can reference each other. For example, SparkSqlInterpreter can reference SparkInterpreter to get SparkContext from it while they're in the same group. <img class="img-responsive" style="width:50%; border: 1px solid #ecf0f1;" height="auto" src="../../assets/themes/zeppelin/img/interpreter.png" /> -Interpreter can be launched either using separate classloader or separate JVM process. Sometimes separate classloader cause problem especially when your interpreter uses reflections or trying to grab standard out/err. In this case, separate JVM process is the option you can select. (by checking 'fork' in Interpreter menu, which is default value) When Interpreter is running in separate JVM process, it's communicating with Zeppelin via thrift. +Interpreter can be launched either using separate classloader or separate JVM process. Sometimes separate classloader causes problem especially when your interpreter uses reflections or trying to grab standard out/err. In this case, separate JVM process is the option you can select. (by checking 'fork' in Interpreter menu, which is default value) When Interpreter is running in separate JVM process, it's communicating with Zeppelin via thrift. ### Make your own Interpreter -Creating a new interpreter is quite simple. Just extends [org.apache.zeppelin.interpreter](https://github.com/apache/incubator-zeppelin/blob/master/zeppelin-interpreter/src/main/java/org/apache/zeppelin/interpreter/Interpreter.java) abstract class and implement some methods. +Creating a new interpreter is quite simple. Just extend [org.apache.zeppelin.interpreter](https://github.com/apache/incubator-zeppelin/blob/master/zeppelin-interpreter/src/main/java/org/apache/zeppelin/interpreter/Interpreter.java) abstract class and implement some methods. You can include org.apache.zeppelin:zeppelin-interpreter:[VERSION] artifact in your build system. http://git-wip-us.apache.org/repos/asf/incubator-zeppelin/blob/e7bcfb95/docs/display.md ---------------------------------------------------------------------- diff --git a/docs/display.md b/docs/display.md index 4f9a7dc..816443d 100644 --- a/docs/display.md +++ b/docs/display.md @@ -9,8 +9,8 @@ group: manual ### Display -Zeppelin prints output of langauge backend in text, default. -However, if output contains some magic keyword, Zeppelin automatically formatting the output as Table, Chart, Image, Html. +Zeppelin prints output of language backend in text, by default. +However, if output contains some magic keyword, Zeppelin automatically formatting the output as Table, Chart, Image, or Html. <br /> #### Display as Text @@ -22,20 +22,20 @@ If output has no magic keyword provided Zeppelin print the output in text. <br /> #### Display as Html -If ouput starts with %html, it interpreted as a html code. +If output starts with %html, it is interpreted as an html code. <img src="../assets/themes/zeppelin/img/screenshots/display_html.png" /> <br /> #### Display as Table, Chart -If ouput starts with %table, it interpreted as a table. Table can be seen as chart. +If output starts with %table, it is interpreted as a table. Table can be seen as chart. Output's format should be, row separated by '\n' (newline) and column separated by '\t' (tab). First row is header. <img src="../assets/themes/zeppelin/img/screenshots/display_table.png" /> -If table contents start with %html, it is interpreted as a HTML. +If table contents start with %html, it is interpreted as an HTML. <img src="../assets/themes/zeppelin/img/screenshots/display_table_html.png" /> @@ -44,4 +44,4 @@ If table contents start with %html, it is interpreted as a HTML. If output starts with %img, it is interpreted as base64 encoded image. -<img src="../assets/themes/zeppelin/img/screenshots/display_image.png" /> \ No newline at end of file +<img src="../assets/themes/zeppelin/img/screenshots/display_image.png" /> http://git-wip-us.apache.org/repos/asf/incubator-zeppelin/blob/e7bcfb95/docs/dynamicform.md ---------------------------------------------------------------------- diff --git a/docs/dynamicform.md b/docs/dynamicform.md index adbc563..36d1a0c 100644 --- a/docs/dynamicform.md +++ b/docs/dynamicform.md @@ -9,8 +9,8 @@ group: manual ## Dynamic Form -Zeppelin dynamically creates input forms. Depend on language backend, there're two different way to create dynamic form. -Custom lanaugage backend can select which type of form creation he want to use. +Zeppelin dynamically creates input forms. Depending on language backend, there're two different ways to create dynamic form. +Custom language backend can select which type of form creation it wants to use. <br /> ### Using form Templates @@ -46,9 +46,9 @@ Also you can separate option's display name and value, using _${formName=default <img src="../assets/themes/zeppelin/img/screenshots/form_select_displayname.png" /> <br /> -### Creates Programatically +### Creates Programmatically -Some language backend use programtic way to create form. for example [ZeppelinContext](./interpreter/spark.html#zeppelincontext) provides form creation API +Some language backend uses programmatic way to create form. For example [ZeppelinContext](./interpreter/spark.html#zeppelincontext) provides form creation API Here're some examples. @@ -62,4 +62,4 @@ Text input form with default value Select form -<img src="../assets/themes/zeppelin/img/screenshots/form_select_prog.png" /> \ No newline at end of file +<img src="../assets/themes/zeppelin/img/screenshots/form_select_prog.png" /> http://git-wip-us.apache.org/repos/asf/incubator-zeppelin/blob/e7bcfb95/docs/interpreter/spark.md ---------------------------------------------------------------------- diff --git a/docs/interpreter/spark.md b/docs/interpreter/spark.md index 3bab5cc..452cd3a 100644 --- a/docs/interpreter/spark.md +++ b/docs/interpreter/spark.md @@ -36,7 +36,7 @@ Spark Interpreter group, which consisted of 4 interpreters. <tr> <td>%dep</td> <td>DepInterpreter</td> - <td>Depdency loader</td> + <td>Dependency loader</td> </tr> </table> @@ -46,7 +46,7 @@ Spark Interpreter group, which consisted of 4 interpreters. ### SparkContext, SQLContext, ZeppelinContext -SparkContext, SQLContext, ZeppelinContext are automatically created and exposed as variable name 'sc', 'sqlContext' and 'z' respectively, Both scala and python environment. +SparkContext, SQLContext, ZeppelinContext are automatically created and exposed as variable names 'sc', 'sqlContext' and 'z', respectively, both in scala and python environments. Note that scala / python environment shares the same SparkContext, SQLContext, ZeppelinContext instance. @@ -107,7 +107,7 @@ Note that %dep interpreter should be used before %spark, %pyspark, %sql. ### ZeppelinContext -Zeppelin automatically inject ZeppelinContext as variable 'z' in your scala/python environment. ZeppelinContext provides some addtional functions and utility. +Zeppelin automatically injects ZeppelinContext as variable 'z' in your scala/python environment. ZeppelinContext provides some addtional functions and utility. <br /> #### Object exchange @@ -134,7 +134,7 @@ myObject = z.get("objName") #### Form creation ZeppelinContext provides functions for creating forms. -In scala and python environment, you can create forms programtically. +In scala and python environments, you can create forms programmatically. ```scala %spark @@ -160,4 +160,4 @@ In sql environment, you can create form in simple template. select * from ${table=defualtTableName} where text like '%${search}%' ``` -To learn more about dynamic form, checkout [Dynamic Form](../dynamicform.html). \ No newline at end of file +To learn more about dynamic form, checkout [Dynamic Form](../dynamicform.html).
