mirror of
https://github.com/apache/zeppelin
synced 2026-05-24 09:38:26 +00:00
1c23f21388
### What is this PR for?
fix: broken image URLs in 0.8.0-SNAPSHOT doc
using the path `/asset` (the absolute path) for image URLs is actually invalid. That's because each version has its own image directory. So they should use the relative path. `{{BASE_PATH}}`
```
➜ asf-zeppelin tree site | grep asset
├── assets # root asset, we shouldn't use it in versioned doc.
│ │ ├── assets
│ │ ├── assets
│ │ ├── assets
│ │ ├── assets
│ │ ├── assets
│ │ ├── assets
│ │ ├── assets
│ │ ├── assets
│ │ ├── assets
│ ├── assets
```
### What type of PR is it?
[Bug Fix]
### Todos
DONE
### What is the Jira issue?
[ZEPPELIN-2707](https://issues.apache.org/jira/browse/ZEPPELIN-2707)
### How should this be tested?
1. cd `docs/`
2. build: `bundle exec jekyll build --safe`
3. check whether links in `_site` include `/docs/0.8.0-SNAPSHOT` as prefix or not
### Screenshots (if appropriate)
#### Current
http://zeppelin.apache.org/docs/0.8.0-SNAPSHOT/usage/interpreter/overview.html
#### After
### Questions:
* Does the licenses files need update? - NO
* Is there breaking changes for older versions? - NO
* Does this needs documentation? - NO
Author: 1ambda <1amb4a@gmail.com>
Closes #2450 from 1ambda/ZEPPELIN-2707/should-use-its-own-asset-directory and squashes the following commits:
fb70214a [1ambda] fix: Use its own asset dir
159 lines
6.2 KiB
Markdown
159 lines
6.2 KiB
Markdown
---
|
|
layout: page
|
|
title: "Explore Apache Zeppelin UI"
|
|
description: "If you are new to Apache Zeppelin, this document will guide you about the basic components of Zeppelin one by one."
|
|
group: quickstart
|
|
---
|
|
<!--
|
|
Licensed under the Apache License, Version 2.0 (the "License");
|
|
you may not use this file except in compliance with the License.
|
|
You may obtain a copy of the License at
|
|
|
|
http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
Unless required by applicable law or agreed to in writing, software
|
|
distributed under the License is distributed on an "AS IS" BASIS,
|
|
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.
|
|
-->
|
|
{% include JB/setup %}
|
|
|
|
# Explore Apache Zeppelin UI
|
|
|
|
<div id="toc"></div>
|
|
|
|
## Main home
|
|
|
|
The first time you connect to Zeppelin ([default installations start on http://localhost:8080](http://localhost:8080/)), you'll land at the main page similar to the below screen capture.
|
|
|
|
<img src="{{BASE_PATH}}/assets/themes/zeppelin/img/ui-img/homepage.png" />
|
|
|
|
On the left of the page are listed all existing notes. Those notes are stored by default in the `$ZEPPELIN_HOME/notebook` folder.
|
|
|
|
You can filter them by name using the input text form. You can also create a 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="{{BASE_PATH}}/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.
|
|
|
|
<img src="{{BASE_PATH}}/assets/themes/zeppelin/img/ui-img/note_import_dialog.png" />
|
|
|
|
By default, the name of the imported note is the same as the original note but you can override it by providing a new name.
|
|
|
|
<br />
|
|
## Menus
|
|
|
|
### 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:
|
|
|
|
1. Open a selected note
|
|
2. Filter node by name
|
|
3. Create a new note
|
|
|
|
<img src="{{BASE_PATH}}/assets/themes/zeppelin/img/ui-img/notebook_menu.png" width="170px" />
|
|
|
|
### Settings
|
|
This menu gives you access to settings and displays information about Zeppelin. User name is set to `anonymous` if you use default shiro configuration. If you want to set up authentification, see [Shiro Authentication](../setup/security/shiro_authentication.html).
|
|
|
|
<img src="{{BASE_PATH}}/assets/themes/zeppelin/img/ui-img/settings_menu.png" width="170px" />
|
|
|
|
#### About Zeppelin
|
|
|
|
You can check Zeppelin version in this menu.
|
|
|
|
<img src="{{BASE_PATH}}/assets/themes/zeppelin/img/ui-img/about_menu.png" width="450px" />
|
|
|
|
#### Interpreter
|
|
|
|
In this menu you can:
|
|
|
|
1. Configure existing **interpreter instance**
|
|
2. Add/remove **interpreter instances**
|
|
|
|
<img src="{{BASE_PATH}}/assets/themes/zeppelin/img/ui-img/interpreter_menu.png" />
|
|
|
|
#### Credential
|
|
|
|
This menu allows you to save credentials for data sources which are passed to interpreters.
|
|
|
|
<img src="{{BASE_PATH}}/assets/themes/zeppelin/img/ui-img/credential_menu.png" />
|
|
|
|
#### Configuration
|
|
|
|
This menu displays all the Zeppelin configuration that are set in the config file `$ZEPPELIN_HOME/conf/zeppelin-site.xml`
|
|
|
|
<img src="{{BASE_PATH}}/assets/themes/zeppelin/img/ui-img/configuration_menu.png" />
|
|
|
|
|
|
<br />
|
|
## Note Layout
|
|
|
|
Each Zeppelin note is composed of 1 .. N paragraphs. The note can be viewed as a paragraph container.
|
|
|
|
<img src="{{BASE_PATH}}/assets/themes/zeppelin/img/ui-img/note_paragraph_layout.png" />
|
|
|
|
### Paragraph
|
|
|
|
Each paragraph consists of 2 sections: `code section` where you put your source code and `result section` where you can see the result of the code execution.
|
|
|
|
<img src="{{BASE_PATH}}/assets/themes/zeppelin/img/ui-img/paragraph_layout.png" />
|
|
|
|
On the top-right corner of each paragraph there are some commands to:
|
|
|
|
* execute the paragraph code
|
|
* hide/show `code section`
|
|
* hide/show `result section`
|
|
* configure the paragraph
|
|
|
|
To configure the paragraph, just click on the gear icon:
|
|
|
|
<img src="{{BASE_PATH}}/assets/themes/zeppelin/img/ui-img/paragraph_configuration_dialog.png" width="180px" />
|
|
|
|
From this dialog, you can (in descending order):
|
|
|
|
* find the **paragraph id** ( **20150924-163507_134879501** )
|
|
* control paragraph width. Since Zeppelin is using the grid system of **Twitter Bootstrap**, each paragraph width can be changed from 1 to 12
|
|
* move the paragraph 1 level up
|
|
* move the paragraph 1 level down
|
|
* create a new paragraph
|
|
* change paragraph title
|
|
* show/hide line number in the `code section`
|
|
* disable the run button for this paragraph
|
|
* export the current paragraph as an **iframe** and open the **iframe** in a new window
|
|
* clear the `result section`
|
|
* delete the current paragraph
|
|
|
|
### Note toolbar
|
|
|
|
At the top of the note, you can find a toolbar which exposes command buttons as well as configuration, security and display options.
|
|
|
|
<img src="{{BASE_PATH}}/assets/themes/zeppelin/img/ui-img/note_toolbar.png" />
|
|
|
|
On the far right is displayed the note name, just click on it to reveal the input form and update it.
|
|
|
|
In the middle of the toolbar you can find the command buttons:
|
|
|
|
* execute all the paragraphs **sequentially**, in their display order
|
|
* hide/show `code section` of all paragraphs
|
|
* hide/show `result section` of all paragraphs
|
|
* clear the `result section` of all paragraphs
|
|
* clone the current note
|
|
* export the current note to a JSON file. _Please note that the `code section` and `result section` of all paragraphs will be exported. If you have heavy data in the `result section` of some paragraphs, it is recommended to clean them before exporting
|
|
* commit the current node content
|
|
* delete the note
|
|
* schedule the execution of **all paragraph** using a CRON syntax
|
|
|
|
<img src="{{BASE_PATH}}/assets/themes/zeppelin/img/ui-img/note_commands.png" width="300px"/>
|
|
|
|
On the right of the note tool bar you can find configuration icons:
|
|
|
|
* display all the keyboard shorcuts
|
|
* configure the interpreters binding to the current note
|
|
* configure the note permissions
|
|
* switch the node display mode between `default`, `simple` and `report`
|
|
|
|
<img src="{{BASE_PATH}}/assets/themes/zeppelin/img/ui-img/note_configuration.png" width="180px"/>
|