Commit graph

5 commits

Author SHA1 Message Date
AhyoungRyu
8f344db93e [ZEPPELIN-1421] Fix dead link in docs/README.md
### What is this PR for?
There is a dead link in [docs/README.md](https://github.com/apache/zeppelin/blob/master/docs/README.md).

It should be `https://zeppelin.apache.org/docs/latest/` not `https://zeppelin.apache.org/docs/latest`

### What type of PR is it?
Bug Fix

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

### How should this be tested?
 - Before [https://zeppelin.apache.org/docs/latest](https://zeppelin.apache.org/docs/latest)
 - After [https://zeppelin.apache.org/docs/latest/](https://zeppelin.apache.org/docs/latest/)

### 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: AhyoungRyu <fbdkdud93@hanmail.net>

Closes #1420 from AhyoungRyu/ZEPPELIN-1421 and squashes the following commits:

57336f8 [AhyoungRyu] Remove BASE_PATH in some docs pages
311e2ef [AhyoungRyu] Fix dead link in docs/README.md
2016-09-19 15:50:43 +09:00
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
Rohit Choudhary
b86148c614 [ZEPPELIN-1149] %sh interpreter kerberos support
### What is this PR for?
Zeppelin Shell interpreter should work in a Kerberos environment

### What type of PR is it?
[Feature]

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

### How should this be tested?
In JDBC interpreter setting add following properties

 - shell.auth.type = KERBEROS
 - shell.principal = principal value
 - shell.keytab.location = keytab location

Now try and run any shell command (example: hdfs dfs -ls) it should return with valid results.

### 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: Rohit Choudhary <rconline@gmail.com>

Closes #1163 from rconline/ZEPPELIN-1149 and squashes the following commits:

f6af0f6 [Rohit Choudhary] typo fix
3648a1c [Rohit Choudhary] fix CI, resolve merge conflict
1924b99 [Rohit Choudhary] Merge remote-tracking branch 'origin/master' into ZEPPELIN-1149
9143b47 [Rohit Choudhary] Removed Hadoop common dependency and changed switch to String based Kerberos/Simple.
60e6d21 [Rohit Choudhary] Addressing feedback from felixcheung
b0300e8 [Rohit Choudhary] changing property name to "zeppelin.*" to make it match with rest of the project.
0a77e80 [Rohit Choudhary] shell interpreter doc
5190791 [Rohit Choudhary] [ZEPPELIN-1149] %sh interpreter kerberos support
2016-07-25 10:39:56 +05:30
AhyoungRyu
6bd4ede7e5 [DOC][MINOR] Add shell interpreter docs to _navigation.html
### What is this PR for?
After #1087 merged, a new docs `shell.md` was added. But in the docs website, still Shell interpreter link points to `pleasecontribute.html`. So I changed this link, applied TOC and added more descriptions.

### What type of PR is it?
Documentation

### Todos
* [x] - Change `pleasecontribute.html` -> `shell.html`
* [x] - Apply TOC(table of contents)
* [x] - Add more description to `shell.md`

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

Author: AhyoungRyu <fbdkdud93@hanmail.net>

Closes #1138 from AhyoungRyu/improve/shell-docs and squashes the following commits:

69d567d [AhyoungRyu] Address @felixcheung feedback
fca76a6 [AhyoungRyu] Apply TOC to rest-credential.md
c8e988b [AhyoungRyu] Change docs group manual -> interpreter
a0bf1d5 [AhyoungRyu] Add shell.html to _navigation.html
2016-07-13 00:08:06 +09:00
fvaleri
e575e812f0 Shell interpreter test and doc
### What is this PR for?
Small refactoring to Shell interpreter.
Add missing unit test and initial doc.

### What type of PR is it?
Improvement, Documentation, Refactoring

### Todos
* [ ] - Task

### What is the Jira issue?
* Open an issue on Jira https://issues.apache.org/jira/browse/ZEPPELIN/
* Put link here, and add [ZEPPELIN-*Jira number*] in PR title, eg. [ZEPPELIN-533]

### How should this be tested?
Outline the steps to test the PR here.

### 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: fvaleri <fedevaleri@gmail.com>

Closes #1087 from fvaleri/shell-intepreter-test and squashes the following commits:

56bb663 [fvaleri] re-trigger CI
e4b25ef [fvaleri] re-trigger CI
9b9487b [fvaleri] re-trigger CI
03d073f [fvaleri] remove unused imports
7c42733 [fvaleri] Add new interpreter registration mechanism
c069074 [fvaleri] rebase
2016-07-01 14:55:49 +09:00