You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@zeppelin.apache.org by mi...@apache.org on 2016/06/26 05:57:58 UTC
[1/2] zeppelin git commit: [ZEPPELIN-1018] Apply auto "Table of
Contents" generator to Zeppelin docs website
Repository: zeppelin
Updated Branches:
refs/heads/master e1b384722 -> 5975125f1
http://git-wip-us.apache.org/repos/asf/zeppelin/blob/5975125f/docs/interpreter/markdown.md
----------------------------------------------------------------------
diff --git a/docs/interpreter/markdown.md b/docs/interpreter/markdown.md
index 08b44f8..21184dc 100644
--- a/docs/interpreter/markdown.md
+++ b/docs/interpreter/markdown.md
@@ -6,9 +6,11 @@ group: manual
---
{% include JB/setup %}
-## Markdown Interpreter for Apache Zeppelin
+# Markdown Interpreter for Apache Zeppelin
-### Overview
+<div id="toc"></div>
+
+## Overview
[Markdown](http://daringfireball.net/projects/markdown/) is a plain text formatting syntax designed so that it can be converted to HTML.
Zeppelin uses markdown4j. For more examples and extension support, please checkout [here](https://code.google.com/p/markdown4j/).
In Zeppelin notebook, you can use ` %md ` in the beginning of a paragraph to invoke the Markdown interpreter and generate static html from Markdown plain text.
@@ -17,7 +19,7 @@ In Zeppelin, Markdown interpreter is enabled by default.
<img src="{{BASE_PATH}}/assets/themes/zeppelin/img/docs-img/markdown-interpreter-setting.png" width="60%" />
-### Example
+## Example
The following example demonstrates the basic usage of Markdown in a Zeppelin notebook.
<img src="{{BASE_PATH}}/assets/themes/zeppelin/img/docs-img/markdown-example.png" width="70%" />
http://git-wip-us.apache.org/repos/asf/zeppelin/blob/5975125f/docs/interpreter/postgresql.md
----------------------------------------------------------------------
diff --git a/docs/interpreter/postgresql.md b/docs/interpreter/postgresql.md
index 5985b18..107fda1 100644
--- a/docs/interpreter/postgresql.md
+++ b/docs/interpreter/postgresql.md
@@ -6,7 +6,12 @@ group: manual
---
{% include JB/setup %}
+# PostgreSQL, Apache HAWQ (incubating) Interpreter for Apache Zeppelin
+
+<div id="toc"></div>
+
## Important Notice
+
Postgresql Interpreter will be deprecated and merged into JDBC Interpreter. You can use Postgresql by using JDBC Interpreter with same functionality. See the example below of settings and dependencies.
### Properties
@@ -44,10 +49,19 @@ Postgresql Interpreter will be deprecated and merged into JDBC Interpreter. You
<td></td>
</tr>
</table>
+---
-----
+## Overview
-## PostgreSQL, HAWQ Interpreter for Apache Zeppelin
+[<img align="right" src="http://img.youtube.com/vi/wqXXQhJ5Uk8/0.jpg" alt="zeppelin-view" hspace="10" width="250"></img>](https://www.youtube.com/watch?v=wqXXQhJ5Uk8)
+
+This interpreter seamlessly supports the following SQL data processing engines:
+
+* [PostgreSQL](http://www.postgresql.org/) - OSS, Object-relational database management system (ORDBMS)
+* [pache HAWQ (incubating)](http://hawq.incubator.apache.org/) - Powerful open source SQL-On-Hadoop engine.
+* [Greenplum](http://pivotal.io/big-data/pivotal-greenplum-database) - MPP database built on open source PostgreSQL.
+
+This [Video Tutorial](https://www.youtube.com/watch?v=wqXXQhJ5Uk8) illustrates some of the features provided by the `Postgresql Interpreter`.
<table class="table-configuration">
<tr>
@@ -62,17 +76,7 @@ Postgresql Interpreter will be deprecated and merged into JDBC Interpreter. You
</tr>
</table>
-[<img align="right" src="http://img.youtube.com/vi/wqXXQhJ5Uk8/0.jpg" alt="zeppelin-view" hspace="10" width="250"></img>](https://www.youtube.com/watch?v=wqXXQhJ5Uk8)
-
-This interpreter seamlessly supports the following SQL data processing engines:
-
-* [PostgreSQL](http://www.postgresql.org/) - OSS, Object-relational database management system (ORDBMS)
-* [Apache HAWQ](http://pivotal.io/big-data/pivotal-hawq) - Powerful [Open Source](https://wiki.apache.org/incubator/HAWQProposal) SQL-On-Hadoop engine.
-* [Greenplum](http://pivotal.io/big-data/pivotal-greenplum-database) - MPP database built on open source PostgreSQL.
-
-This [Video Tutorial](https://www.youtube.com/watch?v=wqXXQhJ5Uk8) illustrates some of the features provided by the `Postgresql Interpreter`.
-
-### Create Interpreter
+## Create Interpreter
By default Zeppelin creates one `PSQL` instance. You can remove it or create new instances.
Multiple PSQL instances can be created, each configured to the same or different backend databases. But over time a `Notebook` can have only one PSQL interpreter instance `bound`. That means you _cannot_ connect to different databases in the same `Notebook`. This is a known Zeppelin limitation.
@@ -81,10 +85,10 @@ To create new PSQL instance open the `Interpreter` section and click the `+Creat
> Note: The `Name` of the instance is used only to distinct the instances while binding them to the `Notebook`. The `Name` is irrelevant inside the `Notebook`. In the `Notebook` you must use `%psql.sql` tag.
-### Bind to Notebook
+## Bind to Notebook
In the `Notebook` click on the `settings` icon in the top right corner. The select/deselect the interpreters to be bound with the `Notebook`.
-### Configuration
+## Configuration
You can modify the configuration of the PSQL from the `Interpreter` section. The PSQL interpreter expenses the following properties:
<table class="table-configuration">
@@ -120,12 +124,12 @@ You can modify the configuration of the PSQL from the `Interpreter` section. Th
</tr>
</table>
-### How to use
+## How to use
```
Tip: Use (CTRL + .) for SQL auto-completion.
```
-#### DDL and SQL commands
+### DDL and SQL commands
Start the paragraphs with the full `%psql.sql` prefix tag! The short notation: `%psql` would still be able run the queries but the syntax highlighting and the auto-completions will be disabled.
You can use the standard CREATE / DROP / INSERT commands to create or modify the data model:
@@ -154,7 +158,7 @@ select count(*) from mytable;
select * from mytable;
```
-#### PSQL command line tools
+### PSQL command line tools
Use the Shell Interpreter (`%sh`) to access the command line [PSQL](http://www.postgresql.org/docs/9.4/static/app-psql.html) interactively:
```bash
@@ -179,7 +183,7 @@ This will produce output like this:
retail_demo | gpadmin
```
-#### Apply Zeppelin Dynamic Forms
+### Apply Zeppelin Dynamic Forms
You can leverage [Zeppelin Dynamic Form](../manual/dynamicform.html) inside your queries. You can use both the `text input` and `select form` parametrization features
```sql
@@ -191,7 +195,7 @@ ORDER BY count ${order=DESC,DESC|ASC}
LIMIT ${limit=10};
```
-#### Example HAWQ PXF/HDFS Tables
+### Example HAWQ PXF/HDFS Tables
Create HAWQ external table that read data from tab-separated-value data in HDFS.
```sql
@@ -209,5 +213,5 @@ And retrieve content
select * from retail_demo.payment_methods_pxf
```
-### Auto-completion
+## Auto-completion
The PSQL Interpreter provides a basic auto-completion functionality. On `(Ctrl+.)` it list the most relevant suggestions in a pop-up window. In addition to the SQL keyword the interpreter provides suggestions for the Schema, Table, Column names as well.
http://git-wip-us.apache.org/repos/asf/zeppelin/blob/5975125f/docs/interpreter/python.md
----------------------------------------------------------------------
diff --git a/docs/interpreter/python.md b/docs/interpreter/python.md
index b34b089..c2a38f5 100644
--- a/docs/interpreter/python.md
+++ b/docs/interpreter/python.md
@@ -6,7 +6,9 @@ group: manual
---
{% include JB/setup %}
-## Python 2 & 3 Interpreter for Apache Zeppelin
+# Python 2 & 3 Interpreter for Apache Zeppelin
+
+<div id="toc"></div>
## Configuration
<table class="table-configuration">
@@ -63,8 +65,6 @@ print (z.select("f1",[("o1","1"),("o2","2")],"2"))
print("".join(z.checkbox("f3", [("o1","1"), ("o2","2")],["1"])))
```
-
-
## Zeppelin features not fully supported by the Python Interpreter
* Interrupt a paragraph execution (`cancel()` method) is currently only supported in Linux and MacOs. If interpreter runs in another operating system (for instance MS Windows) , interrupt a paragraph will close the whole interpreter. A JIRA ticket ([ZEPPELIN-893](https://issues.apache.org/jira/browse/ZEPPELIN-893)) is opened to implement this feature in a next release of the interpreter.
@@ -90,8 +90,7 @@ z.show function can take optional parameters to adapt graph width and height
z.show(plt, width='50px')
z.show(plt, height='150px')
```
-
-[](/docs/interpreter/screenshots/pythonMatplotlib.png)
+<img class="img-responsive" src="../assets/themes/zeppelin/img/docs-img/pythonMatplotlib.png" />
## Pandas integration
@@ -105,7 +104,6 @@ rates = pd.read_csv("bank.csv", sep=";")
z.show(rates)
```
-
## Technical description
-For in-depth technical details on current implementation plese reffer [python/README.md](https://github.com/apache/zeppelin/blob/master/python/README.md)
+For in-depth technical details on current implementation plese reffer [python/README.md](https://github.com/apache/zeppelin/blob/master/python/README.md).
http://git-wip-us.apache.org/repos/asf/zeppelin/blob/5975125f/docs/interpreter/r.md
----------------------------------------------------------------------
diff --git a/docs/interpreter/r.md b/docs/interpreter/r.md
index c5ed98b..dce8bd1 100644
--- a/docs/interpreter/r.md
+++ b/docs/interpreter/r.md
@@ -6,78 +6,99 @@ group: manual
---
{% include JB/setup %}
-## R Interpreter
+# R Interpreter for Apache Zeppelin
-This is a the Apache Zeppelin project, with the addition of support for the R programming language and R-spark integration.
+<div id="toc"></div>
-### Requirements
+## Overview
-Additional requirements for the R interpreter are:
+[R](https://www.r-project.org) is a free software environment for statistical computing and graphics.
- * R 3.1 or later (earlier versions may work, but have not been tested)
- * The `evaluate` R package.
+To run R code and visualize plots in Apache Zeppelin, you will need R on your master node (or your dev laptop).
-For full R support, you will also need the following R packages:
++ For Centos: `yum install R R-devel libcurl-devel openssl-devel`
++ For Ubuntu: `apt-get install r-base`
- * `knitr`
- * `repr` -- available with `devtools::install_github("IRkernel/repr")`
- * `htmltools` -- required for some interactive plotting
- * `base64enc` -- required to view R base plots
+Validate your installation with a simple R command:
-### Configuration
+```
+R -e "print(1+1)"
+```
-To run Zeppelin with the R Interpreter, the SPARK_HOME environment variable must be set. The best way to do this is by editing `conf/zeppelin-env.sh`.
+To enjoy plots, install additional libraries with:
+```
++ devtools with `R -e "install.packages('devtools', repos = 'http://cran.us.r-project.org')"`
++ knitr with `R -e "install.packages('knitr', repos = 'http://cran.us.r-project.org')"`
++ ggplot2 with `R -e "install.packages('ggplot2', repos = 'http://cran.us.r-project.org')"`
++ Other vizualisation librairies: `R -e "install.packages(c('devtools','mplot', 'googleVis'), repos = 'http://cran.us.r-project.org'); require(devtools); install_github('ramnathv/rCharts')"`
+```
+
+We recommend you to also install the following optional R libraries for happy data analytics:
+
++ glmnet
++ pROC
++ data.table
++ caret
++ sqldf
++ wordcloud
+
+## Configuration
+
+To run Zeppelin with the R Interpreter, the `SPARK_HOME` environment variable must be set. The best way to do this is by editing `conf/zeppelin-env.sh`.
If it is not set, the R Interpreter will not be able to interface with Spark.
-You should also copy `conf/zeppelin-site.xml.template` to `conf/zeppelin-site.xml`. That will ensure that Zeppelin sees the R Interpreter the first time it starts up.
+You should also copy `conf/zeppelin-site.xml.template` to `conf/zeppelin-site.xml`. That will ensure that Zeppelin sees the R Interpreter the first time it starts up.
-### Using the R Interpreter
+## Using the R Interpreter
By default, the R Interpreter appears as two Zeppelin Interpreters, `%r` and `%knitr`.
`%r` will behave like an ordinary REPL. You can execute commands as in the CLI.
-[](screenshots/repl2plus2.png)
+<img class="img-responsive" src="../assets/themes/zeppelin/img/docs-img/repl2plus2.png" width="700px"/>
R base plotting is fully supported
-[](screenshots/replhist.png)
+<img class="img-responsive" src="../assets/themes/zeppelin/img/docs-img/replhist.png" width="550px"/>
If you return a data.frame, Zeppelin will attempt to display it using Zeppelin's built-in visualizations.
-[](screenshots/replhead.png)
+<img class="img-responsive" src="../assets/themes/zeppelin/img/docs-img/replhead.png" width="550px"/>
`%knitr` interfaces directly against `knitr`, with chunk options on the first line:
-[](screenshots/knitgeo.png)
-[](screenshots/knitstock.png)
-[](screenshots/knitmotion.png)
+<img class="img-responsive" src="../assets/themes/zeppelin/img/docs-img/knitgeo.png" width="550px"/>
+
+<img class="img-responsive" src="../assets/themes/zeppelin/img/docs-img/knitstock.png" width="550px"/>
+
+<img class="img-responsive" src="../assets/themes/zeppelin/img/docs-img/knitmotion.png" width="550px"/>
The two interpreters share the same environment. If you define a variable from `%r`, it will be within-scope if you then make a call using `knitr`.
-### Using SparkR & Moving Between Languages
+## Using SparkR & Moving Between Languages
If `SPARK_HOME` is set, the `SparkR` package will be loaded automatically:
-[](screenshots/sparkrfaithful.png)
+<img class="img-responsive" src="../assets/themes/zeppelin/img/docs-img/sparkrfaithful.png" width="550px"/>
The Spark Context and SQL Context are created and injected into the local environment automatically as `sc` and `sql`.
The same context are shared with the `%spark`, `%sql` and `%pyspark` interpreters:
-[](screenshots/backtoscala.png)
+<img class="img-responsive" src="../assets/themes/zeppelin/img/docs-img/backtoscala.png" width="700px"/>
You can also make an ordinary R variable accessible in scala and Python:
-[](screenshots/varr1.png)
+<img class="img-responsive" src="../assets/themes/zeppelin/img/docs-img/varr1.png" width="550px"/>
And vice versa:
-[](screenshots/varscala.png)
-[](screenshots/varr2.png)
+<img class="img-responsive" src="../assets/themes/zeppelin/img/docs-img/varscala.png" width="550px"/>
+
+<img class="img-responsive" src="../assets/themes/zeppelin/img/docs-img/varr2.png" width="550px"/>
-### Caveats & Troubleshooting
+## Caveats & Troubleshooting
* Almost all issues with the R interpreter turned out to be caused by an incorrectly set `SPARK_HOME`. The R interpreter must load a version of the `SparkR` package that matches the running version of Spark, and it does this by searching `SPARK_HOME`. If Zeppelin isn't configured to interface with Spark in `SPARK_HOME`, the R interpreter will not be able to connect to Spark.
@@ -98,40 +119,3 @@ And vice versa:
* Error `unable to start device X11` with the repl interpreter. Check your shell login scripts to see if they are adjusting the `DISPLAY` environment variable. This is common on some operating systems as a workaround for ssh issues, but can interfere with R plotting.
* akka Library Version or `TTransport` errors. This can happen if you try to run Zeppelin with a SPARK_HOME that has a version of Spark other than the one specified with `-Pspark-1.x` when Zeppelin was compiled.
-
-
-
-
-
-## R Interpreter for Apache Zeppelin
-
-[R](https://www.r-project.org) is a free software environment for statistical computing and graphics.
-
-To run R code and visualize plots in Apache Zeppelin, you will need R on your master node (or your dev laptop).
-
-+ For Centos: `yum install R R-devel libcurl-devel openssl-devel`
-+ For Ubuntu: `apt-get install r-base`
-
-Validate your installation with a simple R command:
-
-```
-R -e "print(1+1)"
-```
-
-To enjoy plots, install additional libraries with:
-
-```
-+ devtools with `R -e "install.packages('devtools', repos = 'http://cran.us.r-project.org')"`
-+ knitr with `R -e "install.packages('knitr', repos = 'http://cran.us.r-project.org')"`
-+ ggplot2 with `R -e "install.packages('ggplot2', repos = 'http://cran.us.r-project.org')"`
-+ Other vizualisation librairies: `R -e "install.packages(c('devtools','mplot', 'googleVis'), repos = 'http://cran.us.r-project.org'); require(devtools); install_github('ramnathv/rCharts')"`
-```
-
-We recommend you to also install the following optional R libraries for happy data analytics:
-
-+ glmnet
-+ pROC
-+ data.table
-+ caret
-+ sqldf
-+ wordcloud
http://git-wip-us.apache.org/repos/asf/zeppelin/blob/5975125f/docs/interpreter/scalding.md
----------------------------------------------------------------------
diff --git a/docs/interpreter/scalding.md b/docs/interpreter/scalding.md
index ec5608b..e8774df 100644
--- a/docs/interpreter/scalding.md
+++ b/docs/interpreter/scalding.md
@@ -6,17 +6,20 @@ group: manual
---
{% include JB/setup %}
-## Scalding Interpreter for Apache Zeppelin
+# Scalding Interpreter for Apache Zeppelin
+
+<div id="toc"></div>
+
[Scalding](https://github.com/twitter/scalding) is an open source Scala library for writing MapReduce jobs.
-### Building the Scalding Interpreter
+## Building the Scalding Interpreter
You have to first build the Scalding interpreter by enable the **scalding** profile as follows:
```
mvn clean package -Pscalding -DskipTests
```
-### Enabling the Scalding Interpreter
+## Enabling the Scalding Interpreter
In a notebook, to enable the **Scalding** interpreter, click on the **Gear** icon,select **Scalding**, and hit **Save**.
<center>
@@ -27,7 +30,7 @@ In a notebook, to enable the **Scalding** interpreter, click on the **Gear** ico
</center>
-### Configuring the Interpreter
+## Configuring the Interpreter
Scalding interpreter runs in two modes:
@@ -65,9 +68,9 @@ For reducer estimation, you need to add something like:
If you want to control the maximum number of open interpreters, you have to select "scoped" interpreter for note
option and set max.open.instances argument.
-### Testing the Interpreter
+## Testing the Interpreter
-#### Local mode
+### Local mode
In example, by using the [Alice in Wonderland](https://gist.github.com/johnynek/a47699caa62f4f38a3e2) tutorial,
we will count words (of course!), and plot a graph of the top 10 words in the book.
@@ -111,7 +114,7 @@ If you click on the icon for the pie chart, you should be able to see a chart li
-#### HDFS mode
+### HDFS mode
**Test mode**
@@ -146,7 +149,7 @@ a.toList
This command should create a map reduce job.
-### Future Work
+## Future Work
* Better user feedback (hadoop url, progress updates)
* Ability to cancel jobs
* Ability to dynamically load jars without restarting the interpreter
http://git-wip-us.apache.org/repos/asf/zeppelin/blob/5975125f/docs/interpreter/screenshots/backtoscala.png
----------------------------------------------------------------------
diff --git a/docs/interpreter/screenshots/backtoscala.png b/docs/interpreter/screenshots/backtoscala.png
deleted file mode 100644
index c0c897a..0000000
Binary files a/docs/interpreter/screenshots/backtoscala.png and /dev/null differ
http://git-wip-us.apache.org/repos/asf/zeppelin/blob/5975125f/docs/interpreter/screenshots/knitgeo.png
----------------------------------------------------------------------
diff --git a/docs/interpreter/screenshots/knitgeo.png b/docs/interpreter/screenshots/knitgeo.png
deleted file mode 100644
index d1eb0d8..0000000
Binary files a/docs/interpreter/screenshots/knitgeo.png and /dev/null differ
http://git-wip-us.apache.org/repos/asf/zeppelin/blob/5975125f/docs/interpreter/screenshots/knitmotion.png
----------------------------------------------------------------------
diff --git a/docs/interpreter/screenshots/knitmotion.png b/docs/interpreter/screenshots/knitmotion.png
deleted file mode 100644
index a1048ea..0000000
Binary files a/docs/interpreter/screenshots/knitmotion.png and /dev/null differ
http://git-wip-us.apache.org/repos/asf/zeppelin/blob/5975125f/docs/interpreter/screenshots/knitstock.png
----------------------------------------------------------------------
diff --git a/docs/interpreter/screenshots/knitstock.png b/docs/interpreter/screenshots/knitstock.png
deleted file mode 100644
index 7a27c60..0000000
Binary files a/docs/interpreter/screenshots/knitstock.png and /dev/null differ
http://git-wip-us.apache.org/repos/asf/zeppelin/blob/5975125f/docs/interpreter/screenshots/pythonMatplotlib.png
----------------------------------------------------------------------
diff --git a/docs/interpreter/screenshots/pythonMatplotlib.png b/docs/interpreter/screenshots/pythonMatplotlib.png
deleted file mode 100644
index 3d53043..0000000
Binary files a/docs/interpreter/screenshots/pythonMatplotlib.png and /dev/null differ
http://git-wip-us.apache.org/repos/asf/zeppelin/blob/5975125f/docs/interpreter/screenshots/repl2plus2.png
----------------------------------------------------------------------
diff --git a/docs/interpreter/screenshots/repl2plus2.png b/docs/interpreter/screenshots/repl2plus2.png
deleted file mode 100644
index 8f70092..0000000
Binary files a/docs/interpreter/screenshots/repl2plus2.png and /dev/null differ
http://git-wip-us.apache.org/repos/asf/zeppelin/blob/5975125f/docs/interpreter/screenshots/replhead.png
----------------------------------------------------------------------
diff --git a/docs/interpreter/screenshots/replhead.png b/docs/interpreter/screenshots/replhead.png
deleted file mode 100644
index b09ccab..0000000
Binary files a/docs/interpreter/screenshots/replhead.png and /dev/null differ
http://git-wip-us.apache.org/repos/asf/zeppelin/blob/5975125f/docs/interpreter/screenshots/replhist.png
----------------------------------------------------------------------
diff --git a/docs/interpreter/screenshots/replhist.png b/docs/interpreter/screenshots/replhist.png
deleted file mode 100644
index 5291404..0000000
Binary files a/docs/interpreter/screenshots/replhist.png and /dev/null differ
http://git-wip-us.apache.org/repos/asf/zeppelin/blob/5975125f/docs/interpreter/screenshots/sparkrfaithful.png
----------------------------------------------------------------------
diff --git a/docs/interpreter/screenshots/sparkrfaithful.png b/docs/interpreter/screenshots/sparkrfaithful.png
deleted file mode 100644
index ec956c7..0000000
Binary files a/docs/interpreter/screenshots/sparkrfaithful.png and /dev/null differ
http://git-wip-us.apache.org/repos/asf/zeppelin/blob/5975125f/docs/interpreter/screenshots/varr1.png
----------------------------------------------------------------------
diff --git a/docs/interpreter/screenshots/varr1.png b/docs/interpreter/screenshots/varr1.png
deleted file mode 100644
index ac997a8..0000000
Binary files a/docs/interpreter/screenshots/varr1.png and /dev/null differ
http://git-wip-us.apache.org/repos/asf/zeppelin/blob/5975125f/docs/interpreter/screenshots/varr2.png
----------------------------------------------------------------------
diff --git a/docs/interpreter/screenshots/varr2.png b/docs/interpreter/screenshots/varr2.png
deleted file mode 100644
index b49988d..0000000
Binary files a/docs/interpreter/screenshots/varr2.png and /dev/null differ
http://git-wip-us.apache.org/repos/asf/zeppelin/blob/5975125f/docs/interpreter/screenshots/varscala.png
----------------------------------------------------------------------
diff --git a/docs/interpreter/screenshots/varscala.png b/docs/interpreter/screenshots/varscala.png
deleted file mode 100644
index 7f95ad2..0000000
Binary files a/docs/interpreter/screenshots/varscala.png and /dev/null differ
http://git-wip-us.apache.org/repos/asf/zeppelin/blob/5975125f/docs/interpreter/spark.md
----------------------------------------------------------------------
diff --git a/docs/interpreter/spark.md b/docs/interpreter/spark.md
index df5e831..a183033 100644
--- a/docs/interpreter/spark.md
+++ b/docs/interpreter/spark.md
@@ -7,8 +7,14 @@ group: manual
{% include JB/setup %}
-## Spark Interpreter for Apache Zeppelin
-[Apache Spark](http://spark.apache.org) is supported in Zeppelin with
+# Spark Interpreter for Apache Zeppelin
+
+<div id="toc"></div>
+
+## Overview
+[Apache Spark](http://spark.apache.org) is a fast and general-purpose cluster computing system.
+It provides high-level APIs in Java, Scala, Python and R, and an optimized engine that supports general execution graphs
+Apache Spark is supported in Zeppelin with
Spark Interpreter group, which consists of five interpreters.
<table class="table-configuration">
@@ -200,13 +206,13 @@ Here are few examples:
* SPARK\_SUBMIT\_OPTIONS in conf/zeppelin-env.sh
- export SPARK_SUBMIT_OPTIONS="--packages com.databricks:spark-csv_2.10:1.2.0 --jars /path/mylib1.jar,/path/mylib2.jar --files /path/mylib1.py,/path/mylib2.zip,/path/mylib3.egg"
+ export SPARK_SUBMIT_OPTIONS="--packages com.databricks:spark-csv_2.10:1.2.0 --jars /path/mylib1.jar,/path/mylib2.jar --files /path/mylib1.py,/path/mylib2.zip,/path/mylib3.egg"
* SPARK_HOME/conf/spark-defaults.conf
- spark.jars /path/mylib1.jar,/path/mylib2.jar
- spark.jars.packages com.databricks:spark-csv_2.10:1.2.0
- spark.files /path/mylib1.py,/path/mylib2.egg,/path/mylib3.zip
+ spark.jars /path/mylib1.jar,/path/mylib2.jar
+ spark.jars.packages com.databricks:spark-csv_2.10:1.2.0
+ spark.files /path/mylib1.py,/path/mylib2.egg,/path/mylib3.zip
### 3. Dynamic Dependency Loading via %dep interpreter
> Note: `%dep` interpreter is deprecated since v0.6.0.
@@ -344,7 +350,7 @@ select * from ${table=defaultTableName} where text like '%${search}%'
To learn more about dynamic form, checkout [Dynamic Form](../manual/dynamicform.html).
-### Interpreter setting option.
+## Interpreter setting option
Interpreter setting can choose one of 'shared', 'scoped', 'isolated' option. Spark interpreter creates separate scala compiler per each notebook but share a single SparkContext in 'scoped' mode (experimental). It creates separate SparkContext per each notebook in 'isolated' mode.
@@ -354,7 +360,7 @@ Logical setup with Zeppelin, Kerberos Key Distribution Center (KDC), and Spark o
<img src="../assets/themes/zeppelin/img/docs-img/kdc_zeppelin.png">
-####Configuration Setup
+### Configuration Setup
1. On the server that Zeppelin is installed, install Kerberos client modules and configuration, krb5.conf.
This is to make the server communicate with KDC.
http://git-wip-us.apache.org/repos/asf/zeppelin/blob/5975125f/docs/manual/dynamicform.md
----------------------------------------------------------------------
diff --git a/docs/manual/dynamicform.md b/docs/manual/dynamicform.md
index 6594767..b554fec 100644
--- a/docs/manual/dynamicform.md
+++ b/docs/manual/dynamicform.md
@@ -19,16 +19,18 @@ limitations under the License.
-->
{% include JB/setup %}
-## Dynamic Form
+# Dynamic Form
-Zeppelin dynamically creates input forms. Depending on language backend, there're two different ways to create dynamic form.
+<div id="toc"></div>
+
+Apache 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.
-### Using form Templates
+## 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.
-#### Text input form
+### Text input form
To create text input form, use `${formName}` templates.
@@ -42,7 +44,7 @@ Also you can provide default value, using `${formName=defaultValue}`.
<img src="../assets/themes/zeppelin/img/screenshots/form_input_default.png" />
-#### Select form
+### Select form
To create select form, use `${formName=defaultValue,option1|option2...}`
@@ -54,7 +56,7 @@ Also you can separate option's display name and value, using `${formName=default
<img src="../assets/themes/zeppelin/img/screenshots/form_select_displayname.png" />
-#### Checkbox form
+### Checkbox form
For multi-selection, you can create a checkbox form using `${checkbox:formName=defaultValue1|defaultValue2...,option1|option2...}`. The variable will be substituted by a comma-separated string based on the selected items. For example:
@@ -64,13 +66,13 @@ Besides, you can specify the delimiter using `${checkbox(delimiter):formName=...
<img src="../assets/themes/zeppelin/img/screenshots/form_checkbox_delimiter.png">
-### Creates Programmatically
+## Creates Programmatically
Some language backend uses programmatic way to create form. For example [ZeppelinContext](../interpreter/spark.html#zeppelincontext) provides form creation API
Here're some examples.
-####Text input form
+### Text input form
<div class="codetabs">
<div data-lang="scala" markdown="1">
@@ -91,7 +93,7 @@ print("Hello "+z.input("name"))
</div>
<img src="../assets/themes/zeppelin/img/screenshots/form_input_prog.png" />
-####Text input form with default value
+### Text input form with default value
<div class="codetabs">
<div data-lang="scala" markdown="1">
@@ -112,7 +114,7 @@ print("Hello "+z.input("name", "sun"))
</div>
<img src="../assets/themes/zeppelin/img/screenshots/form_input_default_prog.png" />
-####Select form
+### Select form
<div class="codetabs">
<div data-lang="scala" markdown="1">
http://git-wip-us.apache.org/repos/asf/zeppelin/blob/5975125f/docs/manual/dynamicinterpreterload.md
----------------------------------------------------------------------
diff --git a/docs/manual/dynamicinterpreterload.md b/docs/manual/dynamicinterpreterload.md
index 0794314..42dd74d 100644
--- a/docs/manual/dynamicinterpreterload.md
+++ b/docs/manual/dynamicinterpreterload.md
@@ -19,12 +19,13 @@ limitations under the License.
-->
{% include JB/setup %}
-## Dynamic Interpreter Loading using REST API
+# Dynamic Interpreter Loading using REST API
+
+<div id="toc"></div>
Zeppelin provides pluggable interpreter architecture which results in a wide and variety of the supported backend system. In this section, we will introduce **Dynamic interpreter loading** using **REST API**. This concept actually comes from [Zeppelin Helium Proposal](https://cwiki.apache.org/confluence/display/ZEPPELIN/Helium+proposal).
Before we start, if you are not familiar with the concept of **Zeppelin interpreter**, you can check out [Overview of Zeppelin interpreter](../manual/interpreters.html) first.
-<br/>
## Overview
In the past, Zeppelin was loading interpreter binaries from `/interpreter/[interpreter_name]` directory. They were configured by `zeppelin.interpreters` property in `conf/zeppelin-site.xml` or `ZEPPELIN_INTERPRETERS` env variables in `conf/zeppelin-env.sh`. They were loaded on Zeppelin server startup and stayed alive until the server was stopped.
In order to simplify using 3rd party interpreters, we changed this way to **dynamically** load interpreters from **Maven Repository** using **REST API**. Hopefully, the picture below will help you to understand the process.
@@ -32,7 +33,7 @@ In order to simplify using 3rd party interpreters, we changed this way to **dyna
## Load & Unload Interpreters Using REST API
-### 1. Load
+### Load
You can **load** interpreters located in Maven repository using REST API, like this:
( Maybe, you are unfamiliar with `[interpreter_group_name]` or `[interpreter_name]`. If so, please checkout [Interpreters in Zeppelin](../manual/interpreter.html) again. )
@@ -69,21 +70,21 @@ http://127.0.0.1:8080/api/interpreter/load/md/markdown
The meaning of each parameters is:
1. **Artifact**
- - groupId: org.apache.zeppelin
- - artifactId: zeppelin-markdown
- - version: 0.6.0-SNAPSHOT
+ - groupId: org.apache.zeppelin
+ - artifactId: zeppelin-markdown
+ - version: 0.6.0-SNAPSHOT
2. **Class Name**
- - Package Name: org.apache.zeppelin
- - Interpreter Class Name: markdown.Markdown
+ - Package Name: org.apache.zeppelin
+ - Interpreter Class Name: markdown.Markdown
3. **Repository ( optional )**
- - Url: http://dl.bintray.com/spark-packages/maven
- - Snapshot: false
+ - Url: http://dl.bintray.com/spark-packages/maven
+ - Snapshot: false
> <b>Please note: </b>The interpreters you downloaded need to be **reload**, when your Zeppelin server is down.
-### 2. Unload
+### Unload
If you want to **unload** the interpreters using REST API,
```
@@ -95,7 +96,7 @@ In this case, the Restful method will be <code>**DELETE**</code>.
## What is the next step after Loading ?
### Q1. Where is the location of interpreters you downloaded ?
-
+
Actually, the answer about this question is in the above picture. Once the REST API is called, the `.jar` files of interpreters you get are saved under `ZEPPELIN_HOME/local-repo` first. Then, they will be copied to `ZEPPELIN_HOME/interpreter` directory. So, please checkout your `ZEPPELIN_HOME/interpreter`.
### Q2. Then, how can I use this interpreter ?
http://git-wip-us.apache.org/repos/asf/zeppelin/blob/5975125f/docs/manual/interpreterinstallation.md
----------------------------------------------------------------------
diff --git a/docs/manual/interpreterinstallation.md b/docs/manual/interpreterinstallation.md
index d522e62..b940f59 100644
--- a/docs/manual/interpreterinstallation.md
+++ b/docs/manual/interpreterinstallation.md
@@ -21,6 +21,8 @@ limitations under the License.
# Interpreter Installation
+<div id="toc"></div>
+
Apache Zeppelin provides **Interpreter Installation** mechanism for whom downloaded Zeppelin `netinst` binary package, or just want to install another 3rd party interpreters.
## Community managed interpreters
http://git-wip-us.apache.org/repos/asf/zeppelin/blob/5975125f/docs/manual/interpreters.md
----------------------------------------------------------------------
diff --git a/docs/manual/interpreters.md b/docs/manual/interpreters.md
index 488d5e9..a21d34e 100644
--- a/docs/manual/interpreters.md
+++ b/docs/manual/interpreters.md
@@ -19,7 +19,12 @@ limitations under the License.
-->
{% include JB/setup %}
-## Interpreters in Zeppelin
+# Interpreters in Apache Zeppelin
+
+<div id="toc"></div>
+
+## Overview
+
In this section, we will explain about the role of interpreters, interpreters group and interpreter settings in Zeppelin.
The concept of Zeppelin interpreter allows any language/data-processing-backend to be plugged into Zeppelin.
Currently, Zeppelin supports many interpreters such as Scala ( with Apache Spark ), Python ( with Apache Spark ), SparkSQL, JDBC, Markdown, Shell and so on.
@@ -29,12 +34,12 @@ Zeppelin Interpreter is a plug-in which enables Zeppelin users to use a specific
When you click the ```+Create``` button in the interpreter page, the interpreter drop-down list box will show all the available interpreters on your server.
-<img src="../assets/themes/zeppelin/img/screenshots/interpreter_create.png">
+<img src="../assets/themes/zeppelin/img/screenshots/interpreter_create.png" width="280px">
-## What is Zeppelin Interpreter Setting?
+## What is interpreter setting?
Zeppelin interpreter setting is the configuration of a given interpreter on Zeppelin server. For example, the properties are required for hive JDBC interpreter to connect to the Hive server.
-<img src="../assets/themes/zeppelin/img/screenshots/interpreter_setting.png">
+<img src="../assets/themes/zeppelin/img/screenshots/interpreter_setting.png" width="500px">
Properties are exported as environment variable when property name is consisted of upper characters, numbers and underscore ([A-Z_0-9]). Otherwise set properties as JVM property.
@@ -44,14 +49,15 @@ Each notebook can be bound to multiple Interpreter Settings using setting icon o
-## What is Zeppelin Interpreter Group?
+## What is interpreter group?
Every Interpreter is belonged to an **Interpreter Group**. Interpreter Group is a unit of start/stop interpreter.
By default, every interpreter is belonged to a single group, but the group might contain more interpreters. For example, Spark interpreter group is including Spark support, pySpark, SparkSQL and the dependency loader.
Technically, Zeppelin interpreters from the same group are running in the same JVM. For more information about this, please checkout [here](../development/writingzeppelininterpreter.html).
Each interpreters is belonged to a single group and registered together. All of their properties are listed in the interpreter setting like below image.
-<img src="../assets/themes/zeppelin/img/screenshots/interpreter_setting_spark.png">
+
+<img src="../assets/themes/zeppelin/img/screenshots/interpreter_setting_spark.png" width="500px">
## Interpreter binding mode
@@ -62,7 +68,7 @@ In 'shared' mode, every notebook bound to the Interpreter Setting will share the
<img src="../assets/themes/zeppelin/img/screenshots/interpreter_persession.png" width="400px">
-## Connecting to the Existing Remote Interpreter
+## Connecting to the existing remote interpreter
Zeppelin users can start interpreter thread embedded in their service. This will provide flexibility to user to start interpreter on remote host. To start interpreter along with your service you have to create an instance of ``RemoteInterpreterServer`` and start it as follows:
@@ -75,4 +81,4 @@ interpreter.start()
The above code will start interpreter thread inside your process. Once the interpreter is started you can configure zeppelin to connect to RemoteInterpreter by checking **Connect to existing process** checkbox and then provide **Host** and **Port** on which interpreter porocess is listening as shown in the image below:
-<img src="../assets/themes/zeppelin/img/screenshots/existing_interpreter.png" width="400px">
+<img src="../assets/themes/zeppelin/img/screenshots/existing_interpreter.png" width="450px">
http://git-wip-us.apache.org/repos/asf/zeppelin/blob/5975125f/docs/manual/notebookashomepage.md
----------------------------------------------------------------------
diff --git a/docs/manual/notebookashomepage.md b/docs/manual/notebookashomepage.md
index 48f06a6..957e61a 100644
--- a/docs/manual/notebookashomepage.md
+++ b/docs/manual/notebookashomepage.md
@@ -19,91 +19,84 @@ limitations under the License.
-->
{% include JB/setup %}
-## Customize your zeppelin homepage
- Zeppelin allows you to use one of the notebooks you create as your zeppelin Homepage.
- With that you can brand your zeppelin installation,
- adjust the instruction to your users needs and even translate to other languages.
+# Customize Apache Zeppelin homepage
- <br />
-### How to set a notebook as your zeppelin homepage
+<div id="toc"></div>
-The process for creating your homepage is very simple as shown below:
-
- 1. Create a notebook using zeppelin
- 2. Set the notebook id in the config file
- 3. Restart zeppelin
+Apache Zeppelin allows you to use one of the notebooks you create as your Zeppelin Homepage.
+With that you can brand your Zeppelin installation, adjust the instruction to your users needs and even translate to other languages.
- <br />
-#### Create a notebook using zeppelin
- Create a new notebook using zeppelin,
- you can use ```%md``` interpreter for markdown content or any other interpreter you like.
+## How to set a notebook as your Zeppelin homepage
- You can also use the display system to generate [text](../displaysystem/display.html),
- [html](../displaysystem/display.html#html),[table](../displaysystem/table.html) or
- [angular](../displaysystem/angular.html)
+The process for creating your homepage is very simple as shown below:
- Run (shift+Enter) the notebook and see the output. Optionally, change the notebook view to report to hide
- the code sections.
+1. Create a notebook using Zeppelin
+2. Set the notebook id in the config file
+3. Restart Zeppelin
- <br />
-#### Set the notebook id in the config file
- To set the notebook id in the config file you should copy it from the last word in the notebook url
+### Create a notebook using Zeppelin
+Create a new notebook using Zeppelin,
+you can use ```%md``` interpreter for markdown content or any other interpreter you like.
+You can also use the display system to generate [text](../displaysystem/basicdisplaysystem.html#text), [html](../displaysystem/basicdisplaysystem.html#html), [table](../displaysystem/basicdisplaysystem.html#table) or
+Angular ([backend API](../displaysystem/back-end-angular.html), [frontend API](../displaysystem/front-end-angular.html)).
- for example
+Run (shift+Enter) the notebook and see the output. Optionally, change the notebook view to report to hide
+the code sections.
- <img src="/assets/themes/zeppelin/img/screenshots/homepage_notebook_id.png" />
+### Set the notebook id in the config file
+To set the notebook id in the config file, you should copy it from the last word in the notebook url.
+For example,
- Set the notebook id to the ```ZEPPELIN_NOTEBOOK_HOMESCREEN``` environment variable
- or ```zeppelin.notebook.homescreen``` property.
+<img src="/assets/themes/zeppelin/img/screenshots/homepage_notebook_id.png" />
- You can also set the ```ZEPPELIN_NOTEBOOK_HOMESCREEN_HIDE``` environment variable
- or ```zeppelin.notebook.homescreen.hide``` property to hide the new notebook from the notebook list.
+Set the notebook id to the ```ZEPPELIN_NOTEBOOK_HOMESCREEN``` environment variable
+or ```zeppelin.notebook.homescreen``` property.
- <br />
-#### Restart zeppelin
- Restart your zeppelin server
+You can also set the ```ZEPPELIN_NOTEBOOK_HOMESCREEN_HIDE``` environment variable
+or ```zeppelin.notebook.homescreen.hide``` property to hide the new notebook from the notebook list.
- ```
- ./bin/zeppelin-deamon stop
- ./bin/zeppelin-deamon start
- ```
- ####That's it! Open your browser and navigate to zeppelin and see your customized homepage...
+### Restart Zeppelin
+Restart your Zeppelin server
+```
+./bin/zeppelin-deamon stop
+./bin/zeppelin-deamon start
+```
+That's it! Open your browser and navigate to Apache Zeppelin and see your customized homepage.
<br />
-### Show notebooks list in your custom homepage
-If you want to display the list of notebooks on your custom zeppelin homepage all
+## Show notebooks list in your custom homepage
+If you want to display the list of notebooks on your custom Apache Zeppelin homepage all
you need to do is use our %angular support.
- <br />
- Add the following code to a paragraph in you home page and run it... walla! you have your notebooks list.
-
- ```javascript
- println(
- """%angular
- <div class="col-md-4" ng-controller="HomeCtrl as home">
- <h4>Notebooks</h4>
- <div>
- <h5><a href="" data-toggle="modal" data-target="#noteNameModal" style="text-decoration: none;">
- <i style="font-size: 15px;" class="icon-notebook"></i> Create new note</a></h5>
- <ul style="list-style-type: none;">
- <li ng-repeat="note in home.notes.list track by $index"><i style="font-size: 10px;" class="icon-doc"></i>
- <a style="text-decoration: none;" href="#/notebook/{{note.id}}">{{noteName(note)}}</a>
- </li>
- </ul>
- </div>
+Add the following code to a paragraph in you home page and run it... walla! you have your notebooks list.
+
+```javascript
+println(
+"""%angular
+ <div class="col-md-4" ng-controller="HomeCtrl as home">
+ <h4>Notebooks</h4>
+ <div>
+ <h5><a href="" data-toggle="modal" data-target="#noteNameModal" style="text-decoration: none;">
+ <i style="font-size: 15px;" class="icon-notebook"></i> Create new note</a></h5>
+ <ul style="list-style-type: none;">
+ <li ng-repeat="note in home.notes.list track by $index"><i style="font-size: 10px;" class="icon-doc"></i>
+ <a style="text-decoration: none;" href="#/notebook/{{note.id}}">{{noteName(note)}}</a>
+ </li>
+ </ul>
</div>
- """)
- ```
+ </div>
+""")
+```
- After running the notebook you will see output similar to this one:
- <img src="/assets/themes/zeppelin/img/screenshots/homepage_notebook_list.png" />
+After running the notebook you will see output similar to this one:
+<img src="/assets/themes/zeppelin/img/screenshots/homepage_notebook_list.png" />
- The main trick here relays in linking the ```<div>``` to the controller:
+The main trick here relays in linking the ```<div>``` to the controller:
- ```javascript
- <div class="col-md-4" ng-controller="HomeCtrl as home">
- ```
+```javascript
+<div class="col-md-4" ng-controller="HomeCtrl as home">
+```
- Once we have ```home``` as our controller variable in our ```<div></div>```
- we can use ```home.notes.list``` to get access to the notebook list.
+Once we have ```home``` as our controller variable in our ```<div></div>```
+we can use ```home.notes.list``` to get access to the notebook list.
http://git-wip-us.apache.org/repos/asf/zeppelin/blob/5975125f/docs/manual/publish.md
----------------------------------------------------------------------
diff --git a/docs/manual/publish.md b/docs/manual/publish.md
index 1559fba..a6dea0d 100644
--- a/docs/manual/publish.md
+++ b/docs/manual/publish.md
@@ -19,13 +19,14 @@ limitations under the License.
-->
{% include JB/setup %}
-## How can you publish your paragraph ?
-Zeppelin provides a feature for publishing your notebook paragraph results. Using this feature, you can show Zeppelin notebook paragraph results in your own website.
-It's very straightforward. Just use `<iframe>` tag in your page.
+# How can you publish your paragraph ?
+
+<div id="toc"></div>
-> **Warning**: Please use this feature with caution and in a trusted environment only, as Zeppelin entire Webapp could be accessible for whoever visits your website.
+Apache Zeppelin provides a feature for publishing your notebook paragraph results. Using this feature, you can show Zeppelin notebook paragraph results in your own website.
+It's very straightforward. Just use `<iframe>` tag in your page.
-### Copy a Paragraph Link
+## Copy a Paragraph Link
A first step to publish your paragraph result is **Copy a Paragraph Link**.
* After running a paragraph in your Zeppelin notebook, click a gear button located on the right side. Then, click **Link this Paragraph** menu like below image.
@@ -34,7 +35,7 @@ A first step to publish your paragraph result is **Copy a Paragraph Link**.
* Just copy the provided link.
<center><img src="../assets/themes/zeppelin/img/docs-img/copy-the-link.png" height="100%" width="100%"></center>
-### Embed the Paragraph to Your Website
+## Embed the Paragraph to Your Website
For publishing the copied paragraph, you may use `<iframe>` tag in your website page.
For example,
@@ -45,4 +46,4 @@ For example,
Finally, you can show off your beautiful visualization results in your website.
<center><img src="../assets/themes/zeppelin/img/docs-img/your-website.png" height="90%" width="90%"></center>
-> **Note**: To embed the paragraph in a website, Zeppelin needs to be reachable by that website.
+> **Note**: To embed the paragraph in a website, Apache Zeppelin needs to be reachable by that website. And please use this feature with caution and in a trusted environment only, as Zeppelin entire Webapp could be accessible by whoever visits your website.
http://git-wip-us.apache.org/repos/asf/zeppelin/blob/5975125f/docs/quickstart/explorezeppelinui.md
----------------------------------------------------------------------
diff --git a/docs/quickstart/explorezeppelinui.md b/docs/quickstart/explorezeppelinui.md
index b1235d1..9e18907 100644
--- a/docs/quickstart/explorezeppelinui.md
+++ b/docs/quickstart/explorezeppelinui.md
@@ -1,6 +1,6 @@
---
layout: page
-title: "Explore Zeppelin UI"
+title: "Explore Apache Zeppelin UI"
description: "Description of Zeppelin UI Layout"
group: quickstart
---
@@ -17,9 +17,13 @@ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->
-## Home Page
+# Explore Apache Zeppelin UI
-The first time you connect to Zeppelin, you'll land at the main page similar to the below screen capture
+<div id="toc"></div>
+
+## Main home
+
+The first time you connect to Zeppelin, you'll land at the main page similar to the below screen capture.
<img src="../assets/themes/zeppelin/img/ui-img/homepage.png" />
@@ -28,7 +32,7 @@ On the left of the page are listed all existing notes. Those notes are stored by
You can filter them by name using the input text form. You can also create an new note, refresh the list of existing notes
(in case you manually copy them into the `$ZEPPELIN_HOME/notebook` folder) and import a note.
-<img src="../assets/themes/zeppelin/img/ui-img/notes_management.png" />
+<img src="../assets/themes/zeppelin/img/ui-img/notes_management.png" width="230px" />
When clicking on `Import Note` link, a new dialog open. From there you can import your note from local disk or from a remote location
if you provide the URL.
@@ -40,7 +44,7 @@ By default, the name of the imported note is the same as the original note but y
<br />
## Menus
-### 1. Notebook
+### Notebook
The `Notebook` menu proposes almost the same features as the note management section in the home page. From the drop-down menu you can:
@@ -48,9 +52,9 @@ The `Notebook` menu proposes almost the same features as the note management sec
2. Filter node by name
3. Create a new note
-<img src="../assets/themes/zeppelin/img/ui-img/notebook_menu.png" />
+<img src="../assets/themes/zeppelin/img/ui-img/notebook_menu.png" width="170px" />
-### 2. Interpreter
+### Interpreter
In this menu you can:
@@ -59,7 +63,7 @@ In this menu you can:
<img src="../assets/themes/zeppelin/img/ui-img/interpreter_menu.png" />
-### 3. Configuration
+### Configuration
This menu displays all the Zeppelin configuration that are set in the config file `$ZEPPELIN_HOME/conf/zeppelin-site.xml`
@@ -88,7 +92,7 @@ On the top-right corner of each paragraph there are some commands to:
To configure the paragraph, just click on the gear icon:
-<img src="../assets/themes/zeppelin/img/ui-img/paragraph_configuration_dialog.png" />
+<img src="../assets/themes/zeppelin/img/ui-img/paragraph_configuration_dialog.png" width="180px" />
From this dialog, you can (in descending order):
@@ -124,7 +128,7 @@ In the middle of the toolbar you can find the command buttons:
* delete the note
* schedule the execution of **all paragraph** using a CRON syntax
-<img src="../assets/themes/zeppelin/img/ui-img/note_commands.png" />
+<img src="../assets/themes/zeppelin/img/ui-img/note_commands.png" width="300px"/>
On the right of the note tool bar you can find configuration icons:
@@ -133,4 +137,4 @@ On the right of the note tool bar you can find configuration icons:
* configure the note permissions
* switch the node display mode between `default`, `simple` and `report`
-<img src="../assets/themes/zeppelin/img/ui-img/note_configuration.png" />
+<img src="../assets/themes/zeppelin/img/ui-img/note_configuration.png" width="180px"/>
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/zeppelin/blob/5975125f/docs/quickstart/tutorial.md
----------------------------------------------------------------------
diff --git a/docs/quickstart/tutorial.md b/docs/quickstart/tutorial.md
index 7506b74..9333d14 100644
--- a/docs/quickstart/tutorial.md
+++ b/docs/quickstart/tutorial.md
@@ -17,16 +17,17 @@ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->
-## Zeppelin Tutorial
+# Zeppelin Tutorial
+
+<div id="toc"></div>
This tutorial walks you through some of the fundamental Zeppelin concepts. We will assume you have already installed Zeppelin. If not, please see [here](../install/install.html) first.
Current main backend processing engine of Zeppelin is [Apache Spark](https://spark.apache.org). If you're new to this system, you might want to start by getting an idea of how it processes data to get the most out of Zeppelin.
-<br />
## Tutorial with Local File
-### 1. Data Refine
+### Data Refine
Before you start Zeppelin tutorial, you will need to download [bank.zip](http://archive.ics.uci.edu/ml/machine-learning-databases/00222/bank.zip).
@@ -52,7 +53,7 @@ val bank = bankText.map(s=>s.split(";")).filter(s=>s(0)!="\"age\"").map(
bank.toDF().registerTempTable("bank")
```
-### 2. Data Retrieval
+### Data Retrieval
Suppose we want to see age distribution from `bank`. To do this, run:
@@ -75,7 +76,7 @@ Now we want to see age distribution with certain marital status and add combo bo
<br />
## Tutorial with Streaming Data
-### 1. Data Refine
+### Data Refine
Since this tutorial is based on Twitter's sample tweet stream, you must configure authentication with a Twitter account. To do this, take a look at [Twitter Credential Setup](https://databricks-training.s3.amazonaws.com/realtime-processing-with-spark-streaming.html#twitter-credential-setup). After you get API keys, you should fill out credential related values(`apiKey`, `apiSecret`, `accessToken`, `accessTokenSecret`) with your API keys on following script.
@@ -135,7 +136,7 @@ twt.print
ssc.start()
```
-### 2. Data Retrieval
+### Data Retrieval
For each following script, every time you click run button you will see different result since it is based on real-time data.
@@ -192,4 +193,4 @@ To check how people think about girls using `sentiment` function we've made abov
```sql
%sql select sentiment(text), count(1) from tweets where text like '%girl%' group by sentiment(text)
-```
+```
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/zeppelin/blob/5975125f/docs/rest-api/rest-configuration.md
----------------------------------------------------------------------
diff --git a/docs/rest-api/rest-configuration.md b/docs/rest-api/rest-configuration.md
index e445156..4323b6d 100644
--- a/docs/rest-api/rest-configuration.md
+++ b/docs/rest-api/rest-configuration.md
@@ -19,18 +19,22 @@ 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 Configuration 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](../../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).
+
+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).
+nd a need for an additional REST API, please [file an issue or send us mail](../../community.html).
- <br />
## Configuration REST API list
-### List Configurations
+### List all key/value pair of configurations
<table class="table-configuration">
<col width="200">
<tr>
@@ -89,7 +93,7 @@ limitations under the License.
<br/>
-### List Configurations(prefix match)
+### List all prefix matched key/value pair of configurations
<table class="table-configuration">
<col width="200">
<tr>
@@ -128,3 +132,4 @@ limitations under the License.
</td>
</tr>
</table>
+
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/zeppelin/blob/5975125f/docs/rest-api/rest-interpreter.md
----------------------------------------------------------------------
diff --git a/docs/rest-api/rest-interpreter.md b/docs/rest-api/rest-interpreter.md
index 8a80b11..4d7c49d 100644
--- a/docs/rest-api/rest-interpreter.md
+++ b/docs/rest-api/rest-interpreter.md
@@ -19,19 +19,22 @@ 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 Interpreter 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).
+
+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 />
## Interpreter REST API List
- The role of registered interpreters, settings and interpreters group are described in [here](../manual/interpreters.html).
+The role of registered interpreters, settings and interpreters group are described in [here](../manual/interpreters.html).
-### List of Registered Interpreters
+### List of registered interpreters
<table class="table-configuration">
<col width="200">
@@ -102,8 +105,8 @@ limitations under the License.
</table>
<br/>
+### List of registered interpreter settings
-### List of Interpreter Settings
<table class="table-configuration">
<col width="200">
<tr>
@@ -177,7 +180,7 @@ limitations under the License.
</table>
<br/>
-### Create an Interpreter Setting
+### Create a new interpreter setting
<table class="table-configuration">
<col width="200">
@@ -256,10 +259,8 @@ limitations under the License.
</tr>
</table>
-
<br/>
-
-### Update an Interpreter Setting
+### Update an interpreter setting
<table class="table-configuration">
<col width="200">
<tr>
@@ -337,9 +338,8 @@ limitations under the License.
</tr>
</table>
-
<br/>
-### Delete an Interpreter Setting
+### Delete an interpreter setting
<table class="table-configuration">
<col width="200">
@@ -369,7 +369,7 @@ limitations under the License.
<br/>
-### Restart an Interpreter
+### Restart an interpreter
<table class="table-configuration">
<col width="200">
@@ -398,7 +398,7 @@ limitations under the License.
</table>
<br/>
-### Add repository for dependency resolving
+### Add a new repository for dependency resolving
<table class="table-configuration">
<col width="200">
@@ -439,7 +439,7 @@ limitations under the License.
</table>
<br/>
-### Delete repository for dependency resolving
+### Delete a repository for dependency resolving
<table class="table-configuration">
<col width="200">
@@ -460,3 +460,4 @@ limitations under the License.
<td> 500 </td>
</tr>
</table>
+
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/zeppelin/blob/5975125f/docs/rest-api/rest-notebook.md
----------------------------------------------------------------------
diff --git a/docs/rest-api/rest-notebook.md b/docs/rest-api/rest-notebook.md
index c02b529..edbb595 100644
--- a/docs/rest-api/rest-notebook.md
+++ b/docs/rest-api/rest-notebook.md
@@ -19,20 +19,23 @@ 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 Notebook 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](../../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).
+
+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 />
## Notebook REST API List
Notebooks REST API supports the following operations: List, Create, Get, Delete, Clone, Run, Export, Import as detailed in the following tables.
-### List Notebooks
+### List of the notebooks
<table class="table-configuration">
<col width="200">
<tr>
@@ -74,8 +77,7 @@ limitations under the License.
</table>
<br/>
-
-### Create Notebook
+### Create a new notebook
<table class="table-configuration">
<col width="200">
<tr>
@@ -129,8 +131,7 @@ limitations under the License.
</table>
<br/>
-
-### Get Notebook
+### Get an existing notebook information
<table class="table-configuration">
<col width="200">
<tr>
@@ -227,8 +228,7 @@ limitations under the License.
</table>
<br/>
-
-### Delete Notebook
+### Delete a notebook
<table class="table-configuration">
<col width="200">
<tr>
@@ -255,8 +255,7 @@ limitations under the License.
</table>
<br/>
-
-### Clone Notebook
+### Clone a notebook
<table class="table-configuration">
<col width="200">
<tr>
@@ -294,13 +293,12 @@ limitations under the License.
</table>
<br/>
-
-### Run Notebook Job
+### Run all paragraphs
<table class="table-configuration">
<col width="200">
<tr>
<td>Description</td>
- <td>This ```POST``` method runs all paragraph in the given notebook id.
+ <td>This ```POST``` method runs all paragraphs in the given notebook id.
</td>
</tr>
<tr>
@@ -322,13 +320,12 @@ limitations under the License.
</table>
<br/>
-
-### Stop Notebook Job
+### Stop all paragraphs
<table class="table-configuration">
<col width="200">
<tr>
<td>Description</td>
- <td>This ```DELETE``` method stops all paragraph in the given notebook id.
+ <td>This ```DELETE``` method stops all paragraphs in the given notebook id.
</td>
</tr>
<tr>
@@ -350,13 +347,12 @@ limitations under the License.
</table>
<br/>
-
-### Get Notebook Job
+### Get the status of all paragraphs
<table class="table-configuration">
<col width="200">
<tr>
<td>Description</td>
- <td>This ```GET``` method gets all paragraph status by the given notebook id.
+ <td>This ```GET``` method gets the status of all paragraphs by the given notebook id.
The body field of the returned JSON contains of the array that compose of the paragraph id, paragraph status, paragraph finish date, paragraph started date.
</td>
</tr>
@@ -397,8 +393,7 @@ limitations under the License.
</table>
<br/>
-
-### Run Paragraph Job
+### Run a paragraph
<table class="table-configuration">
<col width="200">
<tr>
@@ -436,8 +431,7 @@ limitations under the License.
</table>
<br/>
-
-### Stop Paragraph Job
+### Stop a paragraph
<table class="table-configuration">
<col width="200">
<tr>
@@ -464,7 +458,6 @@ limitations under the License.
</table>
<br/>
-
### Add Cron Job
<table class="table-configuration">
<col width="200">
@@ -553,8 +546,7 @@ limitations under the License.
</table>
<br />
-
-### Full Text Search Through the Paragraphs in All Notebooks
+### Full text search through the paragraphs in all notebooks
<table class="table-configuration">
<col width="200">
<tr>
@@ -592,8 +584,7 @@ limitations under the License.
</table>
<br/>
-
-### Create Paragraph
+### Create a new paragraph
<table class="table-configuration">
<col width="200">
<tr>
@@ -643,8 +634,7 @@ limitations under the License.
</table>
<br/>
-
-### Get Paragraph
+### Get a paragraph information
<table class="table-configuration">
<col width="200">
<tr>
@@ -712,8 +702,7 @@ limitations under the License.
</table>
<br/>
-
-### Move Paragraph
+### Move a paragraph to the specific index
<table class="table-configuration">
<col width="200">
<tr>
@@ -741,8 +730,7 @@ limitations under the License.
<br/>
-
-### Delete Paragraph
+### Delete a paragraph
<table class="table-configuration">
<col width="200">
<tr>
@@ -769,8 +757,7 @@ limitations under the License.
</table>
<br />
-
-### Export Notebook
+### Export a notebook
<table class="table-configuration">
<col width="200">
<tr>
@@ -820,8 +807,7 @@ limitations under the License.
</table>
<br />
-
-### Import Notebook
+### Import a notebook
<table class="table-configuration">
<col width="200">
<tr>
@@ -879,3 +865,4 @@ limitations under the License.
</tr>
</tr>
</table>
+
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/zeppelin/blob/5975125f/docs/security/authentication.md
----------------------------------------------------------------------
diff --git a/docs/security/authentication.md b/docs/security/authentication.md
index e7a793d..7ce160a 100644
--- a/docs/security/authentication.md
+++ b/docs/security/authentication.md
@@ -19,11 +19,12 @@ limitations under the License.
-->
# Authentication for NGINX
-Authentication is company-specific.
+<div id="toc"></div>
-One option is to use [Basic Access Authentication](https://en.wikipedia.org/wiki/Basic_access_authentication)
+Authentication is company-specific.
+One option is to use [Basic Access Authentication](https://en.wikipedia.org/wiki/Basic_access_authentication).
-### HTTP Basic Authentication using NGINX
+## HTTP Basic Authentication using NGINX
> **Quote from Wikipedia:** NGINX is a web server. It can act as a reverse proxy server for HTTP, HTTPS, SMTP, POP3, and IMAP protocols, as well as a load balancer and an HTTP cache.
@@ -39,7 +40,7 @@ This instruction based on Ubuntu 14.04 LTS but may work with other OS with few c
```
$ apt-get install nginx
```
- *Important: On pre 1.3.13 version of NGINX, Proxy for Websocket may not fully works. Please use latest version of NGINX. See: [NGINX documentation](https://www.nginx.com/blog/websocket-nginx/)*
+ > **NOTE :** On pre 1.3.13 version of NGINX, Proxy for Websocket may not fully works. Please use latest version of NGINX. See: [NGINX documentation](https://www.nginx.com/blog/websocket-nginx/).
1. Setup init script in NGINX
@@ -119,12 +120,12 @@ This instruction based on Ubuntu 14.04 LTS but may work with other OS with few c
1. More security consideration
* Using HTTPS connection with Basic Authentication is highly recommended since basic auth without encryption may expose your important credential information over the network.
-* Using [Shiro Security feature built-into Zeppelin](https://github.com/apache/zeppelin/blob/master/SECURITY-README.md) is recommended if you prefer all-in-one solution for authentication but NGINX may provides ad-hoc solution for re-use authentication served by your system's NGINX server or in case of you need to separate authentication from zeppelin server.
+* Using [Shiro Security feature built-into Zeppelin](./shiroauthentication.html) is recommended if you prefer all-in-one solution for authentication but NGINX may provides ad-hoc solution for re-use authentication served by your system's NGINX server or in case of you need to separate authentication from zeppelin server.
* It is recommended to isolate direct connection to Zeppelin server from public internet or external services to secure your zeppelin instance from unexpected attack or problems caused by public zone.
-### Another option
+## Another option
Another option is to have an authentication server that can verify user credentials in an LDAP server.
If an incoming request to the Zeppelin server does not have a cookie with user information encrypted with the authentication server public key, the user
is redirected to the authentication server. Once the user is verified, the authentication server redirects the browser to a specific URL in the Zeppelin server which sets the authentication cookie in the browser.
-The end result is that all requests to the Zeppelin web server have the authentication cookie which contains user and groups information.
+The end result is that all requests to the Zeppelin web server have the authentication cookie which contains user and groups information.
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/zeppelin/blob/5975125f/docs/security/interpreter_authorization.md
----------------------------------------------------------------------
diff --git a/docs/security/interpreter_authorization.md b/docs/security/interpreter_authorization.md
index 3809cd4..6e59e07 100644
--- a/docs/security/interpreter_authorization.md
+++ b/docs/security/interpreter_authorization.md
@@ -19,6 +19,8 @@ limitations under the License.
-->
# Interpreter and Data Source Authorization
+<div id="toc"></div>
+
## Interpreter Authorization
Interpreter authorization involves permissions like creating an interpreter and execution queries using it.
http://git-wip-us.apache.org/repos/asf/zeppelin/blob/5975125f/docs/security/notebook_authorization.md
----------------------------------------------------------------------
diff --git a/docs/security/notebook_authorization.md b/docs/security/notebook_authorization.md
index 7793d4f..8788567 100644
--- a/docs/security/notebook_authorization.md
+++ b/docs/security/notebook_authorization.md
@@ -19,6 +19,9 @@ limitations under the License.
-->
# Zeppelin Notebook Authorization
+<div id="toc"></div>
+
+## Overview
We assume that there is an **Shiro Authentication** component that associates a user string and a set of group strings with every NotebookSocket.
If you don't set the authentication components yet, please check [Shiro authentication for Apache Zeppelin](./shiroauthentication.html) first.
@@ -44,12 +47,12 @@ If someone who doesn't have **read** permission is trying to access the notebook
## How it works
In this section, we will explain the detail about how the notebook authorization works in backend side.
-#### NotebookServer
+### NotebookServer
The [NotebookServer](https://github.com/apache/zeppelin/blob/master/zeppelin-server/src/main/java/org/apache/zeppelin/socket/NotebookServer.java) classifies every notebook operations into three categories: **Read**, **Write**, **Manage**.
Before executing a notebook operation, it checks if the user and the groups associated with the `NotebookSocket` have permissions.
For example, before executing a **Read** operation, it checks if the user and the groups have at least one entity that belongs to the **Reader** entities.
-#### Notebook REST API call
+### Notebook REST API call
Zeppelin executes a [REST API call](https://github.com/apache/zeppelin/blob/master/zeppelin-server/src/main/java/org/apache/zeppelin/rest/NotebookRestApi.java) for the notebook permission information.
In the backend side, Zeppelin gets the user information for the connection and allows the operation if the users and groups
associated with the current user have at least one entity that belongs to owner entities for the notebook.
http://git-wip-us.apache.org/repos/asf/zeppelin/blob/5975125f/docs/security/shiroauthentication.md
----------------------------------------------------------------------
diff --git a/docs/security/shiroauthentication.md b/docs/security/shiroauthentication.md
index 969e2f4..733ff11 100644
--- a/docs/security/shiroauthentication.md
+++ b/docs/security/shiroauthentication.md
@@ -20,6 +20,10 @@ limitations under the License.
{% include JB/setup %}
# Shiro authentication for Apache Zeppelin
+
+<div id="toc"></div>
+
+## Overview
[Apache Shiro](http://shiro.apache.org/) is a powerful and easy-to-use Java security framework that performs authentication, authorization, cryptography, and session management. In this documentation, we will explain step by step how Shiro works for Zeppelin notebook authentication.
When you connect to Apache Zeppelin, you will be asked to enter your credentials. Once you logged in, then you have access to all notes including other user's notes.
@@ -27,28 +31,28 @@ When you connect to Apache Zeppelin, you will be asked to enter your credentials
## Security Setup
You can setup **Zeppelin notebook authentication** in some simple steps.
-####1. Secure the HTTP channel
-To secure the HTTP channel, you have to change both **anon** and **authcBasic** settings in `conf/shiro.ini`. In here, **anon** means "the access is anonymous" and **authcBasic** means "basic auth security".
+### 1. Secure the HTTP channel
+To secure the HTTP channel, you have to change both **anon** and **authc** settings in `conf/shiro.ini`. In here, **anon** means "the access is anonymous" and **authc** means "formed auth security".
The default status of them is
```
/** = anon
-#/** = authcBasic
+#/** = authc
```
-Deactivate the line "/** = anon" and activate the line "/** = authcBasic" in `conf/shiro.ini` file.
+Deactivate the line "/** = anon" and activate the line "/** = authc" in `conf/shiro.ini` file.
```
#/** = anon
-/** = authcBasic
+/** = authc
```
For the further information about `shiro.ini` file format, please refer to [Shiro Configuration](http://shiro.apache.org/configuration.html#Configuration-INISections).
-####2. Secure the Websocket channel
+### 2. Secure the Websocket channel
Set to property **zeppelin.anonymous.allowed** to **false** in `conf/zeppelin-site.xml`. If you don't have this file yet, just copy `conf/zeppelin-site.xml.template` to `conf/zeppelin-site.xml`.
-####3. Start Zeppelin
+### 3. Start Zeppelin
```
bin/zeppelin-daemon.sh start (or restart)
@@ -56,7 +60,7 @@ bin/zeppelin-daemon.sh start (or restart)
Then you can browse Zeppelin at [http://localhost:8080](http://localhost:8080).
-####4. Login
+### 4. Login
Finally, you can login using one of the below **username/password** combinations.
<center><img src="../assets/themes/zeppelin/img/docs-img/zeppelin-login.png"></center>
@@ -67,10 +71,8 @@ user1 = password2
user2 = password3
```
-Those combinations are defined in the `conf/shiro.ini` file.
-
-####5. Groups and permissions (optional)
-In case you want to leverage user groups and permissions, use one of the following configuration for LDAP or AD under `[main]` segment of shiro.ini
+### 5. Groups and permissions (optional)
+In case you want to leverage user groups and permissions, use one of the following configuration for LDAP or AD under `[main]` segment in `shiro.ini`
```
activeDirectoryRealm = org.apache.zeppelin.server.ActiveDirectoryGroupRealm
http://git-wip-us.apache.org/repos/asf/zeppelin/blob/5975125f/docs/storage/storage.md
----------------------------------------------------------------------
diff --git a/docs/storage/storage.md b/docs/storage/storage.md
index 36aae50..19ddd95 100644
--- a/docs/storage/storage.md
+++ b/docs/storage/storage.md
@@ -17,14 +17,19 @@ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->
-## Notebook Storage
+# Notebook storage options for Apache Zeppelin
-Zeppelin has a pluggable notebook storage mechanism controlled by `zeppelin.notebook.storage` configuration option with multiple implementations.
-There are few Notebook storage systems available for a use out of the box:
- - (default) all notes are saved in the notebook folder in your local File System - `VFSNotebookRepo`
- - use local file system and version it using local Git repository - `GitNotebookRepo`
- - storage using Amazon S3 service - `S3NotebookRepo`
- - storage using Azure service - `AzureNotebookRepo`
+<div id="toc"></div>
+
+## Overview
+
+Apache Zeppelin has a pluggable notebook storage mechanism controlled by `zeppelin.notebook.storage` configuration option with multiple implementations.
+There are few notebook storage systems available for a use out of the box:
+
+ * (default) all notes are saved in the notebook folder in your local File System - `VFSNotebookRepo`
+ * use local file system and version it using local Git repository - `GitNotebookRepo`
+ * storage using Amazon S3 service - `S3NotebookRepo`
+ * storage using Azure service - `AzureNotebookRepo`
Multiple storage systems can be used at the same time by providing a comma-separated list of the class-names in the configuration.
By default, only first two of them will be automatically kept in sync by Zeppelin.
@@ -146,8 +151,6 @@ Or using the following setting in **zeppelin-site.xml**:
Using `AzureNotebookRepo` you can connect your Zeppelin with your Azure account for notebook storage.
-</br>
-
First of all, input your `AccountName`, `AccountKey`, and `Share Name` in the file **zeppelin-site.xml** by commenting out and completing the next properties:
```
@@ -233,4 +236,4 @@ export ZEPPELINHUB_API_TOKEN = ZeppelinHub token
export ZEPPELINHUB_API_ADDRESS = address of ZeppelinHub service (e.g. https://www.zeppelinhub.com)
```
-You can get more information on generating `token` and using authentication on the corresponding [help page](http://help.zeppelinhub.com/zeppelin_integration/#add-a-new-zeppelin-instance-and-generate-a-token).
+You can get more information on generating `token` and using authentication on the corresponding [help page](http://help.zeppelinhub.com/zeppelin_integration/#add-a-new-zeppelin-instance-and-generate-a-token).
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/zeppelin/blob/5975125f/licenses/LICENSE-jekyll-table-of-contents
----------------------------------------------------------------------
diff --git a/licenses/LICENSE-jekyll-table-of-contents b/licenses/LICENSE-jekyll-table-of-contents
new file mode 100644
index 0000000..a7bffaf
--- /dev/null
+++ b/licenses/LICENSE-jekyll-table-of-contents
@@ -0,0 +1,19 @@
+Copyright (c) 2013 Alex Ghiculescu
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/zeppelin/blob/5975125f/pom.xml
----------------------------------------------------------------------
diff --git a/pom.xml b/pom.xml
index e10edf4..2b16959 100755
--- a/pom.xml
+++ b/pom.xml
@@ -484,6 +484,9 @@
<!-- bundled from anchor -->
<exclude>docs/assets/themes/zeppelin/js/anchor.min.js</exclude>
+ <!-- bundled from toc -->
+ <exclude>docs/assets/themes/zeppelin/js/toc.js</exclude>
+
<!-- bundled from jekyll -->
<exclude>docs/assets/themes/zeppelin/css/syntax.css</exclude>
[2/2] zeppelin git commit: [ZEPPELIN-1018] Apply auto "Table of
Contents" generator to Zeppelin docs website
Posted by mi...@apache.org.
[ZEPPELIN-1018] Apply auto "Table of Contents" generator to Zeppelin docs website
### What is this PR for?
I added auto TOC(Table of Contents) generator for Zeppelin documentation website. TOC can help people looking through whole contents at a glance and finding what they want quickly.
I just added `<div id="toc"></div>` to the each documentation header. [`toc`](https://github.com/apache/zeppelin/compare/master...AhyoungRyu:ZEPPELIN-1018?expand=1#diff-85af09fb498a5667ea455391533f945dR3) recognize `<h2>` & `<h3>` as a title in the docs and it automatically generate TOC. So I set a rule for this work. (I'll write this rule on `docs/CONTRIBUTING.md` or [docs/howtocontributewebsite](https://zeppelin.apache.org/docs/0.6.0-SNAPSHOT/development/howtocontributewebsite.html)).
```
# Level-1 Heading <- Use only for the main title of the page
## Level-2 Heading <- Start with this one
### Level-3 heading <- Only use this one for child of Level-2
toc only recognize Level-2 & Level-3
```
Please see the below attached screenshot image.
### What type of PR is it?
Improvement & Documentation
### Todos
* [x] - Add TOC generator
* [x] - Apply TOC(`<div id="toc"></div>`) to every documentation and reorganize each headers(apply the above rule)
* [x] - Fix some broken code block in several docs
* [x] - Apply TOC to `r.md` (Currently R docs has some duplicated info since [this one](https://github.com/apache/zeppelin/commit/d5e87fb8ba98f08db5b0a4995104ce19f182c678) and [this one](https://github.com/apache/zeppelin/commit/7d6cc7e99154e2d337c11fdf8be1a874ed3e9ada) )
* [x] - Apply TOC to `install.md` after #1010 merged
* [x] - Apply TOC to `interpreterinstallation.md` after #1042 merged
### What is the Jira issue?
[ZEPPELIN-1018](https://issues.apache.org/jira/browse/ZEPPELIN-1018)
### How should this be tested?
1. Apply this patch and build `docs/` with [this guide](https://github.com/apache/zeppelin/tree/master/docs#build-documentation)
2. Visit some docs page. Then you can see TOC in the header of page.
### Screenshots (if appropriate)
- Automatically generated TOC in Spark interpreter docs page
<img width="831" alt="screen shot 2016-06-16 at 9 37 18 pm" src="https://cloud.githubusercontent.com/assets/10060731/16140902/945b9c7a-340a-11e6-91f3-b6174738bed0.png">
### Questions:
* Does the licenses files need update?
No. Actually I used [jekyll-table-of-contents#copyright](https://github.com/ghiculescu/jekyll-table-of-contents#copyright). But I don't need to add a license for this :)
* Is there breaking changes for older versions? No
* Does this needs documentation? Maybe
Author: AhyoungRyu <fb...@hanmail.net>
Closes #1031 from AhyoungRyu/ZEPPELIN-1018 and squashes the following commits:
e66397b [AhyoungRyu] Apply TOC to interpreterinstallation.md
009579b [AhyoungRyu] Add more info to 'What is the next?' in install.md
04cf501 [AhyoungRyu] Revert 'where to start' section
b7cbe5f [AhyoungRyu] Fix typo
cf0911c [AhyoungRyu] Rename license file
388f35a [AhyoungRyu] Add jekyll-table-of-contents license info
6394c70 [AhyoungRyu] Fix image path in python.md
d00e4b1 [AhyoungRyu] Move interpreter/screenshot/ -> asset/../img/docs-img/
3ffb383 [AhyoungRyu] Remove duplicated info in r.md & apply toc
a03ca99 [AhyoungRyu] Exclude toc.js from pom.xml
3fae7df [AhyoungRyu] Apply auto generated toc to install.md
d114a9d [AhyoungRyu] Address @felixcheung feedback
6a788fe [AhyoungRyu] Resize TOC tab indent
6760c00 [AhyoungRyu] Apply auto TOC to all of docs under docs/storage/
fbde57f [AhyoungRyu] Apply auto TOC to all of docs under docs/quickstart/
db76eb6 [AhyoungRyu] Apply auto TOC to all of docs under docs/install/
f35db47 [AhyoungRyu] Apply auto TOC to all of docs under docs/displaysystem/
b05365f [AhyoungRyu] Apply auto TOC to all of docs under docs/rest-api/
163691c [AhyoungRyu] Apply auto TOC to all of docs under docs/manual/
bef398e [AhyoungRyu] Apply auto TOC to all of docs under docs/development/
9c5f76b [AhyoungRyu] Apply auto TOC to all of docs under docs/interpreter/
587d4ba [AhyoungRyu] Apply auto TOC to all of docs under docs/security/
1f10b97 [AhyoungRyu] Change toc configuration
78dca9e [AhyoungRyu] Add toc.js for auto generating TOC
Project: http://git-wip-us.apache.org/repos/asf/zeppelin/repo
Commit: http://git-wip-us.apache.org/repos/asf/zeppelin/commit/5975125f
Tree: http://git-wip-us.apache.org/repos/asf/zeppelin/tree/5975125f
Diff: http://git-wip-us.apache.org/repos/asf/zeppelin/diff/5975125f
Branch: refs/heads/master
Commit: 5975125f18856c11d129621de1914260158ce0e7
Parents: e1b3847
Author: AhyoungRyu <fb...@hanmail.net>
Authored: Sat Jun 25 12:44:53 2016 -0700
Committer: Mina Lee <mi...@apache.org>
Committed: Sat Jun 25 22:57:44 2016 -0700
----------------------------------------------------------------------
LICENSE | 8 +-
docs/_includes/themes/zeppelin/default.html | 1 +
docs/assets/themes/zeppelin/css/style.css | 14 +++
.../zeppelin/img/docs-img/backtoscala.png | Bin 0 -> 36308 bytes
.../themes/zeppelin/img/docs-img/knitgeo.png | Bin 0 -> 59594 bytes
.../themes/zeppelin/img/docs-img/knitmotion.png | Bin 0 -> 33468 bytes
.../themes/zeppelin/img/docs-img/knitstock.png | Bin 0 -> 108868 bytes
.../zeppelin/img/docs-img/pythonMatplotlib.png | Bin 0 -> 20843 bytes
.../themes/zeppelin/img/docs-img/repl2plus2.png | Bin 0 -> 13143 bytes
.../themes/zeppelin/img/docs-img/replhead.png | Bin 0 -> 42923 bytes
.../themes/zeppelin/img/docs-img/replhist.png | Bin 0 -> 31481 bytes
.../zeppelin/img/docs-img/sparkrfaithful.png | Bin 0 -> 52235 bytes
.../themes/zeppelin/img/docs-img/varr1.png | Bin 0 -> 16703 bytes
.../themes/zeppelin/img/docs-img/varr2.png | Bin 0 -> 18973 bytes
.../themes/zeppelin/img/docs-img/varscala.png | Bin 0 -> 21073 bytes
docs/assets/themes/zeppelin/js/docs.js | 4 +
docs/assets/themes/zeppelin/js/toc.js | 98 +++++++++++++++
docs/development/howtocontribute.md | 25 ++--
docs/development/howtocontributewebsite.md | 41 +++---
docs/development/writingzeppelininterpreter.md | 66 +++++-----
docs/displaysystem/back-end-angular.md | 29 ++---
docs/displaysystem/basicdisplaysystem.md | 4 +
docs/displaysystem/front-end-angular.md | 25 ++--
docs/install/install.md | 28 ++---
docs/install/upgrade.md | 10 +-
docs/install/virtual_machine.md | 28 +++--
docs/interpreter/alluxio.md | 6 +-
docs/interpreter/cassandra.md | 4 +-
docs/interpreter/elasticsearch.md | 6 +-
docs/interpreter/flink.md | 6 +-
docs/interpreter/geode.md | 30 +++--
docs/interpreter/hbase.md | 12 +-
docs/interpreter/hdfs.md | 13 +-
docs/interpreter/hive.md | 10 +-
docs/interpreter/ignite.md | 14 ++-
docs/interpreter/jdbc.md | 57 +++++----
docs/interpreter/lens.md | 12 +-
docs/interpreter/livy.md | 21 ++--
docs/interpreter/markdown.md | 8 +-
docs/interpreter/postgresql.md | 46 +++----
docs/interpreter/python.md | 12 +-
docs/interpreter/r.md | 114 ++++++++---------
docs/interpreter/scalding.md | 19 +--
docs/interpreter/screenshots/backtoscala.png | Bin 36308 -> 0 bytes
docs/interpreter/screenshots/knitgeo.png | Bin 59594 -> 0 bytes
docs/interpreter/screenshots/knitmotion.png | Bin 33468 -> 0 bytes
docs/interpreter/screenshots/knitstock.png | Bin 108868 -> 0 bytes
.../screenshots/pythonMatplotlib.png | Bin 20843 -> 0 bytes
docs/interpreter/screenshots/repl2plus2.png | Bin 13143 -> 0 bytes
docs/interpreter/screenshots/replhead.png | Bin 42923 -> 0 bytes
docs/interpreter/screenshots/replhist.png | Bin 31481 -> 0 bytes
docs/interpreter/screenshots/sparkrfaithful.png | Bin 52235 -> 0 bytes
docs/interpreter/screenshots/varr1.png | Bin 16703 -> 0 bytes
docs/interpreter/screenshots/varr2.png | Bin 18973 -> 0 bytes
docs/interpreter/screenshots/varscala.png | Bin 21073 -> 0 bytes
docs/interpreter/spark.md | 22 ++--
docs/manual/dynamicform.md | 22 ++--
docs/manual/dynamicinterpreterload.md | 25 ++--
docs/manual/interpreterinstallation.md | 2 +
docs/manual/interpreters.md | 22 ++--
docs/manual/notebookashomepage.md | 125 +++++++++----------
docs/manual/publish.md | 15 +--
docs/quickstart/explorezeppelinui.md | 26 ++--
docs/quickstart/tutorial.md | 15 +--
docs/rest-api/rest-configuration.md | 19 +--
docs/rest-api/rest-interpreter.md | 35 +++---
docs/rest-api/rest-notebook.md | 71 +++++------
docs/security/authentication.md | 15 +--
docs/security/interpreter_authorization.md | 2 +
docs/security/notebook_authorization.md | 7 +-
docs/security/shiroauthentication.md | 26 ++--
docs/storage/storage.md | 23 ++--
licenses/LICENSE-jekyll-table-of-contents | 19 +++
pom.xml | 3 +
74 files changed, 745 insertions(+), 520 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/zeppelin/blob/5975125f/LICENSE
----------------------------------------------------------------------
diff --git a/LICENSE b/LICENSE
index 67a5b79..71d3c52 100644
--- a/LICENSE
+++ b/LICENSE
@@ -235,7 +235,13 @@ The text of each license is also included at licenses/LICENSE-[project]-[version
(The MIT License) jekyll-bootstrap 0.3.0 (https://github.com/plusjade/jekyll-bootstrap) - https://github.com/plusjade/jekyll-bootstrap
(The MIT License) jekyll 1.3.0 (http://jekyllrb.com/) - https://github.com/jekyll/jekyll/blob/v1.3.0/LICENSE
-
+========================================================================
+MIT-style licenses
+========================================================================
+The following components are provided under the MIT-style license. See project link for details.
+The text of each license is also included at licenses/LICENSE-[project]-[version].txt.
+
+ (MIT Style) jekyll-table-of-contents (https://github.com/ghiculescu/jekyll-table-of-contents) - https://github.com/ghiculescu/jekyll-table-of-contents/blob/master/LICENSE.txt
========================================================================
Apache licenses
http://git-wip-us.apache.org/repos/asf/zeppelin/blob/5975125f/docs/_includes/themes/zeppelin/default.html
----------------------------------------------------------------------
diff --git a/docs/_includes/themes/zeppelin/default.html b/docs/_includes/themes/zeppelin/default.html
index eb99b9b..cd07602 100644
--- a/docs/_includes/themes/zeppelin/default.html
+++ b/docs/_includes/themes/zeppelin/default.html
@@ -33,6 +33,7 @@
<script src="{{ ASSET_PATH }}/bootstrap/js/bootstrap.min.js"></script>
<script src="{{ ASSET_PATH }}/js/docs.js"></script>
<script src="{{ ASSET_PATH }}/js/anchor.min.js"></script>
+ <script src="{{ ASSET_PATH }}/js/toc.js"></script>
<!-- atom & rss feed -->
<link href="{{ BASE_PATH }}{{ site.JB.atom_path }}" type="application/atom+xml" rel="alternate" title="Sitewide ATOM Feed">
http://git-wip-us.apache.org/repos/asf/zeppelin/blob/5975125f/docs/assets/themes/zeppelin/css/style.css
----------------------------------------------------------------------
diff --git a/docs/assets/themes/zeppelin/css/style.css b/docs/assets/themes/zeppelin/css/style.css
index a5507d3..8ab197c 100644
--- a/docs/assets/themes/zeppelin/css/style.css
+++ b/docs/assets/themes/zeppelin/css/style.css
@@ -545,6 +545,20 @@ a.anchor {
a.anchorjs-link:hover { text-decoration: none; }
+/* Table of Contents(TOC) */
+#toc {
+ padding-top: 12px;
+ padding-bottom: 12px;
+}
+
+#toc ul {
+ margin-left: -14px;
+}
+
+#toc ul ul {
+ margin-left: -18px;
+}
+
/* Custom, iPhone Retina */
@media only screen and (max-width: 480px) {
.jumbotron h1 {
http://git-wip-us.apache.org/repos/asf/zeppelin/blob/5975125f/docs/assets/themes/zeppelin/img/docs-img/backtoscala.png
----------------------------------------------------------------------
diff --git a/docs/assets/themes/zeppelin/img/docs-img/backtoscala.png b/docs/assets/themes/zeppelin/img/docs-img/backtoscala.png
new file mode 100644
index 0000000..c0c897a
Binary files /dev/null and b/docs/assets/themes/zeppelin/img/docs-img/backtoscala.png differ
http://git-wip-us.apache.org/repos/asf/zeppelin/blob/5975125f/docs/assets/themes/zeppelin/img/docs-img/knitgeo.png
----------------------------------------------------------------------
diff --git a/docs/assets/themes/zeppelin/img/docs-img/knitgeo.png b/docs/assets/themes/zeppelin/img/docs-img/knitgeo.png
new file mode 100644
index 0000000..d1eb0d8
Binary files /dev/null and b/docs/assets/themes/zeppelin/img/docs-img/knitgeo.png differ
http://git-wip-us.apache.org/repos/asf/zeppelin/blob/5975125f/docs/assets/themes/zeppelin/img/docs-img/knitmotion.png
----------------------------------------------------------------------
diff --git a/docs/assets/themes/zeppelin/img/docs-img/knitmotion.png b/docs/assets/themes/zeppelin/img/docs-img/knitmotion.png
new file mode 100644
index 0000000..a1048ea
Binary files /dev/null and b/docs/assets/themes/zeppelin/img/docs-img/knitmotion.png differ
http://git-wip-us.apache.org/repos/asf/zeppelin/blob/5975125f/docs/assets/themes/zeppelin/img/docs-img/knitstock.png
----------------------------------------------------------------------
diff --git a/docs/assets/themes/zeppelin/img/docs-img/knitstock.png b/docs/assets/themes/zeppelin/img/docs-img/knitstock.png
new file mode 100644
index 0000000..7a27c60
Binary files /dev/null and b/docs/assets/themes/zeppelin/img/docs-img/knitstock.png differ
http://git-wip-us.apache.org/repos/asf/zeppelin/blob/5975125f/docs/assets/themes/zeppelin/img/docs-img/pythonMatplotlib.png
----------------------------------------------------------------------
diff --git a/docs/assets/themes/zeppelin/img/docs-img/pythonMatplotlib.png b/docs/assets/themes/zeppelin/img/docs-img/pythonMatplotlib.png
new file mode 100644
index 0000000..3d53043
Binary files /dev/null and b/docs/assets/themes/zeppelin/img/docs-img/pythonMatplotlib.png differ
http://git-wip-us.apache.org/repos/asf/zeppelin/blob/5975125f/docs/assets/themes/zeppelin/img/docs-img/repl2plus2.png
----------------------------------------------------------------------
diff --git a/docs/assets/themes/zeppelin/img/docs-img/repl2plus2.png b/docs/assets/themes/zeppelin/img/docs-img/repl2plus2.png
new file mode 100644
index 0000000..8f70092
Binary files /dev/null and b/docs/assets/themes/zeppelin/img/docs-img/repl2plus2.png differ
http://git-wip-us.apache.org/repos/asf/zeppelin/blob/5975125f/docs/assets/themes/zeppelin/img/docs-img/replhead.png
----------------------------------------------------------------------
diff --git a/docs/assets/themes/zeppelin/img/docs-img/replhead.png b/docs/assets/themes/zeppelin/img/docs-img/replhead.png
new file mode 100644
index 0000000..b09ccab
Binary files /dev/null and b/docs/assets/themes/zeppelin/img/docs-img/replhead.png differ
http://git-wip-us.apache.org/repos/asf/zeppelin/blob/5975125f/docs/assets/themes/zeppelin/img/docs-img/replhist.png
----------------------------------------------------------------------
diff --git a/docs/assets/themes/zeppelin/img/docs-img/replhist.png b/docs/assets/themes/zeppelin/img/docs-img/replhist.png
new file mode 100644
index 0000000..5291404
Binary files /dev/null and b/docs/assets/themes/zeppelin/img/docs-img/replhist.png differ
http://git-wip-us.apache.org/repos/asf/zeppelin/blob/5975125f/docs/assets/themes/zeppelin/img/docs-img/sparkrfaithful.png
----------------------------------------------------------------------
diff --git a/docs/assets/themes/zeppelin/img/docs-img/sparkrfaithful.png b/docs/assets/themes/zeppelin/img/docs-img/sparkrfaithful.png
new file mode 100644
index 0000000..ec956c7
Binary files /dev/null and b/docs/assets/themes/zeppelin/img/docs-img/sparkrfaithful.png differ
http://git-wip-us.apache.org/repos/asf/zeppelin/blob/5975125f/docs/assets/themes/zeppelin/img/docs-img/varr1.png
----------------------------------------------------------------------
diff --git a/docs/assets/themes/zeppelin/img/docs-img/varr1.png b/docs/assets/themes/zeppelin/img/docs-img/varr1.png
new file mode 100644
index 0000000..ac997a8
Binary files /dev/null and b/docs/assets/themes/zeppelin/img/docs-img/varr1.png differ
http://git-wip-us.apache.org/repos/asf/zeppelin/blob/5975125f/docs/assets/themes/zeppelin/img/docs-img/varr2.png
----------------------------------------------------------------------
diff --git a/docs/assets/themes/zeppelin/img/docs-img/varr2.png b/docs/assets/themes/zeppelin/img/docs-img/varr2.png
new file mode 100644
index 0000000..b49988d
Binary files /dev/null and b/docs/assets/themes/zeppelin/img/docs-img/varr2.png differ
http://git-wip-us.apache.org/repos/asf/zeppelin/blob/5975125f/docs/assets/themes/zeppelin/img/docs-img/varscala.png
----------------------------------------------------------------------
diff --git a/docs/assets/themes/zeppelin/img/docs-img/varscala.png b/docs/assets/themes/zeppelin/img/docs-img/varscala.png
new file mode 100644
index 0000000..7f95ad2
Binary files /dev/null and b/docs/assets/themes/zeppelin/img/docs-img/varscala.png differ
http://git-wip-us.apache.org/repos/asf/zeppelin/blob/5975125f/docs/assets/themes/zeppelin/js/docs.js
----------------------------------------------------------------------
diff --git a/docs/assets/themes/zeppelin/js/docs.js b/docs/assets/themes/zeppelin/js/docs.js
index 1d2d002..343f6e8 100644
--- a/docs/assets/themes/zeppelin/js/docs.js
+++ b/docs/assets/themes/zeppelin/js/docs.js
@@ -118,6 +118,10 @@ $(function() {
maybeScrollToHash();
});
+ $(document).ready(function() {
+ $('#toc').toc();
+ });
+
// Scroll now too in case we had opened the page on a hash, but wait a bit because some browsers
// will try to do *their* initial scroll after running the onReady handler.
$(window).load(function() { setTimeout(function() { maybeScrollToHash(); }, 25); });
http://git-wip-us.apache.org/repos/asf/zeppelin/blob/5975125f/docs/assets/themes/zeppelin/js/toc.js
----------------------------------------------------------------------
diff --git a/docs/assets/themes/zeppelin/js/toc.js b/docs/assets/themes/zeppelin/js/toc.js
new file mode 100755
index 0000000..8977fff
--- /dev/null
+++ b/docs/assets/themes/zeppelin/js/toc.js
@@ -0,0 +1,98 @@
+// https://github.com/ghiculescu/jekyll-table-of-contents
+(function($){
+ $.fn.toc = function(options) {
+ var defaults = {
+ noBackToTopLinks: false,
+ title: '<i></i>',
+ minimumHeaders: 2,
+ headers: 'h2, h3',
+ listType: 'ul', // values: [ol|ul]
+ showEffect: 'none', // values: [show|slideDown|fadeIn|none]
+ showSpeed: '0', // set to 0 to deactivate effect
+ classes: { list: '',
+ item: ''
+ }
+ },
+ settings = $.extend(defaults, options);
+
+ function fixedEncodeURIComponent (str) {
+ return encodeURIComponent(str).replace(/[!'()*]/g, function(c) {
+ return '%' + c.charCodeAt(0).toString(16);
+ });
+ }
+
+ function createLink (header) {
+ var innerText = (header.textContent === undefined) ? header.innerText : header.textContent;
+ return "<a href='#" + fixedEncodeURIComponent(header.id) + "'>" + innerText + "</a>";
+ }
+
+ var headers = $(settings.headers).filter(function() {
+ // get all headers with an ID
+ var previousSiblingName = $(this).prev().attr( "name" );
+ if (!this.id && previousSiblingName) {
+ this.id = $(this).attr( "id", previousSiblingName.replace(/\./g, "-") );
+ }
+ return this.id;
+ }), output = $(this);
+ if (!headers.length || headers.length < settings.minimumHeaders || !output.length) {
+ $(this).hide();
+ return;
+ }
+
+ if (0 === settings.showSpeed) {
+ settings.showEffect = 'none';
+ }
+
+ var render = {
+ show: function() { output.hide().html(html).show(settings.showSpeed); },
+ slideDown: function() { output.hide().html(html).slideDown(settings.showSpeed); },
+ fadeIn: function() { output.hide().html(html).fadeIn(settings.showSpeed); },
+ none: function() { output.html(html); }
+ };
+
+ var get_level = function(ele) { return parseInt(ele.nodeName.replace("H", ""), 10); };
+ var highest_level = headers.map(function(_, ele) { return get_level(ele); }).get().sort()[0];
+ var return_to_top = '<i class="icon-arrow-up back-to-top"> </i>';
+
+ var level = get_level(headers[0]),
+ this_level,
+ html = settings.title + " <" +settings.listType + " class=\"" + settings.classes.list +"\">";
+ headers.on('click', function() {
+ if (!settings.noBackToTopLinks) {
+ window.location.hash = this.id;
+ }
+ })
+ .addClass('clickable-header')
+ .each(function(_, header) {
+ this_level = get_level(header);
+ if (!settings.noBackToTopLinks && this_level === highest_level) {
+ $(header).addClass('top-level-header').after(return_to_top);
+ }
+ if (this_level === level) // same level as before; same indenting
+ html += "<li class=\"" + settings.classes.item + "\">" + createLink(header);
+ else if (this_level <= level){ // higher level than before; end parent ol
+ for(i = this_level; i < level; i++) {
+ html += "</li></"+settings.listType+">"
+ }
+ html += "<li class=\"" + settings.classes.item + "\">" + createLink(header);
+ }
+ else if (this_level > level) { // lower level than before; expand the previous to contain a ol
+ for(i = this_level; i > level; i--) {
+ html += "<" + settings.listType + " class=\"" + settings.classes.list +"\">" +
+ "<li class=\"" + settings.classes.item + "\">"
+ }
+ html += createLink(header);
+ }
+ level = this_level; // update for the next one
+ });
+ html += "</"+settings.listType+">";
+ if (!settings.noBackToTopLinks) {
+ $(document).on('click', '.back-to-top', function() {
+ $(window).scrollTop(0);
+ window.location.hash = '';
+ });
+ }
+
+ render[settings.showEffect]();
+ };
+})(jQuery);
http://git-wip-us.apache.org/repos/asf/zeppelin/blob/5975125f/docs/development/howtocontribute.md
----------------------------------------------------------------------
diff --git a/docs/development/howtocontribute.md b/docs/development/howtocontribute.md
index 7b3ee0c..2d3842a 100644
--- a/docs/development/howtocontribute.md
+++ b/docs/development/howtocontribute.md
@@ -7,8 +7,9 @@ group: development
# Contributing to Apache Zeppelin ( Code )
-## IMPORTANT
-Apache Zeppelin is an [Apache2 License](http://www.apache.org/licenses/LICENSE-2.0.html) Software.
+<div id="toc"></div>
+
+> **NOTE :** Apache Zeppelin is an [Apache2 License](http://www.apache.org/licenses/LICENSE-2.0.html) Software.
Any contributions to Zeppelin (Source code, Documents, Image, Website) means you agree with license all your contributions as Apache2 License.
## Setting up
@@ -22,7 +23,7 @@ Since Zeppelin uses Git for it's SCM system, you need git client installed in yo
You are free to use whatever IDE you prefer, or your favorite command line editor.
-### Build Tools
+#### Build Tools
To build the code, install
@@ -46,10 +47,10 @@ You may also want to develop against a specific branch. For example, for branch-
git clone -b branch-0.5.6 git://git.apache.org/zeppelin.git zeppelin
```
-#### Fork repository
-If you want not only build Zeppelin but also make any changes, then you need fork [Zeppelin github mirror repository](https://github.com/apache/zeppelin) and make a pull request.
+Apache Zeppelin follows [Fork & Pull](https://github.com/sevntu-checkstyle/sevntu.checkstyle/wiki/Development-workflow-with-Git:-Fork,-Branching,-Commits,-and-Pull-Request) as a source control workflow.
+If you want to not only build Zeppelin but also make any changes, then you need to fork [Zeppelin github mirror repository](https://github.com/apache/zeppelin) and make a pull request.
-###Build
+### Build
```
mvn install
@@ -67,6 +68,8 @@ To build with specific spark / hadoop version
mvn install -Dspark.version=x.x.x -Dhadoop.version=x.x.x
```
+For the further
+
### Run Zeppelin server in development mode
```
@@ -88,21 +91,19 @@ Server will be run on [http://localhost:8080](http://localhost:8080).
Some portions of the Zeppelin code are generated by [Thrift](http://thrift.apache.org). 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.
-To regenerate the code, install **thrift-0.9.0** and change directory into Zeppelin source directory. and then run following command
+To regenerate the code, install **thrift-0.9.2** and change directory into Zeppelin source directory. and then run following command
```
thrift -out zeppelin-interpreter/src/main/java/ --gen java zeppelin-interpreter/src/main/thrift/RemoteInterpreterService.thrift
```
-
-## JIRA
-Zeppelin manages its issues in Jira. [https://issues.apache.org/jira/browse/ZEPPELIN](https://issues.apache.org/jira/browse/ZEPPELIN)
-
## Where to Start
-You can find issues for [beginner](https://issues.apache.org/jira/browse/ZEPPELIN-924?jql=project%20%3D%20ZEPPELIN%20and%20status%20%3D%20Open%20and%20labels%20in%20\(beginner%2C%20newbie\)).
+You can find issues for <a href="https://issues.apache.org/jira/browse/ZEPPELIN-981?jql=project%20%3D%20ZEPPELIN%20AND%20labels%20in%20(beginner%2C%20newbie)">beginner & newbie</a>
## Stay involved
Contributors should join the Zeppelin mailing lists.
* [dev@zeppelin.apache.org](http://mail-archives.apache.org/mod_mbox/zeppelin-dev/) is for people who want to contribute code to Zeppelin. [subscribe](mailto:dev-subscribe@zeppelin.apache.org?subject=send this email to subscribe), [unsubscribe](mailto:dev-unsubscribe@zeppelin.apache.org?subject=send this email to unsubscribe), [archives](http://mail-archives.apache.org/mod_mbox/zeppelin-dev/)
+
+If you have any issues, create a ticket in [JIRA](https://issues.apache.org/jira/browse/ZEPPELIN).
http://git-wip-us.apache.org/repos/asf/zeppelin/blob/5975125f/docs/development/howtocontributewebsite.md
----------------------------------------------------------------------
diff --git a/docs/development/howtocontributewebsite.md b/docs/development/howtocontributewebsite.md
index f56b8e3..0db1555 100644
--- a/docs/development/howtocontributewebsite.md
+++ b/docs/development/howtocontributewebsite.md
@@ -7,49 +7,52 @@ group: development
# Contributing to Apache Zeppelin ( Website )
-## IMPORTANT
-Apache Zeppelin is an [Apache2 License](http://www.apache.org/licenses/LICENSE-2.0.html) Software.
-Any contribution to Zeppelin (Source code, Documents, Image, Website) means you agree license all your contributions as Apache2 License.
+<div id="toc"></div>
-## Modifying the website
+This page will give you an overview of how to build and contribute to the documentation of Apache Zeppelin.
+The online documentation at [zeppelin.apache.org](https://zeppelin.apache.org/docs/latest/) is also generated from the files found here.
-#### Getting the source code
-Website is hosted in 'master' branch under `/docs/` dir.
+> **NOTE :** Apache Zeppelin is an [Apache2 License](http://www.apache.org/licenses/LICENSE-2.0.html) Software.
+Any contributions to Zeppelin (Source code, Documents, Image, Website) means you agree with license all your contributions as Apache2 License.
-First of all, you need the website source code. The official location of mirror for Zeppelin is [http://git.apache.org/zeppelin.git](http://git.apache.org/zeppelin.git).
+## Getting the source code
+First of all, you need Zeppelin source code. The official location of Zeppelin is [http://git.apache.org/zeppelin.git](http://git.apache.org/zeppelin.git).
+Documentation website is hosted in 'master' branch under `/docs/` dir.
+
+### git access
+First of all, you need the website source code. The official location of mirror for Zeppelin is [http://git.apache.org/zeppelin.git](http://git.apache.org/zeppelin.git).
Get the source code on your development machine using git.
```
git clone git://git.apache.org/zeppelin.git
cd docs
```
+Apache Zeppelin follows [Fork & Pull](https://github.com/sevntu-checkstyle/sevntu.checkstyle/wiki/Development-workflow-with-Git:-Fork,-Branching,-Commits,-and-Pull-Request) as a source control workflow.
+If you want to not only build Zeppelin but also make any changes, then you need to fork [Zeppelin github mirror repository](https://github.com/apache/zeppelin) and make a pull request.
-#### Build
-
-To build, you'll need to install some prerequisites. Please check 'Build documentation' section in [docs/README.md](https://github.com/apache/zeppelin/blob/master/docs/README.md#build-documentation).
+### Build
-#### Run website in development mode
+You'll need to install some prerequisites to build the code. Please check [Build documentation](https://github.com/apache/zeppelin/blob/master/docs/README.md#build-documentation) section in [docs/README.md](https://github.com/apache/zeppelin/blob/master/docs/README.md).
-While you're modifying website, you'll want to see preview of it. Please check 'Run website' section in [docs/README.md](https://github.com/apache/zeppelin/blob/master/docs/README.md#run-website).
+### Run website in development mode
-You'll be able to access it on [http://localhost:4000](http://localhost:4000) with your web browser.
+While you're modifying website, you might want to see preview of it. Please check [Run website](https://github.com/apache/zeppelin/blob/master/docs/README.md#run-website) section in [docs/README.md](https://github.com/apache/zeppelin/blob/master/docs/README.md).
+Then you'll be able to access it on [http://localhost:4000](http://localhost:4000) with your web browser.
-#### Making a Pull Request
+### Making a Pull Request
When you are ready, just make a pull-request.
## Alternative way
-You can directly edit .md files in `/docs/` dir at github's web interface and make pull-request immediatly.
-
-
-## JIRA
-Zeppelin manages its issues in Jira. [https://issues.apache.org/jira/browse/ZEPPELIN](https://issues.apache.org/jira/browse/ZEPPELIN)
+You can directly edit `.md` files in `/docs/` directory at the web interface of github and make pull-request immediatly.
## Stay involved
Contributors should join the Zeppelin mailing lists.
* [dev@zeppelin.apache.org](http://mail-archives.apache.org/mod_mbox/zeppelin-dev/) is for people who want to contribute code to Zeppelin. [subscribe](mailto:dev-subscribe@zeppelin.apache.org?subject=send this email to subscribe), [unsubscribe](mailto:dev-unsubscribe@zeppelin.apache.org?subject=send this email to unsubscribe), [archives](http://mail-archives.apache.org/mod_mbox/zeppelin-dev/)
+
+If you have any issues, create a ticket in [JIRA](https://issues.apache.org/jira/browse/ZEPPELIN).
http://git-wip-us.apache.org/repos/asf/zeppelin/blob/5975125f/docs/development/writingzeppelininterpreter.md
----------------------------------------------------------------------
diff --git a/docs/development/writingzeppelininterpreter.md b/docs/development/writingzeppelininterpreter.md
index f341211..7e7f4ef 100644
--- a/docs/development/writingzeppelininterpreter.md
+++ b/docs/development/writingzeppelininterpreter.md
@@ -19,21 +19,25 @@ limitations under the License.
-->
{% include JB/setup %}
-### What is Zeppelin Interpreter
+# Writing a New Interpreter
-Zeppelin Interpreter is a language backend. For example to use scala code in Zeppelin, you need scala interpreter.
-Every Interpreter belongs to an InterpreterGroup.
+<div id="toc"></div>
+
+## What is Apache Zeppelin Interpreter
+
+Apache Zeppelin Interpreter is a language backend. For example to use scala code in Zeppelin, you need a scala interpreter.
+Every Interpreters belongs to an **InterpreterGroup**.
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" />
-InterpreterSetting is configuration of a given InterpreterGroup and a unit of start/stop interpreter.
-All Interpreters in the same InterpreterSetting are launched in a single, separate JVM process. The Interpreter communicates with Zeppelin engine via thrift.
+[InterpreterSetting](https://github.com/apache/zeppelin/blob/master/zeppelin-zengine/src/main/java/org/apache/zeppelin/interpreter/InterpreterSetting.java) is configuration of a given [InterpreterGroup](https://github.com/apache/zeppelin/blob/master/zeppelin-interpreter/src/main/java/org/apache/zeppelin/interpreter/InterpreterGroup.java) and a unit of start/stop interpreter.
+All Interpreters in the same InterpreterSetting are launched in a single, separate JVM process. The Interpreter communicates with Zeppelin engine via **[Thrift](https://github.com/apache/zeppelin/blob/master/zeppelin-interpreter/src/main/thrift/RemoteInterpreterService.thrift)**.
-In 'Separate Interpreter for each note' mode, new Interpreter instance will be created per notebook. But it still runs on the same JVM while they're in the same InterpreterSettings.
+In 'Separate Interpreter(scoped / isolated) for each note' mode which you can see at the **Interpreter Setting** menu when you create a new interpreter, new interpreter instance will be created per notebook. But it still runs on the same JVM while they're in the same InterpreterSettings.
-### Make your own Interpreter
+## Make your own Interpreter
Creating a new interpreter is quite simple. Just extend [org.apache.zeppelin.interpreter](https://github.com/apache/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. And you should your jars under your interpreter directory with specific directory name. Zeppelin server reads interpreter directories recursively and initializes interpreters including your own interpreter.
@@ -91,18 +95,18 @@ The name of the interpreter is what you later write to identify a paragraph whic
some interpreter specific code...
```
-### Programming Languages for Interpreter
+## Programming Languages for Interpreter
If the interpreter uses a specific programming language ( like Scala, Python, SQL ), it is generally recommended to add a syntax highlighting supported for that to the notebook paragraph editor.
To check out the list of languages supported, see the `mode-*.js` files under `zeppelin-web/bower_components/ace-builds/src-noconflict` or from [github.com/ajaxorg/ace-builds](https://github.com/ajaxorg/ace-builds/tree/master/src-noconflict).
If you want to add a new set of syntax highlighting,
-1. Add the `mode-*.js` file to `zeppelin-web/bower.json` ( when built, `zeppelin-web/src/index.html` will be changed automatically. ).
-2. Add to the list of `editorMode` in `zeppelin-web/src/app/notebook/paragraph/paragraph.controller.js` - it follows the pattern 'ace/mode/x' where x is the name.
-3. Add to the code that checks for `%` prefix and calls `session.setMode(editorMode.x)` in `setParagraphMode` located in `zeppelin-web/src/app/notebook/paragraph/paragraph.controller.js`.
+1. Add the `mode-*.js` file to <code>[zeppelin-web/bower.json](https://github.com/apache/zeppelin/blob/master/zeppelin-web/bower.json)</code> ( when built, <code>[zeppelin-web/src/index.html](https://github.com/apache/zeppelin/blob/master/zeppelin-web/src/index.html)</code> will be changed automatically. ).
+2. Add to the list of `editorMode` in <code>[zeppelin-web/src/app/notebook/paragraph/paragraph.controller.js](https://github.com/apache/zeppelin/blob/master/zeppelin-web/src/app/notebook/paragraph/paragraph.controller.js)</code> - it follows the pattern 'ace/mode/x' where x is the name.
+3. Add to the code that checks for `%` prefix and calls `session.setMode(editorMode.x)` in `setParagraphMode` located in <code>[zeppelin-web/src/app/notebook/paragraph/paragraph.controller.js](https://github.com/apache/zeppelin/blob/master/zeppelin-web/src/app/notebook/paragraph/paragraph.controller.js)</code>.
-### Install your interpreter binary
+## Install your interpreter binary
Once you have built your interpreter, you can place it under the interpreter directory with all its dependencies.
@@ -110,7 +114,7 @@ Once you have built your interpreter, you can place it under the interpreter dir
[ZEPPELIN_HOME]/interpreter/[INTERPRETER_NAME]/
```
-### Configure your interpreter
+## Configure your interpreter
To configure your interpreter you need to follow these steps:
@@ -119,12 +123,12 @@ To configure your interpreter you need to follow these steps:
Property value is comma separated [INTERPRETER\_CLASS\_NAME].
For example,
-```
-<property>
- <name>zeppelin.interpreters</name>
- <value>org.apache.zeppelin.spark.SparkInterpreter,org.apache.zeppelin.spark.PySparkInterpreter,org.apache.zeppelin.spark.SparkSqlInterpreter,org.apache.zeppelin.spark.DepInterpreter,org.apache.zeppelin.markdown.Markdown,org.apache.zeppelin.shell.ShellInterpreter,org.apache.zeppelin.hive.HiveInterpreter,com.me.MyNewInterpreter</value>
-</property>
-```
+ ```
+ <property>
+ <name>zeppelin.interpreters</name>
+ <value>org.apache.zeppelin.spark.SparkInterpreter,org.apache.zeppelin.spark.PySparkInterpreter,org.apache.zeppelin.spark.SparkSqlInterpreter,org.apache.zeppelin.spark.DepInterpreter,org.apache.zeppelin.markdown.Markdown,org.apache.zeppelin.shell.ShellInterpreter,org.apache.zeppelin.hive.HiveInterpreter,com.me.MyNewInterpreter</value>
+ </property>
+ ```
2. Add your interpreter to the [default configuration](https://github.com/apache/zeppelin/blob/master/zeppelin-zengine/src/main/java/org/apache/zeppelin/conf/ZeppelinConfiguration.java#L397) which is used when there is no `zeppelin-site.xml`.
@@ -133,11 +137,11 @@ To configure your interpreter you need to follow these steps:
4. In the interpreter page, click the `+Create` button and configure your interpreter properties.
Now you are done and ready to use your interpreter.
-Note that the interpreters released with zeppelin have a [default configuration](https://github.com/apache/zeppelin/blob/master/zeppelin-zengine/src/main/java/org/apache/zeppelin/conf/ZeppelinConfiguration.java#L397) which is used when there is no `conf/zeppelin-site.xml`.
+> **Note :** Interpreters released with zeppelin have a [default configuration](https://github.com/apache/zeppelin/blob/master/zeppelin-zengine/src/main/java/org/apache/zeppelin/conf/ZeppelinConfiguration.java#L397) which is used when there is no `conf/zeppelin-site.xml`.
-### Use your interpreter
+## Use your interpreter
-#### 0.5.0
+### 0.5.0
Inside of a notebook, `%[INTERPRETER_NAME]` directive will call your interpreter.
Note that the first interpreter configuration in zeppelin.interpreters will be the default one.
@@ -150,8 +154,7 @@ val a = "My interpreter"
println(a)
```
-<br />
-#### 0.6.0 and later
+### 0.6.0 and later
Inside of a notebook, `%[INTERPRETER_GROUP].[INTERPRETER_NAME]` directive will call your interpreter.
Note that the first interpreter configuration in zeppelin.interpreters will be the default one.
@@ -192,7 +195,7 @@ You can only omit your interpreter group when your interpreter group is selected
codes for myintp2
```
-### Examples
+## Examples
Checkout some interpreters released with Zeppelin by default.
@@ -201,15 +204,16 @@ Checkout some interpreters released with Zeppelin by default.
- [shell](https://github.com/apache/zeppelin/tree/master/shell)
- [jdbc](https://github.com/apache/zeppelin/tree/master/jdbc)
-### Contributing a new Interpreter to Zeppelin releases
+## Contributing a new Interpreter to Zeppelin releases
We welcome contribution to a new interpreter. Please follow these few steps:
- - First, check out the general contribution guide [here](./howtocontributewebsite.html).
- - Follow the steps in "Make your own Interpreter" section above.
- - Add your interpreter as in the "Configure your interpreter" section above; also add it to the example template [zeppelin-site.xml.template](https://github.com/apache/zeppelin/blob/master/conf/zeppelin-site.xml.template).
- - Add tests! They are run by Travis for all changes and it is important that they are self-contained.
+ - First, check out the general contribution guide [here](https://github.com/apache/zeppelin/blob/master/CONTRIBUTING.md).
+ - Follow the steps in [Make your own Interpreter](#make-your-own-interpreter) section above.
+ - Add your interpreter as in the [Configure your interpreter](#configure-your-interpreter) section above; also add it to the example template [zeppelin-site.xml.template](https://github.com/apache/zeppelin/blob/master/conf/zeppelin-site.xml.template).
+ - Add tests! They are run by [Travis](https://travis-ci.org/apache/zeppelin) for all changes and it is important that they are self-contained.
- Include your interpreter as a module in [`pom.xml`](https://github.com/apache/zeppelin/blob/master/pom.xml).
- Add documentation on how to use your interpreter under `docs/interpreter/`. Follow the Markdown style as this [example](https://github.com/apache/zeppelin/blob/master/docs/interpreter/elasticsearch.md). Make sure you list config settings and provide working examples on using your interpreter in code boxes in Markdown. Link to images as appropriate (images should go to `docs/assets/themes/zeppelin/img/docs-img/`). And add a link to your documentation in the navigation menu (`docs/_includes/themes/zeppelin/_navigation.html`).
- Most importantly, ensure licenses of the transitive closure of all dependencies are list in [license file](https://github.com/apache/zeppelin/blob/master/zeppelin-distribution/src/bin_license/LICENSE).
- - Commit your changes and open a Pull Request on the project [Mirror on GitHub](https://github.com/apache/zeppelin); check to make sure Travis CI build is passing.
+ - Commit your changes and open a [Pull Request](https://github.com/apache/zeppelin/pulls) on the project [Mirror on GitHub](https://github.com/apache/zeppelin); check to make sure Travis CI build is passing.
+
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/zeppelin/blob/5975125f/docs/displaysystem/back-end-angular.md
----------------------------------------------------------------------
diff --git a/docs/displaysystem/back-end-angular.md b/docs/displaysystem/back-end-angular.md
index 4a06a08..d84a033 100644
--- a/docs/displaysystem/back-end-angular.md
+++ b/docs/displaysystem/back-end-angular.md
@@ -19,15 +19,17 @@ limitations under the License.
-->
{% include JB/setup %}
+# Back-end Angular API in Apache Zeppelin
-## Back-end Angular API in Zeppelin
+<div id="toc"></div>
-Angular display system treats output as a view template for [AngularJS](https://angularjs.org/).
-It compiles templates and displays them inside of Zeppelin.
+## Overview
-Zeppelin provides a gateway between your interpreter and your compiled **AngularJS view** templates.
+Angular display system treats output as a view template for [AngularJS](https://angularjs.org/).
+It compiles templates and displays them inside of Apache Zeppelin. Zeppelin provides a gateway between your interpreter and your compiled **AngularJS view** templates.
Therefore, you can not only update scope variables from your interpreter but also watch them in the interpreter, which is JVM process.
+## Basic Usage
### Print AngularJS view
To use angular display system, you should start with `%angular`.
@@ -94,30 +96,25 @@ When the button is clicked, you'll see both `run` and `numWatched` are increment
## Let's make it Simpler and more Intuitive
In this section, we will introduce a simpler and more intuitive way of using **Angular Display System** in Zeppelin.
-### How can we use it?
Here are some usages.
-#### Import
-
-##### - In notebook scope
+### Import
```scala
+// In notebook scope
import org.apache.zeppelin.display.angular.notebookscope._
import AngularElem._
-```
-##### - In paragraph scope
-```scala
+// In paragraph scope
import org.apache.zeppelin.display.angular.paragraphscope._
import AngularElem._
```
-
-#### Display Element
+### Display Element
```scala
// automatically convert to string and print with %angular display system directive in front.
<div><div>.display
```
-#### Event Handler
+### Event Handler
```scala
// on click
<div></div>.onClick(() => {
@@ -135,7 +132,7 @@ import AngularElem._
}).display
```
-#### Bind Model
+### Bind Model
```scala
// bind model
<div></div>.model("myModel").display
@@ -144,7 +141,7 @@ import AngularElem._
<div></div>.model("myModel", initialValue).display
```
-#### Interact with Model
+### Interact with Model
```scala
// read model
AngularModel("myModel")()
http://git-wip-us.apache.org/repos/asf/zeppelin/blob/5975125f/docs/displaysystem/basicdisplaysystem.md
----------------------------------------------------------------------
diff --git a/docs/displaysystem/basicdisplaysystem.md b/docs/displaysystem/basicdisplaysystem.md
index 3821f1d..732408d 100644
--- a/docs/displaysystem/basicdisplaysystem.md
+++ b/docs/displaysystem/basicdisplaysystem.md
@@ -19,6 +19,10 @@ limitations under the License.
-->
{% include JB/setup %}
+# Basic Display System in Apache Zeppelin
+
+<div id="toc"></div>
+
## Text
By default, Apache Zeppelin prints interpreter responce as a plain text using `text` display system.
http://git-wip-us.apache.org/repos/asf/zeppelin/blob/5975125f/docs/displaysystem/front-end-angular.md
----------------------------------------------------------------------
diff --git a/docs/displaysystem/front-end-angular.md b/docs/displaysystem/front-end-angular.md
index c78b1b4..773b067 100644
--- a/docs/displaysystem/front-end-angular.md
+++ b/docs/displaysystem/front-end-angular.md
@@ -19,18 +19,18 @@ limitations under the License.
-->
{% include JB/setup %}
+# Front-end Angular API in Apache Zeppelin
-## Front-end Angular API in Zeppelin
+<div id="toc"></div>
-In addition to the back-end API to handle Angular objects binding, Zeppelin also exposes a simple AngularJS **`z`** object on the front-end side to expose the same capabilities.
+## Basic Usage
+In addition to the [back-end API](./back-end-angular.html) to handle Angular objects binding, Apache Zeppelin also exposes a simple AngularJS <code>**z**</code> object on the front-end side to expose the same capabilities.
+This <code>**z**</code> object is accessible in the Angular isolated scope for each paragraph.
-This **`z`** object is accessible in the Angular isolated scope for each paragraph.
-<br />
### Bind / Unbind Variables
-Through the **`z`**, you can bind / unbind variables to **AngularJS view**
-
+Through the **`z`**, you can bind / unbind variables to **AngularJS view**.
Bind a value to an angular object and a **mandatory** target paragraph:
```html
@@ -68,9 +68,10 @@ Unbind/remove a value from angular object and a **mandatory** target paragraph:
The signature for the **`z.angularBind() / z.angularUnbind()`** functions are:
```javascript
-
+// Bind
z.angularBind(angularObjectName, angularObjectValue, paragraphId);
+// Unbind
z.angularUnbind(angularObjectName, angularObjectValue, paragraphId);
```
@@ -100,24 +101,24 @@ You can also trigger paragraph execution by calling **`z.runParagraph()`** funct
<img src="../assets/themes/zeppelin/img/screenshots/z_runParagraph.gif" />
<br />
-### Overriding dynamic form with Angular Object
+## Overriding dynamic form with Angular Object
The front-end Angular Interaction API has been designed to offer richer form capabilities and variable binding. With the existing **Dynamic Form** system you can already create input text, select and checkbox forms but the choice is rather limited and the look & feel cannot be changed.
The idea is to create a custom form using plain HTML/AngularJS code and bind actions on this form to push/remove Angular variables to targeted paragraphs using this new API.
-Consequently if you use the **Dynamic Form** syntax in a paragraph and there is a bound Angular object having the same name as the _${formName}_, the Angular object will have higher priority and the **Dynamic Form** will not be displayed. Example:
+Consequently if you use the **Dynamic Form** syntax in a paragraph and there is a bound Angular object having the same name as the `${formName}`, the Angular object will have higher priority and the **Dynamic Form** will not be displayed. Example:
<img src="../assets/themes/zeppelin/img/screenshots/z_angularJs_overriding_dynamic_form.gif" />
<br />
-### Feature matrix comparison
+## Feature matrix comparison
-How does the front-end AngularJS API compares to the back-end API ? Below is a comparison matrix for both APIs:
+How does the front-end AngularJS API compares to the [back-end API](./back-end-angular.html) ? Below is a comparison matrix for both APIs:
-<table>
+<table class="table-configuration">
<thead>
<tr>
<th>Actions</th>
http://git-wip-us.apache.org/repos/asf/zeppelin/blob/5975125f/docs/install/install.md
----------------------------------------------------------------------
diff --git a/docs/install/install.md b/docs/install/install.md
index 55741dc..bcc93da 100644
--- a/docs/install/install.md
+++ b/docs/install/install.md
@@ -23,15 +23,7 @@ limitations under the License.
Welcome to your first trial to explore Apache Zeppelin!
This page will help you to get started and here is the list of topics covered.
-* [Installation](#installation)
- * [Downloading Binary Package](#downloading-binary-package)
- * [Building from Source](#building-from-source)
-* [Starting Apache Zeppelin with Command Line](#starting-apache-zeppelin-with-command-line)
- * [Start Zeppelin](#start-zeppelin)
- * [Stop Zeppelin](#stop-zeppelin)
- * [(Optional) Start Apache Zeppelin with a service manager](#optional-start-apache-zeppelin-with-a-service-manager)
-* [What is the next?](#what-is-the-next)
-* [Apache Zeppelin Configuration](#apache-zeppelin-configuration)
+<div id="toc"></div>
## Installation
@@ -52,7 +44,7 @@ Apache Zeppelin officially supports and is tested on next environments.
</tr>
</table>
-There are two options to install Apache Zeppelin on your machine. One is [downloading prebuild binary package](#downloading-binary-package) from the archive.
+There are two options to install Apache Zeppelin on your machine. One is [downloading pre-built binary package](#downloading-binary-package) from the archive.
You can download not only the latest stable version but also the older one if you need.
The other option is [building from the source](#building-from-source).
Although it can be unstable somehow since it is on development status, you can explore newly added feature and change it as you want.
@@ -181,10 +173,18 @@ exec bin/zeppelin-daemon.sh upstart
## What is the next?
Congratulation on your successful Apache Zeppelin installation! Here are two next steps you might need.
- * For an in-depth overview of Apache Zeppelin UI, head to [Explore Apache Zeppelin UI](../quickstart/explorezeppelinui.html)
- * After getting familiar with Apache Zeppelin UI, have fun with a short walk-through [Tutorial](../quickstart/tutorial.html) that uses Apache Spark backend
- * If you need more configuration setting for Apache Zeppelin, jump to the next section: [Apache Zeppelin Configuration](#apache-zeppelin-configuration)
-
+#### If you are new to Apache Zeppelin
+ * For an in-depth overview of Apache Zeppelin UI, head to [Explore Apache Zeppelin UI](../quickstart/explorezeppelinui.html).
+ * After getting familiar with Apache Zeppelin UI, have fun with a short walk-through [Tutorial](../quickstart/tutorial.html) that uses Apache Spark backend.
+ * If you need more configuration setting for Apache Zeppelin, jump to the next section: [Apache Zeppelin Configuration](#apache-zeppelin-configuration).
+
+#### If you need more information about Spark or JDBC interpreter setting
+ * Apache Zeppelin provides deep integration with [Apache Spark](http://spark.apache.org/). For the further informtation, see [Spark Interpreter for Apache Zeppelin](../interpreter/spark.html).
+ * Also, you can use generic JDBC connections in Apache Zeppelin. Go to [Generic JDBC Interpreter for Apache Zeppelin](../interpreter/jdbc.html).
+
+#### If you are in multi-user environment
+ * You can set permissions for your notebooks and secure data resource in multi-user environment. Go to **More** -> **Security** section.
+
## Apache Zeppelin Configuration
You can configure Apache Zeppelin with both **environment variables** in `conf/zeppelin-env.sh` (`conf\zeppelin-env.cmd` for Windows) and **Java properties** in `conf/zeppelin-site.xml`. If both are defined, then the **environment variables** will take priority.
http://git-wip-us.apache.org/repos/asf/zeppelin/blob/5975125f/docs/install/upgrade.md
----------------------------------------------------------------------
diff --git a/docs/install/upgrade.md b/docs/install/upgrade.md
index 21d44c2..a831eb9 100644
--- a/docs/install/upgrade.md
+++ b/docs/install/upgrade.md
@@ -19,12 +19,14 @@ limitations under the License.
-->
{% include JB/setup %}
-## Manual upgrade procedure for Zeppelin
+# Manual upgrade procedure for Zeppelin
+
+<div id="toc"></div>
Basically, newer version of Zeppelin works with previous version notebook directory and configurations.
So, copying `notebook` and `conf` directory should be enough.
-### Instructions
+## Instructions
1. Stop Zeppelin
```
@@ -33,7 +35,7 @@ So, copying `notebook` and `conf` directory should be enough.
1. Copy your `notebook` and `conf` directory into a backup directory
-1. Download newer version of Zeppelin and Install. See [Install page](./install.html)
+1. Download newer version of Zeppelin and Install. See [Install page](./install.html#installation).
1. Copy backup `notebook` and `conf` directory into newer version of Zeppelin `notebook` and `conf` directory
@@ -41,4 +43,4 @@ So, copying `notebook` and `conf` directory should be enough.
```
bin/zeppelin-daemon.sh start
- ```
+ ```
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/zeppelin/blob/5975125f/docs/install/virtual_machine.md
----------------------------------------------------------------------
diff --git a/docs/install/virtual_machine.md b/docs/install/virtual_machine.md
index 7849ff1..7360183 100644
--- a/docs/install/virtual_machine.md
+++ b/docs/install/virtual_machine.md
@@ -19,8 +19,11 @@ limitations under the License.
-->
{% include JB/setup %}
+# Vagrant Virtual Machine for Apache Zeppelin
-## Vagrant Virtual Machine for Apache Zeppelin
+<div id="toc"></div>
+
+## Overview
Apache Zeppelin distribution includes a scripts directory
@@ -30,11 +33,11 @@ This script creates a virtual machine that launches a repeatable, known set of c
For PySpark users, this script includes several helpful [Python Libraries](#python-extras).
For SparkR users, this script includes several helpful [R Libraries](#r-extras).
-####Installing the required components to launch a virtual machine.
+### Prerequisites
This script requires three applications, [Ansible](http://docs.ansible.com/ansible/intro_installation.html#latest-releases-via-pip "Ansible"), [Vagrant](http://www.vagrantup.com "Vagrant") and [Virtual Box](https://www.virtualbox.org/ "Virtual Box"). All of these applications are freely available as Open Source projects and extremely easy to set up on most operating systems.
-### Create a Zeppelin Ready VM in 4 Steps (5 on Windows)
+## Create a Zeppelin Ready VM
If you are running Windows and don't yet have python installed, [install Python 2.7.x](https://www.python.org/downloads/release/python-2710/) first.
@@ -60,9 +63,15 @@ curl -fsSL https://raw.githubusercontent.com/NFLabs/z-manager/master/zeppelin-in
```
-### Building Zeppelin
+## Building Zeppelin
+
+You can now
-You can now `git clone git://git.apache.org/zeppelin.git` into a directory on your host machine, or directly in your virtual machine.
+```
+git clone git://git.apache.org/zeppelin.git
+```
+
+into a directory on your host machine, or directly in your virtual machine.
Cloning Zeppelin into the `/scripts/vagrant/zeppelin-dev` directory from the host, will allow the directory to be shared between your host and the guest machine.
@@ -74,14 +83,13 @@ By default, Vagrant will share your project directory (the directory with the Va
`cd /vagrant/zeppelin`
-### What's in this VM?
+## What's in this VM?
Running the following commands in the guest machine should display these expected versions:
`node --version` should report *v0.12.7*
`mvn --version` should report *Apache Maven 3.3.3* and *Java version: 1.7.0_85*
-
The virtual machine consists of:
- Ubuntu Server 14.04 LTS
@@ -96,7 +104,7 @@ The virtual machine consists of:
- Python addons: pip, matplotlib, scipy, numpy, pandas
- [R](https://www.r-project.org/) and R Packages required to run the R Interpreter and the related R tutorial notebook, including: Knitr, devtools, repr, rCharts, ggplot2, googleVis, mplot, htmltools, base64enc, data.table
-### How to build & run Zeppelin
+## How to build & run Zeppelin
This assumes you've already cloned the project either on the host machine in the zeppelin-dev directory (to be shared with the guest machine) or cloned directly into a directory while running inside the guest machine. The following build steps will also include Python and R support via PySpark and SparkR:
@@ -111,7 +119,7 @@ On your host machine browse to `http://localhost:8080/`
If you [turned off port forwarding](#tweaking-the-virtual-machine) in the `Vagrantfile` browse to `http://192.168.51.52:8080`
-### Tweaking the Virtual Machine
+## Tweaking the Virtual Machine
If you plan to run this virtual machine along side other Vagrant images, you may wish to bind the virtual machine to a specific IP address, and not use port fowarding from your local host.
@@ -125,7 +133,7 @@ config.vm.network "private_network", ip: "192.168.51.52"
`vagrant halt` followed by `vagrant up` will restart the guest machine bound to the IP address of `192.168.51.52`.
This approach usually is typically required if running other virtual machines that discover each other directly by IP address, such as Spark Masters and Slaves as well as Cassandra Nodes, Elasticsearch Nodes, and other Spark data sources. You may wish to launch nodes in virtual machines with IP addresses in a subnet that works for your local network, such as: 192.168.51.53, 192.168.51.54, 192.168.51.53, etc..
-
+## Extras
### Python Extras
With Zeppelin running, **Numpy**, **SciPy**, **Pandas** and **Matplotlib** will be available. Create a pyspark notebook, and try the below code.
http://git-wip-us.apache.org/repos/asf/zeppelin/blob/5975125f/docs/interpreter/alluxio.md
----------------------------------------------------------------------
diff --git a/docs/interpreter/alluxio.md b/docs/interpreter/alluxio.md
index 332dd0d..c8ecf93 100644
--- a/docs/interpreter/alluxio.md
+++ b/docs/interpreter/alluxio.md
@@ -6,7 +6,11 @@ group: manual
---
{% include JB/setup %}
-## Alluxio Interpreter for Apache Zeppelin
+# Alluxio Interpreter for Apache Zeppelin
+
+<div id="toc"></div>
+
+## Overview
[Alluxio](http://alluxio.org/) is a memory-centric distributed storage system enabling reliable data sharing at memory-speed across cluster frameworks.
## Configuration
http://git-wip-us.apache.org/repos/asf/zeppelin/blob/5975125f/docs/interpreter/cassandra.md
----------------------------------------------------------------------
diff --git a/docs/interpreter/cassandra.md b/docs/interpreter/cassandra.md
index 2091666..33cff19 100644
--- a/docs/interpreter/cassandra.md
+++ b/docs/interpreter/cassandra.md
@@ -6,7 +6,9 @@ group: manual
---
{% include JB/setup %}
-## Cassandra CQL Interpreter for Apache Zeppelin
+# Cassandra CQL Interpreter for Apache Zeppelin
+
+<div id="toc"></div>
<table class="table-configuration">
<tr>
http://git-wip-us.apache.org/repos/asf/zeppelin/blob/5975125f/docs/interpreter/elasticsearch.md
----------------------------------------------------------------------
diff --git a/docs/interpreter/elasticsearch.md b/docs/interpreter/elasticsearch.md
index 70af3c0..4721bcd 100644
--- a/docs/interpreter/elasticsearch.md
+++ b/docs/interpreter/elasticsearch.md
@@ -6,7 +6,11 @@ group: manual
---
{% include JB/setup %}
-## Elasticsearch Interpreter for Apache Zeppelin
+# Elasticsearch Interpreter for Apache Zeppelin
+
+<div id="toc"></div>
+
+## Overview
[Elasticsearch](https://www.elastic.co/products/elasticsearch) is a highly scalable open-source full-text search and analytics engine. It allows you to store, search, and analyze big volumes of data quickly and in near real time. It is generally used as the underlying engine/technology that powers applications that have complex search features and requirements.
## Configuration
http://git-wip-us.apache.org/repos/asf/zeppelin/blob/5975125f/docs/interpreter/flink.md
----------------------------------------------------------------------
diff --git a/docs/interpreter/flink.md b/docs/interpreter/flink.md
index 9d2f0b0..a678480 100644
--- a/docs/interpreter/flink.md
+++ b/docs/interpreter/flink.md
@@ -6,7 +6,11 @@ group: manual
---
{% include JB/setup %}
-## Flink interpreter for Apache Zeppelin
+# Flink interpreter for Apache Zeppelin
+
+<div id="toc"></div>
+
+## Overview
[Apache Flink](https://flink.apache.org) is an open source platform for distributed stream and batch data processing. Flink\u2019s core is a streaming dataflow engine that provides data distribution, communication, and fault tolerance for distributed computations over data streams. Flink also builds batch processing on top of the streaming engine, overlaying native iteration support, managed memory, and program optimization.
## How to start local Flink cluster, to test the interpreter
http://git-wip-us.apache.org/repos/asf/zeppelin/blob/5975125f/docs/interpreter/geode.md
----------------------------------------------------------------------
diff --git a/docs/interpreter/geode.md b/docs/interpreter/geode.md
index 53a912e..84a026e 100644
--- a/docs/interpreter/geode.md
+++ b/docs/interpreter/geode.md
@@ -6,7 +6,11 @@ group: manual
---
{% include JB/setup %}
-## Geode/Gemfire OQL Interpreter for Apache Zeppelin
+# Geode/Gemfire OQL Interpreter for Apache Zeppelin
+
+<div id="toc"></div>
+
+## Overview
<table class="table-configuration">
<tr>
<th>Name</th>
@@ -33,7 +37,7 @@ This interpreter supports the [Geode](http://geode.incubator.apache.org/) [Objec
This [Video Tutorial](https://www.youtube.com/watch?v=zvzzA9GXu3Q) illustrates some of the features provided by the `Geode Interpreter`.
-### Create Interpreter
+## Create Interpreter
By default Zeppelin creates one `Geode/OQL` instance. You can remove it or create more instances.
Multiple Geode instances can be created, each configured to the same or different backend Geode cluster. But over time a `Notebook` can have only one Geode interpreter instance `bound`. That means you _cannot_ connect to different Geode clusters in the same `Notebook`. This is a known Zeppelin limitation.
@@ -42,10 +46,10 @@ To create new Geode instance open the `Interpreter` section and click the `+Crea
> Note: The `Name` of the instance is used only to distinguish the instances while binding them to the `Notebook`. The `Name` is irrelevant inside the `Notebook`. In the `Notebook` you must use `%geode.oql` tag.
-### Bind to Notebook
+## Bind to Notebook
In the `Notebook` click on the `settings` icon in the top right corner. The select/deselect the interpreters to be bound with the `Notebook`.
-### Configuration
+## Configuration
You can modify the configuration of the Geode from the `Interpreter` section. The Geode interpreter expresses the following properties:
<table class="table-configuration">
@@ -71,12 +75,12 @@ You can modify the configuration of the Geode from the `Interpreter` section. T
</tr>
</table>
-### How to use
+## How to use
> *Tip 1: Use (CTRL + .) for OQL auto-completion.*
> *Tip 2: Always start the paragraphs with the full `%geode.oql` prefix tag! The short notation: `%geode` would still be able run the OQL queries but the syntax highlighting and the auto-completions will be disabled.*
-#### Create / Destroy Regions
+### Create / Destroy Regions
The OQL specification does not support [Geode Regions](https://cwiki.apache.org/confluence/display/GEODE/Index#Index-MainConceptsandComponents) mutation operations. To `create`/`destroy` regions one should use the [GFSH](http://geode-docs.cfapps.io/docs/tools_modules/gfsh/chapter_overview.html) shell tool instead. In the following it is assumed that the GFSH is colocated with Zeppelin server.
```bash
@@ -97,7 +101,7 @@ EOF
Above snippet re-creates two regions: `regionEmployee` and `regionCompany`. Note that you have to explicitly specify the locator host and port. The values should match those you have used in the Geode Interpreter configuration. Comprehensive list of [GFSH Commands by Functional Area](http://geode-docs.cfapps.io/docs/tools_modules/gfsh/gfsh_quick_reference.html).
-#### Basic OQL
+### Basic OQL
```sql
%geode.oql
SELECT count(*) FROM /regionEmployee
@@ -136,7 +140,7 @@ SELECT e.key, e.value FROM /regionEmployee.entrySet e
> Note: You can have multiple queries in the same paragraph but only the result from the first is displayed. [[1](https://issues.apache.org/jira/browse/ZEPPELIN-178)], [[2](https://issues.apache.org/jira/browse/ZEPPELIN-212)].
-#### GFSH Commands From The Shell
+### GFSH Commands From The Shell
Use the Shell Interpreter (`%sh`) to run OQL commands form the command line:
```bash
@@ -145,7 +149,7 @@ source /etc/geode/conf/geode-env.sh
gfsh -e "connect" -e "list members"
```
-#### Apply Zeppelin Dynamic Forms
+### Apply Zeppelin Dynamic Forms
You can leverage [Zeppelin Dynamic Form](../manual/dynamicform.html) inside your OQL queries. You can use both the `text input` and `select form` parameterization features
```sql
@@ -153,7 +157,10 @@ You can leverage [Zeppelin Dynamic Form](../manual/dynamicform.html) inside your
SELECT * FROM /regionEmployee e WHERE e.employeeId > ${Id}
```
-#### Geode REST API
+### Auto-completion
+The Geode Interpreter provides a basic auto-completion functionality. On `(Ctrl+.)` it list the most relevant suggestions in a pop-up window.
+
+## Geode REST API
To list the defined regions you can use the [Geode REST API](http://geode-docs.cfapps.io/docs/geode_rest/chapter_overview.html):
```
@@ -182,6 +189,3 @@ http://<geode server hostname>phd1.localdomain:8484/gemfire-api/v1/
http-service-port=8484
start-dev-rest-api=true
```
-
-### Auto-completion
-The Geode Interpreter provides a basic auto-completion functionality. On `(Ctrl+.)` it list the most relevant suggestions in a pop-up window.
http://git-wip-us.apache.org/repos/asf/zeppelin/blob/5975125f/docs/interpreter/hbase.md
----------------------------------------------------------------------
diff --git a/docs/interpreter/hbase.md b/docs/interpreter/hbase.md
index 2eaa915..1aeb77b 100644
--- a/docs/interpreter/hbase.md
+++ b/docs/interpreter/hbase.md
@@ -6,16 +6,22 @@ group: manual
---
{% include JB/setup %}
-## HBase Shell Interpreter for Apache Zeppelin
+# HBase Shell Interpreter for Apache Zeppelin
+
+<div id="toc"></div>
+
+## Overview
[HBase Shell](http://hbase.apache.org/book.html#shell) is a JRuby IRB client for Apache HBase. This interpreter provides all capabilities of Apache HBase shell within Apache Zeppelin. The interpreter assumes that Apache HBase client software has been installed and it can connect to the Apache HBase cluster from the machine on where Apache Zeppelin is installed.
-To get start with HBase, please see [HBase Quickstart](https://hbase.apache.org/book.html#quickstart)
+To get start with HBase, please see [HBase Quickstart](https://hbase.apache.org/book.html#quickstart).
## HBase release supported
By default, Zeppelin is built against HBase 1.0.x releases. To work with HBase 1.1.x releases, use the following build command:
+
```bash
# HBase 1.1.4
mvn clean package -DskipTests -Phadoop-2.6 -Dhadoop.version=2.6.0 -P build-distr -Dhbase.hbase.version=1.1.4 -Dhbase.hadoop.version=2.6.0
```
+
To work with HBase 1.2.0+, use the following build command:
```bash
@@ -94,4 +100,4 @@ And then to put data into that table
put 'test', 'row1', 'cf:a', 'value1'
```
-For more information on all commands available, refer to [HBase shell commands](https://learnhbase.wordpress.com/2013/03/02/hbase-shell-commands/)
+For more information on all commands available, refer to [HBase shell commands](https://learnhbase.wordpress.com/2013/03/02/hbase-shell-commands/).
http://git-wip-us.apache.org/repos/asf/zeppelin/blob/5975125f/docs/interpreter/hdfs.md
----------------------------------------------------------------------
diff --git a/docs/interpreter/hdfs.md b/docs/interpreter/hdfs.md
index 58d825d..7cde31a 100644
--- a/docs/interpreter/hdfs.md
+++ b/docs/interpreter/hdfs.md
@@ -6,8 +6,11 @@ group: manual
---
{% include JB/setup %}
-## HDFS File System Interpreter for Apache Zeppelin
+# HDFS File System Interpreter for Apache Zeppelin
+<div id="toc"></div>
+
+## Overview
[Hadoop File System](http://hadoop.apache.org/) is a distributed, fault tolerant file system part of the hadoop project and is often used as storage for distributed processing engines like [Hadoop MapReduce](http://hadoop.apache.org/) and [Apache Spark](http://spark.apache.org/) or underlying file systems like [Alluxio](http://www.alluxio.org/).
## Configuration
@@ -44,13 +47,17 @@ It supports the basic shell file commands applied to HDFS, it currently only sup
> **Tip :** Use ( Ctrl + . ) for autocompletion.
-### Create Interpreter
+## Create Interpreter
In a notebook, to enable the **HDFS** interpreter, click the **Gear** icon and select **HDFS**.
-#### WebHDFS REST API
+## WebHDFS REST API
You can confirm that you're able to access the WebHDFS API by running a curl command against the WebHDFS end point provided to the interpreter.
Here is an example:
+
+```bash
$> curl "http://localhost:50070/webhdfs/v1/?op=LISTSTATUS"
+```
+
http://git-wip-us.apache.org/repos/asf/zeppelin/blob/5975125f/docs/interpreter/hive.md
----------------------------------------------------------------------
diff --git a/docs/interpreter/hive.md b/docs/interpreter/hive.md
index 2fc365c..a1fc4e1 100644
--- a/docs/interpreter/hive.md
+++ b/docs/interpreter/hive.md
@@ -6,8 +6,9 @@ group: manual
---
{% include JB/setup %}
-## Hive Interpreter for Apache Zeppelin
-The [Apache Hive](https://hive.apache.org/) \u2122 data warehouse software facilitates querying and managing large datasets residing in distributed storage. Hive provides a mechanism to project structure onto this data and query the data using a SQL-like language called HiveQL. At the same time this language also allows traditional map/reduce programmers to plug in their custom mappers and reducers when it is inconvenient or inefficient to express this logic in HiveQL.
+# Hive Interpreter for Apache Zeppelin
+
+<div id="toc"></div>
## Important Notice
Hive Interpreter will be deprecated and merged into JDBC Interpreter. You can use Hive Interpreter by using JDBC Interpreter with same functionality. See the example below of settings and dependencies.
@@ -52,7 +53,6 @@ Hive Interpreter will be deprecated and merged into JDBC Interpreter. You can us
</tr>
</table>
-----
### Configuration
<table class="table-configuration">
@@ -115,6 +115,10 @@ Hive Interpreter will be deprecated and merged into JDBC Interpreter. You can us
This interpreter provides multiple configuration with `${prefix}`. User can set a multiple connection properties by this prefix. It can be used like `%hive(${prefix})`.
+## Overview
+
+The [Apache Hive](https://hive.apache.org/) \u2122 data warehouse software facilitates querying and managing large datasets residing in distributed storage. Hive provides a mechanism to project structure onto this data and query the data using a SQL-like language called HiveQL. At the same time this language also allows traditional map/reduce programmers to plug in their custom mappers and reducers when it is inconvenient or inefficient to express this logic in HiveQL.
+
## How to use
Basically, you can use
http://git-wip-us.apache.org/repos/asf/zeppelin/blob/5975125f/docs/interpreter/ignite.md
----------------------------------------------------------------------
diff --git a/docs/interpreter/ignite.md b/docs/interpreter/ignite.md
index 6bc20ab..8a25fd7 100644
--- a/docs/interpreter/ignite.md
+++ b/docs/interpreter/ignite.md
@@ -6,16 +6,18 @@ group: manual
---
{% include JB/setup %}
-## Ignite Interpreter for Apache Zeppelin
+# Ignite Interpreter for Apache Zeppelin
-### Overview
+<div id="toc"></div>
+
+## Overview
[Apache Ignite](https://ignite.apache.org/) In-Memory Data Fabric is a high-performance, integrated and distributed in-memory platform for computing and transacting on large-scale data sets in real-time, orders of magnitude faster than possible with traditional disk-based or flash technologies.
You can use Zeppelin to retrieve distributed data from cache using Ignite SQL interpreter. Moreover, Ignite interpreter allows you to execute any Scala code in cases when SQL doesn't fit to your requirements. For example, you can populate data into your caches or execute distributed computations.
-### Installing and Running Ignite example
+## Installing and Running Ignite example
In order to use Ignite interpreters, you may install Apache Ignite in some simple steps:
1. Download Ignite [source release](https://ignite.apache.org/download.html#sources) or [binary release](https://ignite.apache.org/download.html#binaries) whatever you want. But you must download Ignite as the same version of Zeppelin's. If it is not, you can't use scala code on Zeppelin. You can find ignite version in Zeppelin at the pom.xml which is placed under `path/to/your-Zeppelin/ignite/pom.xml` ( Of course, in Zeppelin source release ). Please check `ignite.version` .<br>Currently, Zeppelin provides ignite only in Zeppelin source release. So, if you download Zeppelin binary release( `zeppelin-0.5.0-incubating-bin-spark-xxx-hadoop-xx` ), you can not use ignite interpreter on Zeppelin. We are planning to include ignite in a future binary release.
@@ -31,7 +33,7 @@ In order to use Ignite interpreters, you may install Apache Ignite in some simpl
$ nohup java -jar </path/to/your Jar file name>
```
-### Configuring Ignite Interpreter
+## Configuring Ignite Interpreter
At the "Interpreters" menu, you may edit Ignite interpreter or create new one. Zeppelin provides these properties for Ignite.
<table class="table-configuration">
@@ -69,14 +71,14 @@ At the "Interpreters" menu, you may edit Ignite interpreter or create new one. Z
-### Interpreter Binding for Zeppelin Notebook
+## How to use
After configuring Ignite interpreter, create your own notebook. Then you can bind interpreters like below image.
For more interpreter binding information see [here](http://zeppelin.apache.org/docs/manual/interpreters.html).
-### How to use Ignite SQL interpreter
+### Ignite SQL interpreter
In order to execute SQL query, use ` %ignite.ignitesql ` prefix. <br>
Supposing you are running `org.apache.ignite.examples.streaming.wordcount.StreamWords`, then you can use "words" cache( Of course you have to specify this cache name to the Ignite interpreter setting section `ignite.jdbc.url` of Zeppelin ).
For example, you can select top 10 words in the words cache using the following query
http://git-wip-us.apache.org/repos/asf/zeppelin/blob/5975125f/docs/interpreter/jdbc.md
----------------------------------------------------------------------
diff --git a/docs/interpreter/jdbc.md b/docs/interpreter/jdbc.md
index c4eef98..830dd97 100644
--- a/docs/interpreter/jdbc.md
+++ b/docs/interpreter/jdbc.md
@@ -7,7 +7,11 @@ group: manual
{% include JB/setup %}
-## Generic JDBC Interpreter for Apache Zeppelin
+# Generic JDBC Interpreter for Apache Zeppelin
+
+<div id="toc"></div>
+
+## Overview
This interpreter lets you create a JDBC connection to any data source, by now it has been tested with:
@@ -16,16 +20,14 @@ This interpreter lets you create a JDBC connection to any data source, by now it
* MariaDB
* Redshift
* Apache Hive
-* Apache Drill
- * Details on using [Drill JDBC Driver](https://drill.apache.org/docs/using-the-jdbc-driver)
* Apache Phoenix
-* Apache Tajo
+* Apache Drill (Details on using [Drill JDBC Driver](https://drill.apache.org/docs/using-the-jdbc-driverde* Apache Tajo
If someone else used another database please report how it works to improve functionality.
-### Create Interpreter
+## Create Interpreter
-When create a interpreter by default use PostgreSQL with the next properties:
+When you create a interpreter by default use PostgreSQL with the next properties:
<table class="table-configuration">
<tr>
@@ -56,7 +58,7 @@ When create a interpreter by default use PostgreSQL with the next properties:
It is not necessary to add driver jar to the classpath for PostgreSQL as it is included in Zeppelin.
-#### Simple connection
+### Simple connection
Prior to creating the interpreter it is necessary to add maven coordinate or path of the JDBC driver to the Zeppelin classpath. To do this you must edit dependencies artifact(ex. `mysql:mysql-connector-java:5.1.38`) in interpreter menu as shown:
@@ -95,7 +97,7 @@ To create the interpreter you need to specify connection parameters as shown in
</tr>
</table>
-#### Multiple connections
+### Multiple connections
JDBC interpreter also allows connections to multiple data sources. It is necessary to set a prefix for each connection to reference it in the paragraph in the form of `%jdbc(prefix)`. Before you create the interpreter it is necessary to add each driver's maven coordinates or JDBC driver's jar file path to the Zeppelin classpath. To do this you must edit the dependencies of JDBC interpreter in interpreter menu as following:
@@ -151,10 +153,10 @@ You can add all the jars you need to make multiple connections into the same JDB
</table>
-### Bind to Notebook
+## Bind to Notebook
In the `Notebook` click on the `settings` icon at the top-right corner. Use select/deselect to specify the interpreters to be used in the `Notebook`.
-### More Properties
+## More Properties
You can modify the interpreter configuration in the `Interpreter` section. The most common properties are as follows, but you can specify other properties that need to be connected.
<table class="table-configuration">
@@ -197,9 +199,11 @@ To develop this functionality use this [method](http://docs.oracle.com/javase/7/
</tr>
</table>
-### Examples
-#### Hive
-##### Properties
+## Examples
+
+### Hive
+
+#### Properties
<table class="table-configuration">
<tr>
<th>Name</th>
@@ -222,7 +226,8 @@ To develop this functionality use this [method](http://docs.oracle.com/javase/7/
<td>hive_password</td>
</tr>
</table>
-##### Dependencies
+
+#### Dependencies
<table class="table-configuration">
<tr>
<th>Artifact</th>
@@ -237,8 +242,9 @@ To develop this functionality use this [method](http://docs.oracle.com/javase/7/
<td></td>
</tr>
</table>
-#### Phoenix
-##### Properties
+
+### Phoenix
+#### Properties
<table class="table-configuration">
<tr>
<th>Name</th>
@@ -261,7 +267,7 @@ To develop this functionality use this [method](http://docs.oracle.com/javase/7/
<td>phoenix_password</td>
</tr>
</table>
-##### Dependencies
+#### Dependencies
<table class="table-configuration">
<tr>
<th>Artifact</th>
@@ -272,8 +278,9 @@ To develop this functionality use this [method](http://docs.oracle.com/javase/7/
<td></td>
</tr>
</table>
-#### Tajo
-##### Properties
+
+### Tajo
+#### Properties
<table class="table-configuration">
<tr>
<th>Name</th>
@@ -288,7 +295,8 @@ To develop this functionality use this [method](http://docs.oracle.com/javase/7/
<td>jdbc:tajo://localhost:26002/default</td>
</tr>
</table>
-##### Dependencies
+
+#### Dependencies
<table class="table-configuration">
<tr>
<th>Artifact</th>
@@ -300,9 +308,9 @@ To develop this functionality use this [method](http://docs.oracle.com/javase/7/
</tr>
</table>
-### How to use
+## How to use
-#### Reference in paragraph
+### Reference in paragraph
Start the paragraphs with the `%jdbc`, this will use the `default` prefix for connection. If you want to use other connection you should specify the prefix of it as follows `%jdbc(prefix)`:
@@ -311,6 +319,7 @@ Start the paragraphs with the `%jdbc`, this will use the `default` prefix for co
SELECT * FROM db_name;
```
+
or
```sql
@@ -319,7 +328,7 @@ SELECT * FROM db_name;
```
-#### Apply Zeppelin Dynamic Forms
+### Apply Zeppelin Dynamic Forms
You can leverage [Zeppelin Dynamic Form](../manual/dynamicform.html) inside your queries. You can use both the `text input` and `select form` parametrization features
@@ -330,5 +339,5 @@ FROM demo.performers
WHERE name='{{performer=Sheryl Crow|Doof|Fanfarlo|Los Paranoia}}'
```
-### Bugs & Contacts
+## Bugs & Reporting
If you find a bug for this interpreter, please create a [JIRA]( https://issues.apache.org/jira/browse/ZEPPELIN-382?jql=project%20%3D%20ZEPPELIN) ticket.
http://git-wip-us.apache.org/repos/asf/zeppelin/blob/5975125f/docs/interpreter/lens.md
----------------------------------------------------------------------
diff --git a/docs/interpreter/lens.md b/docs/interpreter/lens.md
index 0b4711b..b4bcda4 100644
--- a/docs/interpreter/lens.md
+++ b/docs/interpreter/lens.md
@@ -6,14 +6,16 @@ group: manual
---
{% include JB/setup %}
-## Lens Interpreter for Apache Zeppelin
+# Lens Interpreter for Apache Zeppelin
-### Overview
+<div id="toc"></div>
+
+## Overview
[Apache Lens](https://lens.apache.org/) provides an Unified Analytics interface. Lens aims to cut the Data Analytics silos by providing a single view of data across multiple tiered data stores and optimal execution environment for the analytical query. It seamlessly integrates Hadoop with traditional data warehouses to appear like one.
-### Installing and Running Lens
+## Installing and Running Lens
In order to use Lens interpreters, you may install Apache Lens in some simple steps:
1. Download Lens for latest version from [the ASF](http://www.apache.org/dyn/closer.lua/lens/2.3-beta). Or the older release can be found [in the Archives](http://archive.apache.org/dist/lens/).
@@ -24,7 +26,7 @@ In order to use Lens interpreters, you may install Apache Lens in some simple st
./bin/lens-ctl start (or stop)
```
-### Configuring Lens Interpreter
+## Configuring Lens Interpreter
At the "Interpreters" menu, you can edit Lens interpreter or create new one. Zeppelin provides these properties for Lens.
<table class="table-configuration">
@@ -163,7 +165,7 @@ query execute cube select customer_city_name, product_details.description, produ
These are just examples that provided in advance by Lens. If you want to explore whole tutorials of Lens, see the [tutorial video](https://cwiki.apache.org/confluence/display/LENS/2015/07/13/20+Minute+video+demo+of+Apache+Lens+through+examples).
-### Lens UI Service
+## Lens UI Service
Lens also provides web UI service. Once the server starts up, you can open the service on http://serverhost:19999/index.html and browse. You may also check the structure that you made and use query easily here.
http://git-wip-us.apache.org/repos/asf/zeppelin/blob/5975125f/docs/interpreter/livy.md
----------------------------------------------------------------------
diff --git a/docs/interpreter/livy.md b/docs/interpreter/livy.md
index 225cd81..ef7c8ce 100644
--- a/docs/interpreter/livy.md
+++ b/docs/interpreter/livy.md
@@ -6,8 +6,12 @@ group: manual
---
{% include JB/setup %}
-## Livy Interpreter for Apache Zeppelin
-Livy is an open source REST interface for interacting with Spark from anywhere. It supports executing snippets of code or programs in a Spark context that runs locally or in YARN.
+# Livy Interpreter for Apache Zeppelin
+
+<div id="toc"></div>
+
+## Overview
+[Livy](http://livy.io/) is an open source REST interface for interacting with Spark from anywhere. It supports executing snippets of code or programs in a Spark context that runs locally or in YARN.
* Interactive Scala, Python and R shells
* Batch submissions in Scala, Java, Python
@@ -16,13 +20,12 @@ Livy is an open source REST interface for interacting with Spark from anywhere.
* Does not require any code change to your programs
### Requirements
-
Additional requirements for the Livy interpreter are:
* Spark 1.3 or above.
* Livy server.
-### Configuration
+## Configuration
We added some common configurations for spark, and you can set any configuration you want.
This link contains all spark configurations: http://spark.apache.org/docs/latest/configuration.html#available-properties.
And instead of starting property with `spark.` it should be replaced with `livy.spark.`.
@@ -101,8 +104,6 @@ Example: `spark.master` to `livy.spark.master`
</tr>
</table>
-
-
## How to use
Basically, you can use
@@ -136,7 +137,7 @@ hello("livy")
When Zeppelin server is running with authentication enabled, then this interpreter utilizes Livy\u2019s user impersonation feature i.e. sends extra parameter for creating and running a session ("proxyUser": "${loggedInUser}"). This is particularly useful when multi users are sharing a Notebook server.
-### Apply Zeppelin Dynamic Forms
+## Apply Zeppelin Dynamic Forms
You can leverage [Zeppelin Dynamic Form]({{BASE_PATH}}/manual/dynamicform.html). You can use both the `text input` and `select form` parameterization features.
```
@@ -159,7 +160,7 @@ The session would have timed out, you may need to restart the interpreter.
> Blacklisted configuration values in session config: spark.master
-edit `conf/spark-blacklist.conf` file in livy server and comment out `#spark.master` line.
+Edit `conf/spark-blacklist.conf` file in livy server and comment out `#spark.master` line.
-if you choose to work on livy in `apps/spark/java` directory in https://github.com/cloudera/hue ,
-copy `spark-user-configurable-options.template` to `spark-user-configurable-options.conf` file in livy server and comment out `#spark.master`
+If you choose to work on livy in `apps/spark/java` directory in [https://github.com/cloudera/hue](https://github.com/cloudera/hue),
+copy `spark-user-configurable-options.template` to `spark-user-configurable-options.conf` file in livy server and comment out `#spark.master`.