Author: moon
Date: Sun Mar 15 03:56:33 2015
New Revision: 1666776
URL: http://svn.apache.org/r1666776
Log:
Update how to contribute, writing zeppelin interpreter docs due to API and
internal architecture changes
Added:
incubator/zeppelin/site/assets/themes/zeppelin/img/interpreter.png (with
props)
Modified:
incubator/zeppelin/site/atom.xml
incubator/zeppelin/site/docs/development/howtocontribute.html
incubator/zeppelin/site/docs/development/writingzeppelininterpreter.html
incubator/zeppelin/site/rss.xml
Added: incubator/zeppelin/site/assets/themes/zeppelin/img/interpreter.png
URL:
http://svn.apache.org/viewvc/incubator/zeppelin/site/assets/themes/zeppelin/img/interpreter.png?rev=1666776&view=auto
==============================================================================
Binary file - no diff available.
Propchange: incubator/zeppelin/site/assets/themes/zeppelin/img/interpreter.png
------------------------------------------------------------------------------
svn:mime-type = image/png
Modified: incubator/zeppelin/site/atom.xml
URL:
http://svn.apache.org/viewvc/incubator/zeppelin/site/atom.xml?rev=1666776&r1=1666775&r2=1666776&view=diff
==============================================================================
--- incubator/zeppelin/site/atom.xml (original)
+++ incubator/zeppelin/site/atom.xml Sun Mar 15 03:56:33 2015
@@ -4,7 +4,7 @@
<title>Zeppelin</title>
<link href="http://zeppelin-project.org/"; rel="self"/>
<link href="http://zeppelin-project.org"/>
- <updated>2015-02-09T11:30:34+09:00</updated>
+ <updated>2015-03-15T12:42:50+09:00</updated>
<id>http://zeppelin-project.org</id>
<author>
<name>The Apache Software Foundation</name>
Modified: incubator/zeppelin/site/docs/development/howtocontribute.html
URL:
http://svn.apache.org/viewvc/incubator/zeppelin/site/docs/development/howtocontribute.html?rev=1666776&r1=1666775&r2=1666776&view=diff
==============================================================================
--- incubator/zeppelin/site/docs/development/howtocontribute.html (original)
+++ incubator/zeppelin/site/docs/development/howtocontribute.html Sun Mar 15
03:56:33 2015
@@ -286,6 +286,13 @@ HADOOP_HOME=YOUR_HADOOP_HOME JAVA_HOME=Y
</code></pre></div>
<p>Server will be run on http://localhost:8080</p>
+<h3>Generating Thrift Code</h3>
+
+<p>Some portions of the Zeppelin code are generated by <a
href="http://thrift.apache.org";>Thrift</a>. For most Zeppelin changes, you
don't need to worry about this, but if you modify any of the Thrift IDL
files (e.g. zeppelin-interpreter/src/main/thrift/*.thrift), then you also need
to regenerate these files and submit their updated version as part of your
patch.</p>
+
+<p>To regenerate the code, install thrift-0.9.0 and change directory into
Zeppelin source directory. and then run following command</p>
+<div class="highlight"><pre><code class="text language-text"
data-lang="text">thrift -out zeppelin-interpreter/src/main/java/ --gen java
zeppelin-interpreter/src/main/thrift/RemoteInterpreterService.thrift
+</code></pre></div>
<h3>JIRA</h3>
<p>Zeppelin manages it's issues in Jira. <a
href="https://issues.apache.org/jira/browse/ZEPPELIN";>https://issues.apache.org/jira/browse/ZEPPELIN</a></p>
Modified:
incubator/zeppelin/site/docs/development/writingzeppelininterpreter.html
URL:
http://svn.apache.org/viewvc/incubator/zeppelin/site/docs/development/writingzeppelininterpreter.html?rev=1666776&r1=1666775&r2=1666776&view=diff
==============================================================================
--- incubator/zeppelin/site/docs/development/writingzeppelininterpreter.html
(original)
+++ incubator/zeppelin/site/docs/development/writingzeppelininterpreter.html
Sun Mar 15 03:56:33 2015
@@ -231,13 +231,19 @@
<div class="col-md-12">
<h3>What is Zeppelin Interpreter</h3>
-<p>Zeppelin Interpreter is language backend. For example to use scala code in
Zeppelin, you need scala interpreter.</p>
+<p>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. </p>
+
+<p><img class="img-responsive" style="width:50%; border: 1px solid #ecf0f1;"
height="auto" src="../../assets/themes/zeppelin/img/interpreter.png" /></p>
+
+<p>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.</p>
<h3>Make your own Interpreter</h3>
-<p>Creating a new interpreter is quite simple. Just implementing <a
href="https://github.com/NFLabs/zeppelin/blob/master/zeppelin-zengine/src/main/java/com/nflabs/zeppelin/interpreter/Interpreter.java";>com.nflabs.zeppelin.interpreter</a>
interface.</p>
+<p>Creating a new interpreter is quite simple. Just extends <a
href="https://github.com/NFLabs/zeppelin/blob/master/zeppelin-interpreter/src/main/java/com/nflabs/zeppelin/interpreter/Interpreter.java";>com.nflabs.zeppelin.interpreter</a>
abstract class and implement some methods.</p>
-<p>You can include com.nflabs.zeppelin:zeppelin-zengine:[VERSION] artifact in
your build system.</p>
+<p>You can include com.nflabs.zeppelin:zeppelin-interpreter:[VERSION] artifact
in your build system.</p>
<h3>Install your interpreter binary</h3>
Modified: incubator/zeppelin/site/rss.xml
URL:
http://svn.apache.org/viewvc/incubator/zeppelin/site/rss.xml?rev=1666776&r1=1666775&r2=1666776&view=diff
==============================================================================
--- incubator/zeppelin/site/rss.xml (original)
+++ incubator/zeppelin/site/rss.xml Sun Mar 15 03:56:33 2015
@@ -5,8 +5,8 @@
<description>Zeppelin - The Apache Software Foundation</description>
<link>http://zeppelin-project.org</link>
<link>http://zeppelin-project.org</link>
- <lastBuildDate>2015-02-09T11:30:34+09:00</lastBuildDate>
- <pubDate>2015-02-09T11:30:34+09:00</pubDate>
+ <lastBuildDate>2015-03-15T12:42:50+09:00</lastBuildDate>
+ <pubDate>2015-03-15T12:42:50+09:00</pubDate>
<ttl>1800</ttl>
