Merge pull request apache#115 from NFLabs/gh-pages-notebook

Update homepage for next release

_includes/themes/zeppelin/_navigation.html

@@ -7,7 +7,7 @@
             <span class="icon-bar"></span>
             <span class="icon-bar"></span>
           </button>
-          <a class="navbar-brand" href="{{ HOME_PATH }}">{{ site.title }}</a>
+          <a class="navbar-brand" href="/"><img style="margin-top: -7px;s" src="/assets/themes/zeppelin/img/zeppelin_logo.png" width="50" alt="I'm zeppelin"> Zeppelin</a>
         </div>
         <nav class="navbar-collapse collapse" role="navigation">
           <ul class="nav navbar-nav">

_includes/themes/zeppelin/default.html

@@ -35,8 +35,6 @@
 
     {% include themes/zeppelin/_navigation.html %}
 
-    {% include themes/zeppelin/_jumbotron.html param="value" %}
-
     <div class="container">
       {{ content }}
       <hr>

assets/themes/zeppelin/css/style.css

@@ -8,8 +8,15 @@ body {
     background-color: #3071a9;
 }
 
+.navbar {
+ background-color:#3071a9;
+ border-bottom:0px;
+ height: 50px;
+}
+
 .navbar-inverse .navbar-nav > li > a {
  color: #ffffff;
+ background-color:#3071a9;
 }
 
 .navbar-inverse .navbar-nav > li > a:hover, 
@@ -19,11 +26,24 @@ body {
 .navbar-inverse .navbar-nav > li > a.active:hover, 
 .navbar-inverse .navbar-nav > li > a.active:focus {
   text-decoration: none;
+  background-color:#123456;
 }
+
+.navbar-inverse .navbar-nav > li > a.active {
+  background-color:#123456;
+}
+
 .navbar-inverse .navbar-brand:hover,
 .navbar-inverse .navbar-brand:focus {
 }
 
+.navbar-inverse .navbar-brand {
+  color: #fff;
+  text-decoration: none;
+  font-size: 32px;
+}
+
+
 /* CUSTOMIZE THE CAROUSEL
 -------------------------------------------------- */
 

docs/development/howtocontribute.md

@@ -5,6 +5,12 @@ description: "How to contribute"
 group: development
 ---
 
+## IMPORTANT
+
+Zeppelin is [Apache2 License](http://www.apache.org/licenses/LICENSE-2.0.html) Software.
+Contribute to Zeppelin (Source code, Documents, Image, Website) means you agree license all your contributions as Apache2 License.
+
+
 
 ### Setting up
 Here are some things you will need to build and test Zeppelin. 

docs/development/writingzeppelininterpreter.md

@@ -26,14 +26,14 @@ Once you have build your interpreter, you can place your interpreter under direc
 ### Configure your interpreter
 
 You can configure zeppelin.interpreters property in conf/zeppelin-site.xml
-Property value is comma separated [INTERPRETER_NAME]:[INTERPRETER_CLASS_NAME]
+Property value is comma separated [INTERPRETER_CLASS_NAME]
 
 for example, 
 
 ```
 <property>
   <name>zeppelin.interpreters</name>
-  <value>spark:com.nflabs.zeppelin.spark.SparkInterpreter,sql:com.nflabs.zeppelin.spark.SparkSqlInterpreter,md:com.nflabs.zeppelin.markdown.Markdown,sh:com.nflabs.zeppelin.shell.ShellInterpreter,myintp:com.me.MyNewInterpreter</value>
+  <value>com.nflabs.zeppelin.spark.SparkInterpreter,com.nflabs.zeppelin.spark.SparkSqlInterpreter,com.nflabs.zeppelin.markdown.Markdown,com.nflabs.zeppelin.shell.ShellInterpreter,com.me.MyNewInterpreter</value>
 </property>
 ```
 

docs/display.md

@@ -0,0 +1,47 @@
+---
+layout: page
+title: "Display"
+description: ""
+group: manual
+---
+{% include JB/setup %}
+
+
+### 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.
+
+<br />
+#### Display as Text
+
+If output has no magic keyword provided Zeppelin print the output in text.
+
+<img src="../assets/themes/zeppelin/img/screenshots/display_text.png" />
+
+<br />
+#### Display as Html
+
+If ouput starts with %html, it interpreted as a 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.
+
+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.
+
+<img src="../assets/themes/zeppelin/img/screenshots/display_table_html.png" />
+
+<br />
+#### Display as Image
+
+If output starts with %img, it is interpreted as base64 encoded image.
+
+<img src="../assets/themes/zeppelin/img/screenshots/display_image.png" />

docs/dynamicform.md

@@ -0,0 +1,65 @@
+---
+layout: page
+title: "Dynamic Form"
+description: ""
+group: manual
+---
+{% include JB/setup %}
+
+
+## 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.
+
+<br />
+### Using form Templates
+
+This mode creates form using simple template language. It's simple and easy to use. For example Markdown, Shell, SparkSql language backend uses it.
+
+<br />
+#### Text input form
+
+To create text input form, use _${formName}_ templates.
+
+for example
+
+<img src="../assets/themes/zeppelin/img/screenshots/form_input.png" />
+
+
+Also you can provide default value, using _${formName=defaultValue}_.
+
+<img src="../assets/themes/zeppelin/img/screenshots/form_input_default.png" />
+
+
+<br />
+#### Select form
+
+To create select form, use _${formName=defaultValue,option1|option2...}_
+
+for example
+
+<img src="../assets/themes/zeppelin/img/screenshots/form_select.png" />
+
+Also you can separate option's display name and value, using _${formName=defaultValue,option1(DisplayName)|option2(DisplayName)...}_
+
+<img src="../assets/themes/zeppelin/img/screenshots/form_select_displayname.png" />
+
+<br />
+### Creates Programatically
+
+Some language backend use programtic way to create form. for example, scala language backend. Function to create form is provided by [ZeppelinContext](./zeppelincontext.html).
+
+Here're some examples.
+
+Text input form
+
+<img src="../assets/themes/zeppelin/img/screenshots/form_input_prog.png" />
+
+Text input form with default value
+
+<img src="../assets/themes/zeppelin/img/screenshots/form_input_default_prog.png" />
+
+Select form
+
+<img src="../assets/themes/zeppelin/img/screenshots/form_select_prog.png" />

docs/index.md

@@ -10,6 +10,13 @@ group: nav-right
 
 * [Install](./install/install.html)
 
+### Manual
+
+* [Zeppelin Context](./zeppelincontext.html)
+* [Dynamic Form](./dynamicform.html)
+* [Display System](./display.html)
+
+
 ### Development
 
 * [Writing Zeppelin Interpreter](./development/writingzeppelininterpreter.html)

docs/zeppelincontext.md

@@ -0,0 +1,78 @@
+---
+layout: page
+title: "ZeppelinContext"
+description: ""
+group: manual
+---
+{% include JB/setup %}
+
+
+### Zeppelin Context
+
+ZeppelinContext is automatically created and injected into Scala language backend.
+It provies following function and references.
+
+<br />
+#### SparkContext, SQLContext
+
+ZeppelinContext provides reference to SparkContext and SQLContext with some shortcut function.
+
+```
+/* reference to SparkContext */
+z.sc
+
+/* reference to SQLContext */
+z.sqlContext
+
+/* Shortcut to z.sqlContext.sql() */
+z.sql("select * from ...")
+```
+
+
+<br />
+#### Dependency loader (Experimental)
+
+ZeppelinContext provides series of functions that loads jar library from local FS or Remote Maven repository. Loaded library is automatically added into Scala interpreter and SparkContext.
+
+```
+/* Load a library from local FS */
+z.load("/path/to/your.jar")
+
+/* Load a library from Maven repository */
+z.load("groupId:artifactId:version")
+
+/* Load library from Maven repository with dependencies */
+z.load("groupId:artifactId:version", true)
+
+/* Load a library from Local FS and add it into SparkContext */
+z.loadAndDist("/path/to/your.jar")
+
+/* Load a library with dependencies from Maven repository and add it into SparkContext*/
+z.loadAndDist("groupId:artifactId:version")
+
+/* Load library with dependencies from maven repository and add it into SparkContext*/
+z.loadAndDist("groupId:artifactId:version", true)
+```
+
+
+<br />
+#### Form creation
+
+ZeppelinContext also provides functions for creating forms. To learn more about dynamic form, checkout [Dynamic Form](./dynamicform.html).
+
+
+```
+/* Create text input form */
+z.input("formName")
+
+/* Create text input form with default value */
+z.input("formName", "defaultValue")
+
+/* Create select form */
+z.select("formName", Seq(("option1", "option1DisplayName"),
+                         ("option2", "option2DisplayName")))
+
+/* Create select form with default value*/
+z.select("formName", "option1", Seq(("option1", "option1DisplayName"),
+                                    ("option2", "option2DisplayName")))
+```