Skip to content

Commit f2c126b

Browse files
authored
Rewrite of "Quick Start"
I rewrote the "Quick Start"/installation page for syntax and grammar, trying to keep the to the original content as much as possible.
1 parent c88010f commit f2c126b

File tree

1 file changed

+55
-51
lines changed

1 file changed

+55
-51
lines changed

docs/install/install.md

Lines changed: 55 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
layout: page
33
title: "Quick Start"
4-
description: "This page will help you to get started and guide you through installation of Apache Zeppelin, running it in the command line and basic configuration options."
4+
description: "This page will help you get started and will guide you through installing Apache Zeppelin, running it in the command line and configuring options."
55
group: install
66
---
77
<!--
@@ -20,14 +20,14 @@ limitations under the License.
2020
{% include JB/setup %}
2121

2222
# Quick Start
23-
Welcome to your first trial to explore Apache Zeppelin!
24-
This page will help you to get started and here is the list of topics covered.
2523

2624
<div id="toc"></div>
2725

26+
Welcome to Apache Zeppelin! On this page are instructions to help you get started.
27+
2828
## Installation
2929

30-
Apache Zeppelin officially supports and is tested on next environments.
30+
Apache Zeppelin officially supports and is tested on the following environments:
3131

3232
<table class="table-configuration">
3333
<tr>
@@ -44,21 +44,21 @@ Apache Zeppelin officially supports and is tested on next environments.
4444
</tr>
4545
</table>
4646

47-
There are two options to install Apache Zeppelin on your machine. One is [downloading pre-built binary package](#downloading-binary-package) from the archive.
48-
You can download not only the latest stable version but also the older one if you need.
49-
The other option is [building from the source](#building-from-source).
50-
Although it can be unstable somehow since it is on development status, you can explore newly added feature and change it as you want.
47+
To install Apache Zeppelin, you have two options:
48+
* You can [download pre-built binary packages](#downloading-binary-package) from the archive. This is usually easier than building from source, and you can download the latest stable version (or older versions, if necessary).
49+
* You can also [build from source](#building-from-source). This gives you a development version of Zeppelin, which is more unstable but has new features.
5150

5251
### Downloading Binary Package
5352

54-
If you want to install Apache Zeppelin with a stable binary package, please visit [Apache Zeppelin download Page](http://zeppelin.apache.org/download.html).
53+
Stable binary packages are available on the [Apache Zeppelin Download Page](http://zeppelin.apache.org/download.html). You can download a default package with all interpreters, or you can download the *net-install* package, which lets you choose which interpreters to install.
5554

56-
If you have downloaded `netinst` binary, [install additional interpreters](../manual/interpreterinstallation.html) before you start Zeppelin. Or simply run `./bin/install-interpreter.sh --all`.
55+
If you downloaded the default package, just unpack it in a directory of your choice and you're ready to go. If you downloaded the *net-install* package, you should manually [install additional interpreters](../manual/interpreterinstallation.html) first. You can also install everything by running `./bin/install-interpreter.sh --all`.
5756

58-
After unpacking, jump to [Starting Apache Zeppelin with Command Line](#starting-apache-zeppelin-with-command-line) section.
57+
After unpacking, jump to the [Starting Apache Zeppelin with Command Line](#starting-apache-zeppelin-with-command-line).
5958

6059
### Building from Source
61-
If you want to build from the source, the software below needs to be installed on your system.
60+
61+
If you want to build from source, you must first install the following dependencies:
6262

6363
<table class="table-configuration">
6464
<tr>
@@ -67,30 +67,31 @@ If you want to build from the source, the software below needs to be installed o
6767
</tr>
6868
<tr>
6969
<td>Git</td>
70-
<td></td>
70+
<td>(Any Version)</td>
7171
</tr>
7272
<tr>
7373
<td>Maven</td>
7474
<td>3.1.x or higher</td>
7575
</tr>
7676
</table>
7777

78-
If you don't have it installed yet, please check [Before Build](https://github.com/apache/zeppelin/blob/master/README.md#before-build) section and follow step by step instructions from there.
78+
If you haven't installed Git and Maven yet, check the [Before Build](https://github.com/apache/zeppelin/blob/master/README.md#before-build) section and follow the step by step instructions from there.
7979

80-
####1. Clone Apache Zeppelin repository
80+
81+
####1. Clone the Apache Zeppelin repository
8182

8283
```
8384
git clone https://github.com/apache/zeppelin.git
8485
```
8586

8687
####2. Build source with options
87-
Each interpreters requires different build options. For the further information about options, please see [Build](https://github.com/apache/zeppelin#build) section.
88+
Each interpreter requires different build options. For more information about build options, please see the [Build](https://github.com/apache/zeppelin#build) section.
8889

8990
```
9091
mvn clean package -DskipTests [Options]
9192
```
9293

93-
Here are some examples with several options
94+
Here are some examples with several options:
9495

9596
```
9697
# build with spark-2.0, scala-2.11
@@ -110,24 +111,26 @@ mvn clean package -Pspark-1.5 -Dhadoop.version=2.6.0-cdh5.5.0 -Phadoop-2.6 -Pven
110111
mvn clean package -Pspark-1.5 -Pmapr50 -DskipTests
111112
```
112113

113-
For the further information about building with source, please see [README.md](https://github.com/apache/zeppelin/blob/master/README.md) in Zeppelin repository.
114+
For further information about building from source, please see [README.md](https://github.com/apache/zeppelin/blob/master/README.md) in the Zeppelin repository.
115+
116+
## Starting Apache Zeppelin from the Command Line
117+
#### Starting Apache Zeppelin
114118

115-
## Starting Apache Zeppelin with Command Line
116-
#### Start Zeppelin
119+
On all platforms except for Windows:
117120

118121
```
119122
bin/zeppelin-daemon.sh start
120123
```
121124

122-
If you are using Windows
125+
If you are using Windows:
123126

124127
```
125128
bin\zeppelin.cmd
126129
```
127130

128-
After successful start, visit [http://localhost:8080](http://localhost:8080) with your web browser.
131+
After Zeppelin has started successfully, go to [http://localhost:8080](http://localhost:8080) with your web browser.
129132

130-
#### Stop Zeppelin
133+
#### Stopping Zeppelin
131134

132135
```
133136
bin/zeppelin-daemon.sh stop
@@ -137,10 +140,10 @@ bin/zeppelin-daemon.sh stop
137140

138141
> **Note :** The below description was written based on Ubuntu Linux.
139142
140-
Apache Zeppelin can be auto started as a service with an init script, such as services managed by **upstart**.
143+
Apache Zeppelin can be auto-started as a service with an init script, using a service manager like **upstart**.
141144

142-
The following is an example of upstart script to be saved as `/etc/init/zeppelin.conf`
143-
This also allows the service to be managed with commands such as
145+
This is an example upstart script saved as `/etc/init/zeppelin.conf`
146+
This allows the service to be managed with commands such as
144147

145148
```
146149
sudo service zeppelin start
@@ -174,24 +177,25 @@ chdir /usr/share/zeppelin
174177
exec bin/zeppelin-daemon.sh upstart
175178
```
176179

177-
## What is the next?
178-
Congratulation on your successful Apache Zeppelin installation! Here are two next steps you might need.
180+
## Next Steps:
181+
182+
Congratulations, you have successfully installed Apache Zeppelin! Here are two next steps you might find useful:
179183

180-
#### If you are new to Apache Zeppelin
181-
* For an in-depth overview of Apache Zeppelin UI, head to [Explore Apache Zeppelin UI](../quickstart/explorezeppelinui.html).
182-
* After getting familiar with Apache Zeppelin UI, have fun with a short walk-through [Tutorial](../quickstart/tutorial.html) that uses Apache Spark backend.
183-
* If you need more configuration setting for Apache Zeppelin, jump to the next section: [Apache Zeppelin Configuration](#apache-zeppelin-configuration).
184+
#### If you are new to Apache Zeppelin...
185+
* For an in-depth overview of the Apache Zeppelin UI, head to [Explore Apache Zeppelin UI](../quickstart/explorezeppelinui.html).
186+
* After getting familiar with the Apache Zeppelin UI, have fun with a short walk-through [Tutorial](../quickstart/tutorial.html) that uses the Apache Spark backend.
187+
* If you need more configuration for Apache Zeppelin, jump to the next section: [Apache Zeppelin Configuration](#apache-zeppelin-configuration).
184188

185-
#### If you need more information about Spark or JDBC interpreter setting
186-
* 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).
187-
* Also, you can use generic JDBC connections in Apache Zeppelin. Go to [Generic JDBC Interpreter for Apache Zeppelin](../interpreter/jdbc.html).
189+
#### If you need more information about Spark or JDBC interpreter settings...
190+
* Apache Zeppelin provides deep integration with [Apache Spark](http://spark.apache.org/). For more informtation, see [Spark Interpreter for Apache Zeppelin](../interpreter/spark.html).
191+
* You can also use generic JDBC connections in Apache Zeppelin. Go to [Generic JDBC Interpreter for Apache Zeppelin](../interpreter/jdbc.html).
188192

189-
#### If you are in multi-user environment
190-
* You can set permissions for your notebooks and secure data resource in multi-user environment. Go to **More** -> **Security** section.
193+
#### If you are in a multi-user environment...
194+
* You can set permissions for your notebooks and secure data resource in a multi-user environment. Go to **More** -> **Security** section.
191195

192196
## Apache Zeppelin Configuration
193197

194-
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.
198+
You can configure Apache Zeppelin with either **environment variables** in `conf/zeppelin-env.sh` (`conf\zeppelin-env.cmd` for Windows) or **Java properties** in `conf/zeppelin-site.xml`. If both are defined, then the **environment variables** will take priority.
195199

196200
<table class="table-configuration">
197201
<tr>
@@ -228,19 +232,19 @@ You can configure Apache Zeppelin with both **environment variables** in `conf/z
228232
<td>ZEPPELIN_ALLOWED_ORIGINS</td>
229233
<td>zeppelin.server.allowed.origins</td>
230234
<td>*</td>
231-
<td>Enables a way to specify a ',' separated list of allowed origins for rest and websockets. <br /> i.e. http://localhost:8080 </td>
235+
<td>Enables a way to specify a ',' separated list of allowed origins for REST and websockets. <br /> i.e. http://localhost:8080 </td>
232236
</tr>
233237
<tr>
234238
<td>N/A</td>
235239
<td>zeppelin.anonymous.allowed</td>
236240
<td>true</td>
237-
<td>Anonymous user is allowed by default.</td>
241+
<td>The anonymous user is allowed by default.</td>
238242
</tr>
239243
<tr>
240244
<td>ZEPPELIN_SERVER_CONTEXT_PATH</td>
241245
<td>zeppelin.server.context.path</td>
242246
<td>/</td>
243-
<td>A context path of the web application</td>
247+
<td>Context path of the web application</td>
244248
</tr>
245249
<tr>
246250
<td>ZEPPELIN_SSL</td>
@@ -300,19 +304,19 @@ You can configure Apache Zeppelin with both **environment variables** in `conf/z
300304
<td>ZEPPELIN_NOTEBOOK_HOMESCREEN</td>
301305
<td>zeppelin.notebook.homescreen</td>
302306
<td></td>
303-
<td>A notebook id displayed in Apache Zeppelin homescreen <br />i.e. 2A94M5J1Z</td>
307+
<td>Display notebook IDs on the Apache Zeppelin homescreen <br />i.e. 2A94M5J1Z</td>
304308
</tr>
305309
<tr>
306310
<td>ZEPPELIN_NOTEBOOK_HOMESCREEN_HIDE</td>
307311
<td>zeppelin.notebook.homescreen.hide</td>
308312
<td>false</td>
309-
<td>This value can be "true" when to hide the notebook id set by <code>ZEPPELIN_NOTEBOOK_HOMESCREEN</code> on the Apache Zeppelin homescreen. <br />For the further information, please read <a href="../manual/notebookashomepage.html">Customize your Zeppelin homepage</a>.</td>
313+
<td>Hide the notebook ID set by <code>ZEPPELIN_NOTEBOOK_HOMESCREEN</code> on the Apache Zeppelin homescreen. <br />For the further information, please read <a href="../manual/notebookashomepage.html">Customize your Zeppelin homepage</a>.</td>
310314
</tr>
311315
<tr>
312316
<td>ZEPPELIN_WAR_TEMPDIR</td>
313317
<td>zeppelin.war.tempdir</td>
314318
<td>webapps</td>
315-
<td>A location of jetty temporary directory</td>
319+
<td>Location of the jetty temporary directory</td>
316320
</tr>
317321
<tr>
318322
<td>ZEPPELIN_NOTEBOOK_DIR</td>
@@ -330,7 +334,7 @@ You can configure Apache Zeppelin with both **environment variables** in `conf/z
330334
<td>ZEPPELIN_NOTEBOOK_S3_USER</td>
331335
<td>zeppelin.notebook.s3.user</td>
332336
<td>user</td>
333-
<td>A user name of S3 bucket<br />i.e. <code>bucket/user/notebook/2A94M5J1Z/note.json</code></td>
337+
<td>User name of an S3 bucket<br />i.e. <code>bucket/user/notebook/2A94M5J1Z/note.json</code></td>
334338
</tr>
335339
<tr>
336340
<td>ZEPPELIN_NOTEBOOK_S3_ENDPOINT</td>
@@ -360,25 +364,25 @@ You can configure Apache Zeppelin with both **environment variables** in `conf/z
360364
<td>ZEPPELIN_NOTEBOOK_AZURE_SHARE</td>
361365
<td>zeppelin.notebook.azure.share</td>
362366
<td>zeppelin</td>
363-
<td>Share where the notebook files will be saved</td>
367+
<td>Azure Share where the notebook files will be saved</td>
364368
</tr>
365369
<tr>
366370
<td>ZEPPELIN_NOTEBOOK_AZURE_USER</td>
367371
<td>zeppelin.notebook.azure.user</td>
368372
<td>user</td>
369-
<td>An optional user name of Azure file share<br />i.e. <code>share/user/notebook/2A94M5J1Z/note.json</code></td>
373+
<td>Optional user name of an Azure file share<br />i.e. <code>share/user/notebook/2A94M5J1Z/note.json</code></td>
370374
</tr>
371375
<tr>
372376
<td>ZEPPELIN_NOTEBOOK_STORAGE</td>
373377
<td>zeppelin.notebook.storage</td>
374378
<td>org.apache.zeppelin.notebook.repo.VFSNotebookRepo</td>
375-
<td>Comma separated list of notebook storage</td>
379+
<td>Comma separated list of notebook storage locations</td>
376380
</tr>
377381
<tr>
378382
<td>ZEPPELIN_NOTEBOOK_ONE_WAY_SYNC</td>
379383
<td>zeppelin.notebook.one.way.sync</td>
380384
<td>false</td>
381-
<td>If there are multiple notebook storages, should we treat the first one as the only source of truth?</td>
385+
<td>If there are multiple notebook storage locations, should we treat the first one as the only source of truth?</td>
382386
</tr>
383387
<tr>
384388
<td>ZEPPELIN_INTERPRETERS</td>
@@ -389,7 +393,7 @@ You can configure Apache Zeppelin with both **environment variables** in `conf/z
389393
</td>
390394
<td>
391395
Comma separated interpreter configurations [Class] <br/>
392-
<span style="font-style:italic">NOTE: This property is deprecated since Zeppelin-0.6.0 and will not be supported from Zeppelin-0.7.0</span>
396+
<span style="font-style:italic">NOTE: This property is deprecated since Zeppelin-0.6.0 and will not be supported from Zeppelin-0.7.0 on.</span>
393397
</td>
394398
</tr>
395399
<tr>
@@ -402,6 +406,6 @@ You can configure Apache Zeppelin with both **environment variables** in `conf/z
402406
<td>ZEPPELIN_WEBSOCKET_MAX_TEXT_MESSAGE_SIZE</td>
403407
<td>zeppelin.websocket.max.text.message.size</td>
404408
<td>1024000</td>
405-
<td>Size in characters of the maximum text message to be received by websocket.</td>
409+
<td>Size (in characters) of the maximum text message that can be received by websocket.</td>
406410
</tr>
407411
</table>

0 commit comments

Comments
 (0)