mirror of
https://github.com/apache/zeppelin
synced 2026-05-24 09:38:26 +00:00
9 commits
| Author | SHA1 | Message | Date | |
|---|---|---|---|---|
1ambda
|
4b6d3e5574 |
[ZEPPELIN-2596] Improving documentation page
### What is this PR for? Improving documentation page. Please check *TODO* and *Screenshots* sections for detail. The motivation is described in [the JIRA ticket](https://issues.apache.org/jira/browse/ZEPPELIN-2583) and discussion is ongoing on the mailing list. ### What type of PR is it? [Improvement | Documentation] ### Todos * [x] - improved the navbar style * [x] - improved the main page * [x] - re-organized content structure * [x] - added tutorial pages: `spark_with_zeppelin.md`, `python_with_zeppelin.md`, `sql_with_zeppelin.md` for overview * [x] - added `multi_user_support.md` page to provide overview * [x] - added the empty `interpreter_binding_mode` page. This will be handed in the different issue: [ZEPPELIN-2582](https://issues.apache.org/jira/browse/ZEPPELIN-2582) * [x] - added the empty `trouble_shooting` page. This can be filled in the following PRs. * [x] - added the empty `useful_developer_tools` page. This can be filled in the following PRs. ### What is the Jira issue? [ZEPPELIN-2596](https://issues.apache.org/jira/browse/ZEPPELIN-2596) ### How should this be tested? 1. checkout 2. `cd docs` 3. `bundle install` (make sure that you have ruby 2.1.0+ and bundle) 4. `bundle exec jekyll serve --watch` 5. open `localhost:4000` ### Screenshots (if appropriate) #### better navbar: before  #### better navbar: after  #### improved main page: before  #### improved main page: after  #### organized content structure: before  #### organized content structure: after  ### Questions: * Does the licenses files need update? - NO * Is there breaking changes for older versions? - NO * Does this needs documentation? - related with docs Author: 1ambda <1amb4a@gmail.com> Closes #2371 from 1ambda/updating-version-doc and squashes the following commits: |
||
|
Jongyoul Lee
|
9d90ccca69 |
[ZEPPELIN-2003] Remove PostgresqlInterpreter
### What is this PR for? We don't have to maintain PostgresqlInterpreter because JDBCInterpreter covers all functions of PostgresqlInterpreter. It reduces maintenance costs. ### What type of PR is it? [Feature] ### Todos * [x] - Remove files and lines related to PostgresqlInterpreter ### What is the Jira issue? * https://issues.apache.org/jira/browse/ZEPPELIN-2003 ### How should this be tested? N/A ### Screenshots (if appropriate) ### Questions: * Does the licenses files need update? No * Is there breaking changes for older versions? Yes * Does this needs documentation? Yes, but already documented in jdbc docs Author: Jongyoul Lee <jongyoul@gmail.com> Closes #1945 from jongyoul/ZEPPELIN-2003 and squashes the following commits: |
||
|
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`]( |
||
|
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: |
||
|
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]( |
||
|
Jongyoul Lee
|
ccd8a49acc |
ZEPPELIN-614 Part 1. Merge PostgresqlInterpreter's sql completer into JDBC Interpreter
### What is this PR for? Supporting Sql completer into JDBC Interpreter which is merged by the function of Postgresql Interpreter. And this is the first step to merge Postgresql into generic JDBC Interpreter ### What type of PR is it? [Improvement] ### Todos * [x] - Adopted the function of auto completion ### What is the Jira issue? * https://issues.apache.org/jira/browse/ZEPPELIN-614 ### How should this be tested? ### Screenshots (if appropriate) <img width="1054" alt="screen shot 2016-06-08 at 3 00 54 pm" src="https://cloud.githubusercontent.com/assets/3612566/15884224/e241f6b4-2d89-11e6-9746-8c8951ef6708.png"> <img width="474" alt="screen shot 2016-06-08 at 2 45 50 pm" src="https://cloud.githubusercontent.com/assets/3612566/15884229/e7993e24-2d89-11e6-9f5b-018e6eac7f6a.png"> ### Questions: * Does the licenses files need update? No * Is there breaking changes for older versions? No * Does this needs documentation? No Author: Jongyoul Lee <jongyoul@gmail.com> Closes #974 from jongyoul/ZEPPELIN-614 and squashes the following commits: |
||
|
Jesang Yoon
|
0d157aebd2 |
Fix styles of documentation about interpreters
Due to the documentation of interpreters written by various authors, styles of documentations are vary and has broken tags and inconsistent spaces. This fix cleans those little glitches to make documentation more readable and look cleaner to users. 1) Clean up unnecessary or wrong HTML tags ex: \<hr/\> after titles 2) Fix too wide spaces between paragraph and tables 3) Remove unnecessary spaces at end of paragraph and lines Author: Jesang Yoon <yoonjs2@kanizsalab.com> Closes #648 from yoonjs2/master and squashes the following commits: |
||
|
Felix Cheung
|
4b55a9c023 |
[ZEPPELIN-466][DOCS] fix typos PostgreSQL doc
just notice this has typos too Author: Felix Cheung <felixcheung_m@hotmail.com> Closes #475 from felixcheung/postgresdoc and squashes the following commits: |
||
|
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   Author: Lee moon soo <moon@apache.org> Closes #430 from Leemoonsoo/ZEPPELIN-412 and squashes the following commits: |
Renamed from docs/docs/interpreter/postgresql.md (Browse further)