diff --git a/docs/_includes/themes/zeppelin/_navigation.html b/docs/_includes/themes/zeppelin/_navigation.html index 72b5e48a037..f28b35904d2 100644 --- a/docs/_includes/themes/zeppelin/_navigation.html +++ b/docs/_includes/themes/zeppelin/_navigation.html @@ -18,28 +18,34 @@
+
+You can explicitly say you're using `text` display system.
+
+
+
+## Html
+
+With `%html` directive, Zeppelin treats your output as HTML
+
+
+
## Table
If you have data that row seprated by '\n' (newline) and column separated by '\t' (tab) with first row as header row, for example
-You can simply use %table display system to leverage Zeppelin's built in visualization.
+You can simply use `%table` display system to leverage Zeppelin's built in visualization.
-Note that display system is backend independent.
-
-If table contents start with %html, it is interpreted as an HTML.
+If table contents start with `%html`, it is interpreted as an HTML.
+
+> **Note :** Display system is backend independent.
diff --git a/docs/displaysystem/html.md b/docs/displaysystem/html.md
deleted file mode 100644
index c92924182d1..00000000000
--- a/docs/displaysystem/html.md
+++ /dev/null
@@ -1,25 +0,0 @@
----
-layout: page
-title: "Html Display System"
-description: ""
-group: display
----
-
-{% include JB/setup %}
-## Html
-
-With '%html' directive, Zeppelin treats your output as html
-
-
diff --git a/docs/displaysystem/text.md b/docs/displaysystem/text.md
deleted file mode 100644
index e843f19735d..00000000000
--- a/docs/displaysystem/text.md
+++ /dev/null
@@ -1,31 +0,0 @@
----
-layout: page
-title: "Text Display System"
-description: ""
-group: display
----
-
-{% include JB/setup %}
-## Text
-
-Zeppelin prints output of language backend in text, by default.
-
-
-
-You can explicitly say you're using text display system.
-
-
-
-Note that display system is backend independent.
diff --git a/docs/index.md b/docs/index.md
index 48b3e4a3be6..628821760df 100644
--- a/docs/index.md
+++ b/docs/index.md
@@ -20,50 +20,49 @@ limitations under the License.
{% include JB/setup %}
- The Notebook is the place for all your needs -
-
+ The Notebook is the place for all your needs +
+
+
+
-Adding new language-backend is really simple. Learn [how to write a zeppelin interpreter](./development/writingzeppelininterpreter.html).
-
-
+
-Zeppelin's Spark integration provides
+Apache Zeppelin with Spark integration provides
- Automatic SparkContext and SQLContext injection
- Runtime jar dependency loading from local filesystem or maven repository. Learn more about [dependency loader](./interpreter/spark.html#dependencyloading).
- Canceling job and displaying its progress
+For the further information about Apache Spark in Apache Zeppelin, please see [Spark interpreter for Apache Zeppelin](./interpreter/spark.html).
+
+
-
-Learn more about [Dynamic Forms](./manual/dynamicform.html).
+Learn more about [display systems](#display-system) in Apache Zeppelin.
+Apache Zeppelin can dynamically create some input forms in your notebook.
+
+ Zeppelin provides an URL to display the result only, that page does not include Zeppelin's menu and buttons. -This way, you can easily embed it as an iframe inside of your website.
+## Collaborate by sharing your Notebook & Paragraph +Your notebook URL can be shared among collaborators. Then Apache Zeppelin will broadcast any changes in realtime, just like the collaboration in Google docs.
+
+
+
+Apache Zeppelin is Apache2 Licensed software. Please check out the [source repository](http://git.apache.org/zeppelin.git) and [how to contribute](./development/howtocontribute.html).
+Apache Zeppelin has a very active development community.
+Join to our [Mailing list](https://zeppelin.apache.org/community.html) and report issues on [Jira Issue tracker](https://issues.apache.org/jira/browse/ZEPPELIN).
+
+## What is the next ?
+
+####Quick Start
+
+* Getting Started
+ * [Quick Start](./install/install.html) for basic instructions on installing Zeppelin
+ * [Configuration](./install/install.html#zeppelin-configuration) lists for Zeppelin
+ * [Explore Apache Zeppelin UI](./quickstart/explorezeppelinui.html): basic components of Zeppelin home
+ * [Tutorial](./quickstart/tutorial.html): a short walk-through tutorial that uses Apache Spark backend
+* Basic Feature Guide
+ * [Dynamic Form](./manual/dynamicform.html): a step by step guide for creating dynamic forms
+ * [Publish your Paragraph](./manual/publish.html) results into your external website
+ * [Customize Zeppelin Homepage](./manual/notebookashomepage.html) with one of your notebooks
+* More
+ * [Apache Zeppelin on Vagrant VM](./install/virtual_machine.html): a guide for installing Apache Zeppelin on Vagrant virtual machine
+ * [Upgrade Apache Zeppelin Version](./install/upgrade.html): a manual procedure of upgrading Apache Zeppelin version
+
+####Interpreter
+
+* [Interpreters in Apache Zeppelin](./manual/interpreters.html): what is interpreter group? how can you set interpreters in Apache Zeppelin?
+* Available Interpreters: currently, about 20 interpreters are available in Apache Zeppelin.
+* Usage
+ * [Dynamic Interpreter Loading](./manual/dynamicinterpreterload.html) using REST API
+ * [Interpreter Dependency Management](./manual/dependencymanagement.html) when you include external libraries to interpreter
+
+
+####Display System
+
+* Basic Display System: [Text](./displaysystem/basicdisplaysystem.html#text), [HTML](./displaysystem/basicdisplaysystem.html#html), [Table](./displaysystem/basicdisplaysystem.html#table) is available
+* Angular API: a description about avilable backend and frontend AngularJS API with examples
+ * [Angular (backend API)](./displaysystem/back-end-angular.html)
+ * [Angular (frontend API)](./displaysystem/front-end-angular.html)
+
+####More
+
+* Notebook Storage: a guide about saving notebooks to external storage
+ * [Git Storage](./storage/storage.html#notebook-storage-in-local-git-repository)
+ * [S3 Storage](./storage/storage.html#notebook-storage-in-s3)
+ * [Azure Storage](./storage/storage.html#notebook-storage-in-azure)
+ * [ZeppelinHub Storage](./storage/storage.html#storage-in-zeppelinhub)
+* REST API: available REST API list in Apache Zeppelin
+ * [Interpreter API](./rest-api/rest-interpreter.html)
+ * [Notebook API](./rest-api/rest-notebook.html)
+ * [Configuration API](./rest-api/rest-configuration.html)
+* Security: available security support in Apache Zeppelin
+ * [Authentication for NGINX](./security/authentication.html)
+ * [Shiro Authentication](./security/shiroauthentication.html)
+ * [Notebook Authorization](./security/notebook_authorization.html)
+ * [Interpreter & Data Resource Authorization](./security/interpreter_authorization.html)
+* Contribute
+ * [Writing a new Interpreter](./development/writingzeppelininterpreter.html)
+ * [How to contribute (code)](./development/howtocontribute.html)
+ * [How to contribute (documentation website)](./development/howtocontributewebsite.html)
+
+#### External Resources
+ * [Mailing List](https://zeppelin.apache.org/community.html)
+ * [Apache Zeppelin Wiki](https://cwiki.apache.org/confluence/display/ZEPPELIN/Zeppelin+Home)
+ * [StackOverflow tag `apache-zeppelin`](http://stackoverflow.com/questions/tagged/apache-zeppelin)
-Zeppelin has a very active development community.
-Join the [Mailing list](https://zeppelin.apache.org/community.html) and report issues on our [Issue tracker](https://issues.apache.org/jira/browse/ZEPPELIN).
diff --git a/docs/install/install.md b/docs/install/install.md
index 251ba048777..e3dcd2c0005 100644
--- a/docs/install/install.md
+++ b/docs/install/install.md
@@ -1,6 +1,6 @@
---
layout: page
-title: "Zeppelin Installation"
+title: "Getting Started"
description: ""
group: install
---
@@ -19,8 +19,6 @@ limitations under the License.
-->
{% include JB/setup %}
-
-
## Zeppelin Installation
Welcome to your first trial to explore Zeppelin!
@@ -42,7 +40,65 @@ You can also build Zeppelin from the source.
If you don't have requirements prepared, please check instructions in [README.md](https://github.com/apache/zeppelin/blob/master/README.md) for the details.
-
+
+
+Maybe you need to configure individual interpreter. If so, please check **Interpreter** section in Zeppelin documentation.
+[Spark Interpreter for Apache Zeppelin](../interpreter/spark.html) will be a good example.
+
+## Zeppelin Start / Stop
+#### Start Zeppelin
+
+```
+bin/zeppelin-daemon.sh start
+```
+After successful start, visit [http://localhost:8080](http://localhost:8080) with your web browser.
+
+#### Stop Zeppelin
+
+```
+bin/zeppelin-daemon.sh stop
+```
+
+#### Start Zeppelin with a service manager such as upstart
+
+Zeppelin can auto start as a service with an init script, such as services managed by upstart.
+
+The following is an example upstart script to be saved as `/etc/init/zeppelin.conf`
+This example has been tested with Ubuntu Linux.
+This also allows the service to be managed with commands such as
+
+`sudo service zeppelin start`
+`sudo service zeppelin stop`
+`sudo service zeppelin restart`
+
+Other service managers could use a similar approach with the `upstart` argument passed to the zeppelin-daemon.sh script: `bin/zeppelin-daemon.sh upstart`
+
+##### zeppelin.conf
+
+```
+description "zeppelin"
+
+start on (local-filesystems and net-device-up IFACE!=lo)
+stop on shutdown
+
+# Respawn the process on unexpected termination
+respawn
+
+# respawn the job up to 7 times within a 5 second period.
+# If the job exceeds these values, it will be stopped and marked as failed.
+respawn limit 7 5
+
+# zeppelin was installed in /usr/share/zeppelin in this example
+chdir /usr/share/zeppelin
+exec bin/zeppelin-daemon.sh upstart
+```
+
+#### Running on Windows
+
+```
+bin\zeppelin.cmd
+```
+
## Zeppelin Configuration
You can configure 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.
@@ -250,60 +306,3 @@ You can configure Zeppelin with both **environment variables** in `conf/zeppelin
+
Also you can provide default value, using `${formName=defaultValue}`.