Skip to content

Commit d8c43b4

Browse files
author
astroshim
committed
add navigation
2 parents c808350 + d11221f commit d8c43b4

File tree

56 files changed

+1494
-217
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

56 files changed

+1494
-217
lines changed

‎README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
#Zeppelin
1+
# Apache Zeppelin
22

33
**Documentation:** [User Guide](http://zeppelin.apache.org/docs/latest/index.html)<br/>
44
**Mailing Lists:** [User and Dev mailing list](http://zeppelin.apache.org/community.html)<br/>

‎conf/shiro.ini‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,10 @@ user3 = password4, role2
2828
### A sample for configuring Active Directory Realm
2929
#activeDirectoryRealm = org.apache.zeppelin.server.ActiveDirectoryGroupRealm
3030
#activeDirectoryRealm.systemUsername = userNameA
31+
32+
#use either systemPassword or hadoopSecurityCredentialPath, more details in http://zeppelin.apache.org/docs/latest/security/shiroauthentication.html
3133
#activeDirectoryRealm.systemPassword = passwordA
34+
#activeDirectoryRealm.hadoopSecurityCredentialPath = jceks://file/user/zeppelin/zeppelin.jceks
3235
#activeDirectoryRealm.searchBase = CN=Users,DC=SOME_GROUP,DC=COMPANY,DC=COM
3336
#activeDirectoryRealm.url = ldap://ldap.test.com:389
3437
#activeDirectoryRealm.groupRolesMap = "CN=admin,OU=groups,DC=SOME_GROUP,DC=COMPANY,DC=COM":"admin","CN=finance,OU=groups,DC=SOME_GROUP,DC=COMPANY,DC=COM":"finance","CN=hr,OU=groups,DC=SOME_GROUP,DC=COMPANY,DC=COM":"hr"

‎conf/zeppelin-site.xml.template‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -190,7 +190,7 @@
190190

191191
<property>
192192
<name>zeppelin.interpreter.group.order</name>
193-
<value>"spark,md,angular,sh,livy,alluxio,file,psql,flink,python,ignite,lens,cassandra,geode,kylin,elasticsearch,scalding,jdbc,hbase</value>
193+
<value>spark,md,angular,sh,livy,alluxio,file,psql,flink,python,ignite,lens,cassandra,geode,kylin,elasticsearch,scalding,jdbc,hbase,bigquery</value>
194194
<description></description>
195195
</property>
196196

‎docs/CONTRIBUTING.md‎

Lines changed: 94 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,94 @@
1+
# Contributing to Apache Zeppelin Documentation
2+
3+
## Folder Structure
4+
`docs/` folder is organized as below:
5+
6+
```
7+
docs/
8+
├── _includes/themes/zeppelin
9+
│ ├── _navigation.html
10+
│ └── default.html
11+
├── _layouts
12+
├── _plugins
13+
├── assets/themes/zeppelin -> {ASSET_PATH}
14+
│ ├── bootstrap
15+
│ ├── css
16+
│ ├── img
17+
│ └── js
18+
├── development/ *.md
19+
├── displaysystem/ *.md
20+
├── install/ *.md
21+
├── interpreter/ *.md
22+
├── manual/ *.md
23+
├── quickstart/ *.md
24+
├── rest-api/ *.md
25+
├── security/ *.md
26+
├── storage/ *.md
27+
├── Gemfile
28+
├── Gemfile.lock
29+
├── _config.yml
30+
├── index.md
31+
└── ...
32+
```
33+
34+
- `_navigation.html`: the dropdown menu in navbar
35+
- `default.html` & `_layouts/`: define default HTML layout
36+
- `_plugins/`: custom plugin `*.rb` files can be placed in this folder. See [jekyll/plugins](https://jekyllrb.com/docs/plugins/) for the further information.
37+
- `{ASSET_PATH}/css/style.css`: extra css components can be defined
38+
- `{ASSET_PATH}/img/docs-img/`: image files used for document pages can be placed in this folder
39+
- `{ASSET_PATH}/js/`: extra `.js` files can be placed
40+
- `Gemfile`: defines bundle dependencies. They will be installed by `bundle install`.
41+
- `Gemfile.lock`: when you run `bundle install`, bundler will persist all gems name and their version to this file. For the more details, see [Bundle "The Gemfile Lock"](http://bundler.io/v1.10/man/bundle-install.1.html#THE-GEMFILE-LOCK)
42+
- `documentation_group`: `development/`, `displaysystem/`, `install/`, `interpreter/`...
43+
- `_config.yml`: defines configuration options for docs website. See [jekyll/configuration](https://jekyllrb.com/docs/configuration/) for the other available config variables.
44+
- `index.md`: the main page of `http://zeppelin.apache.org/docs/<ZEPPELIN_VERSION>/`
45+
46+
47+
## Markdown
48+
Zeppelin documentation pages are written with [Markdown](http://daringfireball.net/projects/markdown/). It is possible to use [GitHub flavored syntax](https://help.github.com/categories/writing-on-github/) and intermix plain HTML.
49+
50+
## Front matter
51+
Every page contains [YAML front matter](https://jekyllrb.com/docs/frontmatter/) block in their header. Don't forget to wrap the front matter list with triple-dashed lines(`---`) like below.
52+
The document page should start this triple-dashed lines. Or you will face 404 error, since Jekyll can't find the page.
53+
54+
```
55+
---
56+
layout: page
57+
title: "Apache Zeppelin Tutorial"
58+
description: "This tutorial page contains a short walk-through tutorial that uses Apache Spark backend. Please note that this tutorial is valid for Spark 1.3 and higher."
59+
group: quickstart
60+
---
61+
```
62+
63+
- `layout`: the default layout is `page` which is defined in `_layout/page.html`.
64+
- `title`: the title for the document. Please note that if it needs to include `Zeppelin`, it should be `Apache Zeppelin`, not `Zeppelin`.
65+
- `description`: a short description for the document. One or two sentences would be enough. This description also will be shown as an extract sentence when people search pages.
66+
- `group`: a category of the document page
67+
68+
## Headings
69+
All documents are structured with headings. From these headings, you can automatically generate a **Table of Contents**. There is a simple rule for Zeppelin docs headings.
70+
71+
```
72+
# Level-1 heading <- used only for the main title
73+
## Level-2 heading <- start with this
74+
### Level-3 heading
75+
#### Level-4 heading <- won't be converted in TOC from this level
76+
```
77+
78+
## Table of contents(TOC)
79+
80+
```
81+
<div id="toc"></div>
82+
```
83+
84+
Add this line below `# main title` in order to generate a **Table of Contents**. Headings until `### (Level-3 heading)` are included to TOC.
85+
86+
87+
Default setting options for TOC are definded in [here](https://github.com/apache/zeppelin/blob/master/docs/assets/themes/zeppelin/js/toc.js#L4).
88+
89+
90+
## Adding new pages
91+
If you're going to create new pages, there are some spots you need to add the location of the page.
92+
93+
- **Dropdown menu in navbar**: add your docs location to [_navigation.html](https://github.com/apache/zeppelin/blob/master/docs/_includes/themes/zeppelin/_navigation.html)
94+
- **Main index**: add your docs below [What is the next?](http://zeppelin.apache.org/docs/latest/#what-is-the-next) section in [index.md](https://github.com/apache/zeppelin/blob/master/docs/index.md) with a short description. No need to do this if the page is for **Interpreters**.

‎docs/README.md‎

Lines changed: 30 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,41 +1,55 @@
1-
## Apache Zeppelin documentation
2-
3-
This readme will walk you through building the Zeppelin documentation, which is included here with the Zeppelin source code.
1+
# Apache Zeppelin documentation
42

3+
This README will walk you through building the documentation of Apache Zeppelin. The documentation is included here with Apache Zeppelin source code. The online documentation at [https://zeppelin.apache.org/docs/<ZEPPELIN_VERSION>](https://zeppelin.apache.org/docs/latest) is also generated from the files found in here.
54

65
## Build documentation
7-
See https://help.github.com/articles/using-jekyll-with-pages#installing-jekyll
6+
Zeppelin is using [Jekyll](https://jekyllrb.com/) which is a static site generator and [Github Pages](https://pages.github.com/) as a site publisher. For the more details, see [help.github.com/articles/about-github-pages-and-jekyll/](https://help.github.com/articles/about-github-pages-and-jekyll/).
87

98
**Requirements**
109

1110
```
12-
ruby --version >= 2.0.0
13-
gem install bundler
14-
# go to /docs under your Zeppelin source
15-
bundle install
11+
# ruby --version >= 2.0.0
12+
# Install Bundler using gem
13+
gem install bundler
14+
15+
cd $ZEPPELIN_HOME/docs
16+
# Install all dependencies declared in the Gemfile
17+
bundle install
1618
```
1719

18-
For the further information about requirements, please see [here](https://help.github.com/articles/setting-up-your-github-pages-site-locally-with-jekyll/#requirements).
20+
For the further information about requirements, please see [here](https://help.github.com/articles/setting-up-your-github-pages-site-locally-with-jekyll/#requirements).
21+
22+
On OS X 10.9, you may need to do
23+
24+
```
25+
xcode-select --install
26+
```
1927

20-
*On OS X 10.9 you may need to do "xcode-select --install"*
28+
## Run website locally
29+
If you don't want to encounter uglily rendered pages, run the documentation site in your local first.
2130

31+
In `$ZEPPELIN_HOME/docs`,
2232

23-
## Run website
33+
```
34+
bundle exec jekyll serve --watch
35+
```
2436

25-
bundle exec jekyll serve --watch
37+
Using the above command, Jekyll will start a web server at `http://localhost:4000` and watch the `/docs` directory to update.
2638

2739

28-
## Adding a new page
2940

30-
rake page name="new-page.md"
41+
## Contribute to Zeppelin documentation
42+
If you wish to help us and contribute to Zeppelin Documentation, please look at [Zeppelin Documentation's contribution guideline](https://github.com/apache/zeppelin/blob/master/docs/CONTRIBUTING.md).
3143

3244

33-
## Bumping up version in a new release
45+
## For committers only
46+
### Bumping up version in a new release
3447

3548
* `ZEPPELIN_VERSION` and `BASE_PATH` property in _config.yml
3649

37-
## Deploy to ASF svnpubsub infra (for committers only)
50+
### Deploy to ASF svnpubsub infra
3851
1. generate static website in `./_site`
52+
3953
```
4054
# go to /docs under Zeppelin source
4155
bundle exec jekyll build --safe

‎docs/_includes/themes/zeppelin/_navigation.html‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -105,6 +105,8 @@
105105
<li class="title"><span><b>Advanced</b><span></li>
106106
<li><a href="{{BASE_PATH}}/install/virtual_machine.html">Zeppelin on Vagrant VM</a></li>
107107
<li><a href="{{BASE_PATH}}/install/spark_cluster_mode.html#spark-standalone-mode">Zeppelin on Spark Cluster Mode (Standalone)</a></li>
108+
<li><a href="{{BASE_PATH}}/install/spark_cluster_mode.html#spark-standalone-mode">Zeppelin on Spark Cluster Mode (YARN)</a></li>
109+
<li><a href="{{BASE_PATH}}/install/spark_cluster_mode.html#spark-standalone-mode">Zeppelin on Spark Cluster Mode (Mesos)</a></li>
108110
<li role="separator" class="divider"></li>
109111
<li class="title"><span><b>Contibute</b><span></li>
110112
<li><a href="{{BASE_PATH}}/development/writingzeppelininterpreter.html">Writing Zeppelin Interpreter</a></li>

‎docs/assets/themes/zeppelin/img/available_interpreters.png‎

-50.4 KB
Loading

‎docs/assets/themes/zeppelin/img/docs-img/yarn_applications.png‎

95.2 KB
Loading

‎docs/assets/themes/zeppelin/img/docs-img/zeppelin_yarn_conf.png‎

212 KB
Loading

‎docs/index.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -170,6 +170,8 @@ Join to our [Mailing list](https://zeppelin.apache.org/community.html) and repor
170170
* Advanced
171171
* [Apache Zeppelin on Vagrant VM](./install/virtual_machine.html)
172172
* [Zeppelin on Spark Cluster Mode (Standalone via Docker)](./install/spark_cluster_mode.html#spark-standalone-mode)
173+
* [Zeppelin on Spark Cluster Mode (YARN via Docker)](./install/spark_cluster_mode.html#spark-yarn-mode)
174+
* [Zeppelin on Spark Cluster Mode (Mesos via Docker)](./install/spark_cluster_mode.html#spark-mesos-mode)
173175
* Contribute
174176
* [Writing Zeppelin Interpreter](./development/writingzeppelininterpreter.html)
175177
* [Writing Zeppelin Application (Experimental)](./development/writingzeppelinapplication.html)

0 commit comments

Comments
 (0)