Commit graph

9 commits

Author SHA1 Message Date
AhyoungRyu
85d4df4f0c [ZEPPELIN-1219] Add searching feature to Zeppelin docs site
### What is this PR for?
As more and more document pages are added, it's really hard to find specific pages. So I added searching feature to Zeppelin documentation site([jekyll](https://jekyllrb.com/) based site) using [lunr.js](http://lunrjs.com/).

 - **How does it work?**

  I created [`search_data.json`](6e02423f54/docs/search_data.json) which is used for docs info template. `lunr.js` combines all of the text from all of the docs in `docs/` into `_site/search_data.json`. It looks like below.
![screen shot 2016-08-03 at 4 49 59 am](https://cloud.githubusercontent.com/assets/10060731/17342828/f2908be8-5935-11e6-8eee-b189677c0531.png)
All the info are comes from [Jekyll YAML front matter](https://jekyllrb.com/docs/frontmatter/) variables. (i.e. title, group, description.. that's why I rewrote all docs' title and description.)
[search.js](6e02423f54/docs/assets/themes/zeppelin/js/search.js) will do this job using this data!

### What type of PR is it?
Improvement & Feature

### Todos
* [x] - Keep consistency for all docs pages' `Title`
* [x] - Add some overview sentences to all docs pages' `Description` section (this will be used as the result preview)
* [x] - Add apache license header to all docs page (some pages are missing the license header currently)
* [x] - Add LICENSE for `lunr.min.js`

### What is the Jira issue?
[ZEPPELIN-1219](https://issues.apache.org/jira/browse/ZEPPELIN-1219)

### How should this be tested?
1. Apply this patch and build `ZEPPELIN_HOME/docs` dir -> please see [docs/README.md#build-documentation](https://github.com/apache/zeppelin/tree/master/docs#build-documentation)
2. Click `search` icon in navbar and go to `search.html` page
3. Type anything you want to search in the search bar (i.e. type `python`, `spark`, `dynamic` ... )

### Screenshots (if appropriate)
![screen shot 2016-08-03 at 4 42 28 pm](https://cloud.githubusercontent.com/assets/10060731/17357851/d092e2ca-5999-11e6-9917-a3d4113e6e43.png)

![search](https://cloud.githubusercontent.com/assets/10060731/17357828/b2486cd6-5999-11e6-873b-121fac033b03.gif)

### Questions:
* Does the licenses files need update? Yes, for `lunr.min.js`
* Is there breaking changes for older versions? no
* Does this needs documentation? no

Author: AhyoungRyu <fbdkdud93@hanmail.net>

Closes #1266 from AhyoungRyu/ZEPPELIN-1219 and squashes the following commits:

7ec8854 [AhyoungRyu] Modify 'no result' sentence
91b71a7 [AhyoungRyu] Remove Apache license header since JSON doesn't allow comment
34afd5d [AhyoungRyu] Add Apache license header to search_data.json
6784282 [AhyoungRyu] Minor search page UI update
0389d28 [AhyoungRyu] Make index.md not to be searched
9f1ba42 [AhyoungRyu] Disable enterkey press & change icon
bd4956a [AhyoungRyu] Add docs.js & search.js to exclude list in pom.xml
624b051 [AhyoungRyu] Add Apache license header to search.js
1381152 [AhyoungRyu] Fix search result skipping issue
6e775f5 [AhyoungRyu] Make pleasecontribute.md not to be searched
ee11136 [AhyoungRyu] Fix some typos
fa01299 [AhyoungRyu] Refine 'description' in some docs as @bzz suggested
da0cff9 [AhyoungRyu] Exclude lunr.min.js
36ba7f1 [AhyoungRyu] Add lunr.min.js license info
f6a05a6 [AhyoungRyu] Apply css style for the search results
68eb997 [AhyoungRyu] Attach 'Apache Zeppelin ZEPPELIN_VERSION Documentation: ' to title
d908c37 [AhyoungRyu] Add searching page
a951fa6 [AhyoungRyu] Add search icon to navbar
0688a79 [AhyoungRyu] Keep consistency all docs' front matter for the right search result
040f532 [AhyoungRyu] Add template for storing docs info based on jekyll front matter
0705bd6 [AhyoungRyu] Add js files: lunr.min.js & search.js
2016-08-10 12:39:22 +09:00
AhyoungRyu
5975125f18 [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](d5e87fb8ba) and [this one](7d6cc7e991) )
* [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 <fbdkdud93@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
2016-06-25 22:57:44 -07:00
Mina Lee
70ab1a376d [ZEPPELIN-952] Refine website style
### What is this PR for?
- update document style (font, line-spacing)
- apply same formats for documents
- fix broke document styles

### What type of PR is it?
Documentation

### What is the Jira issue?
[ZEPPELIN-952](https://issues.apache.org/jira/browse/ZEPPELIN-952)

### Screenshots (if appropriate)
**Before**
<img width="1184" alt="screen shot 2016-06-04 at 9 51 38 pm" src="https://cloud.githubusercontent.com/assets/8503346/15803667/d0dd5ac2-2a9f-11e6-9ed0-ddc369a97612.png">

**After**
<img width="1184" alt="screen shot 2016-06-04 at 9 15 08 pm" src="https://cloud.githubusercontent.com/assets/8503346/15803666/cd9212ea-2a9f-11e6-986e-17992a495ab6.png">

**Before**
<img width="1183" alt="screen shot 2016-06-04 at 10 08 53 pm" src="https://cloud.githubusercontent.com/assets/8503346/15803695/03e73126-2aa1-11e6-8675-3ca437aeb833.png">

**After**
<img width="1184" alt="screen shot 2016-06-04 at 10 08 18 pm" src="https://cloud.githubusercontent.com/assets/8503346/15803696/078ce866-2aa1-11e6-9044-4f5e16649eb4.png">

**Before**
<img width="1184" alt="screen shot 2016-06-04 at 10 10 47 pm" src="https://cloud.githubusercontent.com/assets/8503346/15803704/5787e9ba-2aa1-11e6-804c-076a8f3aa852.png">

**After**
<img width="1184" alt="screen shot 2016-06-04 at 10 11 22 pm" src="https://cloud.githubusercontent.com/assets/8503346/15803707/5afb5d0c-2aa1-11e6-98c7-7440db35bd2f.png">

**Before**
<img width="188" alt="screen shot 2016-06-04 at 10 12 36 pm" src="https://cloud.githubusercontent.com/assets/8503346/15803719/92e5cc3e-2aa1-11e6-9a9f-e12150e78733.png">

**After**
<img width="199" alt="screen shot 2016-06-04 at 10 12 55 pm" src="https://cloud.githubusercontent.com/assets/8503346/15803721/958e8c00-2aa1-11e6-8768-8350db6e7173.png">

### Questions:
* Does the licenses files need update? No
* Is there breaking changes for older versions? No
* Does this needs documentation? No

Author: Mina Lee <minalee@nflabs.com>

Closes #962 from minahlee/ZEPPELIN-952 and squashes the following commits:

f9bee91 [Mina Lee] Capitalize hawq
72481bd [Mina Lee] Update doc titles
495a074 [Mina Lee] remove old style.css
27ca869 [Mina Lee] use code block for file location in spark.md
eb821f1 [Mina Lee] Change file location and rename file
72f8ec3 [Mina Lee] change storage doc layout and fix pre block
4202208 [Mina Lee] Apply same format for rest api docs
5875066 [Mina Lee] split display page into text and html
8bc5a6e [Mina Lee] prettify document
0cb953e [Mina Lee] remove incubating tag
2016-06-08 11:44:26 -07:00
Khalid Huseynov
8cde5c9bd4 ZeppelinHub notebook storage/connection repository
### What is this PR for?
This is to add [ZeppelinHub](https://www.zeppelinhub.com) notebook storage/connection layer to the Zeppelin.

### What type of PR is it?
Feature

### Todos
* [x] - NotebookRepo rest api
* [x] - ZeppelinHub websocket client
* [x] - Zeppelin websocket client
* [x] - Tests
* [x] - More QA (authentication consistency, etc.)
* [x] - Address review comments

### What is the Jira issue?

### How should this be tested?
First of all, you may need to create account in [ZeppelinHub](https://www.zeppelinhub.com).
Then you can set connection by following guides in [here](https://github.com/khalidhuseynov/incubator-zeppelin/blob/feat/zeppelinhub-storage/docs/storage/storage.md#notebook-storage-in-zeppelinhub--).
Finally you should be able to access and manipulate your notebooks from inside of your ZeppelinHub account.

### Screenshots (if appropriate)

### Questions:
* Does the licenses files need update? No
* Is there breaking changes for older versions? No
* Does this needs documentation? Yes

Author: Khalid Huseynov <khalidhnv@nflabs.com>
Author: Anthony Corbacho <corbacho.anthony@gmail.com>

Closes #880 from khalidhuseynov/feat/zeppelinhub-storage and squashes the following commits:

b480176 [Anthony Corbacho] Change debug log from info to error
db8d1e8 [Anthony Corbacho] Remove spave after comment
1c78d8c [Khalid Huseynov] address @bzz comments
b1fe8a3 [Khalid Huseynov] move jetty.version property to root
acf58d5 [Khalid Huseynov] address @AhyoungRyu comments
8de3d1f [Khalid Huseynov] add zeppelin  hearbeat
6c3aff2 [Khalid Huseynov] remove 074098eeb8ace6545c159d26657768079ae4b208 and ZeppelinHubConnection
efcfca3 [Khalid Huseynov] more docs
28f6bf7 [Khalid Huseynov] add authentication to zeppelin
1ca3d65 [Khalid Huseynov] scheduler service as singleton
32497dc [Anthony Corbacho] When user run a notebook, check if the websocket session exist, open it if close
36176ea [Anthony Corbacho] change log info to debug
8ad482d [Anthony Corbacho] Add routine to check ws connection to zeppelinhub is open, if not open it (keep trying)
27a4042 [Anthony Corbacho] rename fct hub -> ZeppelinHub
4c47e43 [Anthony Corbacho] code cleanup & walkthrough
636b9fa [Khalid Huseynov] fix tests
4b14a98 [Anthony Corbacho] add ASF headers
4ac8115 [Khalid Huseynov] add config info and docs
18ee802 [Khalid Huseynov] improve  repo tests
2d27ec6 [Khalid Huseynov] add zeppelinhub ws client test
ebcf692 [Khalid Huseynov] add zeppelin client tests
9f1b8bf [Khalid Huseynov] add zeppelin websocket client
1ce01ef [Khalid Huseynov] add rest package
45bec47 [Anthony Corbacho] add zeppelinhub websocket client
f8f168a [Anthony Corbacho] Add zeppelinhubmessage class + tests
a1c5f52 [Anthony Corbacho] prerequisite changes for starting websocket client
45ed9e1 [Khalid Huseynov] initial rest api
2016-05-28 12:13:11 -07:00
Khalid Huseynov
7d00af4daf Documentation for setting Azure notebook storage
### What is this PR for?
This PR adds general info and documentation on setting Azure storage in the `docs/storage.md` folder where we have info about all the supported pluggable storage layers.

### What type of PR is it?
Documentation

### Todos
* [x] - add docs
* [x] - change description and order in `zeppelin-site.xml.template`

### What is the Jira issue?

### How should this be tested?
Documentation follows the steps in `zeppelin-site.xml.template`. may need to have account to test.

### Screenshots (if appropriate)

### Questions:
* Does the licenses files need update? No
* Is there breaking changes for older versions? No
* Does this needs documentation? No

Author: Khalid Huseynov <khalidhnv@nflabs.com>

Closes #902 from khalidhuseynov/docs/azure-storage and squashes the following commits:

70b9f06 [Khalid Huseynov] address comments
f619fbe [Khalid Huseynov] add docs for azure in storage folder
2016-05-27 16:58:55 +09:00
Nate Sammons
db69e921b0 [ZEPPELIN-848] Add support for encrypted data stored in Amazon S3
### What is this PR for?
Adds support for using the AWS KMS or a custom encryption materials
provider class to encrypt data stored in Amazon S3.  Also a minor
improvement to logic inside the S3 notebook repo when dealing with local files.

### What type of PR is it?
Improvement

### What is the Jira issue?
https://issues.apache.org/jira/browse/ZEPPELIN-848

### How should this be tested?
Running in EMR or another system in AWS is easiest.  Make appropriate changes to the config and use an AWS KMS key

### Questions:
* Does the licenses files need update? -- NO
* Is there breaking changes for older versions? -- NO
* Does this needs documentation? -- YES, changes in storage.md and zeppelin-site.xml.template

Author: Nate Sammons <Nate.Sammons@nasdaq.com>
Author: Nate Sammons <nate.sammons@nasdaq.com>

Closes #886 from natesammons-nasdaq/master and squashes the following commits:

a6e074f [Nate Sammons] Merge remote-tracking branch 'origin/master'
cdd3107 [Nate Sammons] Merge remote-tracking branch 'apache/master'
48b89c0 [Nate Sammons] Update install.md
ff1540b [Nate Sammons] Merge remote-tracking branch 'apache/master'
84709c4 [Nate Sammons] Merge remote-tracking branch 'apache/master'
513361f [Nate Sammons] Update line length
b318c79 [Nate Sammons] Merge remote-tracking branch 'apache/master'
ceb5847 [Nate Sammons] Merge remote-tracking branch 'apache/master'
1475aa0 [Nate Sammons] Merge remote-tracking branch 'apache/master'
84ddd3b [Nate Sammons] Log exception when reloading notebooks
b55b98c [Nate Sammons] Updated exception handling
8628d95 [Nate Sammons] ZEPPELIN-848: Add support for encrypted data stored in Amazon S3
2016-05-26 13:55:47 -07:00
Cheng-Yu Hsu
a313e492c4 Fix typos in docs
### What is this PR for?

1. Fix some typos in docs.
2. Remove trailing white spaces for each line.
3. Remove leading white spaces if a line contains no content.
4. Add trailing new line for each file.

### What type of PR is it?
Improvement | Documentation

### Todos
None

### What is the Jira issue?
N/A

### How should this be tested?
Build the doc site and check.

### Screenshots (if appropriate)
N/A

### Questions:
* Does the licenses files need update? *no*
* Is there breaking changes for older versions? *no*
* Does this needs documentation? *no*

Author: Cheng-Yu Hsu <m@cyhsu.me>

Closes #852 from cyhsutw/fix-typos-in-docs and squashes the following commits:

6f5f46b [Cheng-Yu Hsu] fix typos in docs
2016-04-24 18:32:44 +09:00
Alexander Bezzubov
b5e2e62f23 ZEPPELIN-143: Git as a versioned notebook storage
This is very basic implementation of the [ZEPPELIN-143](https://issues.apache.org/jira/browse/ZEPPELIN-143) at the backend.

It makes a local git repository our of your `/notebook` dir and commits a new revision for each save/update.

It does not:
 - add any remotes to the git repo. It is totally possible to do that manually though. It would be interesting to add this later, to be able to push the notebook to hostings like GH
 - have any GUI modifications. It is left as further work, to add the ability for a user to switch "versions" of the notebook,  navigating between previous runs.

Feedback is very welcome!

Author: Alexander Bezzubov <bzz@apache.org>

Closes #497 from bzz/add-git-notebook-repo and squashes the following commits:

468a858 [Alexander Bezzubov] ZEPPELIN-143: add all new dependencies to LICENCE
5d7ffea [Alexander Bezzubov] ZEPPELIN-143: introduce NotebookRepo.close()
978e62c [Alexander Bezzubov] ZEPPELIN-143: muting down the logs
fca2300 [Alexander Bezzubov] ZEPPELIN-143: general Notebook storage doc update
94720d9 [Alexander Bezzubov] Merge branch 'master' into add-git-notebook-repo
85de737 [Alexander Bezzubov] ZEPPELIN-143: last-minute cleanup
8d66c51 [Alexander Bezzubov] ZEPPELIN-143: docs and conf updated
274830f [Alexander Bezzubov] ZEPPELIN-143: .history() implemented
4ef879a [Alexander Bezzubov] ZEPPELIN-143: initial repo creation + tests
bdee039 [Alexander Bezzubov] ZEPPELIN-143: simple case save() implemented
20a93a4 [Alexander Bezzubov] ZEPPELIN-143: adding JGit as initial impl
c21b3e6 [Alexander Bezzubov] ZEPPELIN-143: WIP - very basic sketch of GitNotebookRepo
cf0b4bc [Alexander Bezzubov] Small cleanup: JavaDoc, annotations, warning for NotebookRepos
2015-12-08 10:57:30 +09:00
Lee moon soo
c2cbafd1d8 ZEPPELIN-412 Documentation based on Zeppelin version
https://issues.apache.org/jira/browse/ZEPPELIN-412

To provide documentation based on Zeppelin version, like Spark, Flink project does, it need to separate documentations from website.

* docs will be kept in Zeppelin main source tree and being built and published under 'docs' menu on website with specific version number.
* website will be kept in gh-pages branch and provides menu for multiple version of docs.

This PR removes unnecessary pages, which is provided by website. (for example download page)

This is the screenshot after applying this PR

![image](https://cloud.githubusercontent.com/assets/1540981/11163334/53a14c7a-8b0e-11e5-80cb-961bb8a15faa.png)

![image](https://cloud.githubusercontent.com/assets/1540981/11163335/5acc9f22-8b0e-11e5-8329-273bee738cc9.png)

Author: Lee moon soo <moon@apache.org>

Closes #430 from Leemoonsoo/ZEPPELIN-412 and squashes the following commits:

35da7f2 [Lee moon soo] Remove docs dir
5e4ce12 [Lee moon soo] Update readme
0635cbb [Lee moon soo] Remove unnecessary pages
e21cdd2 [Lee moon soo] Style font size
b5fe812 [Lee moon soo] Change title to overview
469b850 [Lee moon soo] Get remove unnecessary menu
2015-11-18 09:08:54 +09:00