zeppelin/docs/usage/display_system/basic.md

164 lines
6.2 KiB
Markdown
Raw Normal View History

---
layout: page
[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`](https://github.com/AhyoungRyu/zeppelin/blob/6e02423f541cc406e4e41031629609a276a9f481/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](https://github.com/AhyoungRyu/zeppelin/blob/6e02423f541cc406e4e41031629609a276a9f481/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-06 05:50:25 +00:00
title: "Basic Display System in Apache Zeppelin"
description: "There are 3 basic display systems in Apache Zeppelin. By default, Zeppelin prints interpreter responce as a plain text using text display system. With %html directive, Zeppelin treats your output as HTML. You can also simply use %table display system to leverage Zeppelin's built in visualization."
[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 ![2596_before_nav](https://cloud.githubusercontent.com/assets/4968473/26542353/89004e7a-4494-11e7-89c0-28d608f5f375.gif) #### better navbar: after ![2596_after_nav](https://cloud.githubusercontent.com/assets/4968473/26542356/8bfb7b90-4494-11e7-9979-0bcaef8ba97b.gif) #### improved main page: before ![2596_before_main](https://cloud.githubusercontent.com/assets/4968473/26542358/8f35b0be-4494-11e7-8a6c-e74ec52fc384.gif) #### improved main page: after ![2596_after_main](https://cloud.githubusercontent.com/assets/4968473/26542366/93b333c8-4494-11e7-981f-3f7b4545868f.gif) #### organized content structure: before ![2596_before_content](https://cloud.githubusercontent.com/assets/4968473/26542398/ad81ac26-4494-11e7-9a17-70dff41396fb.gif) #### organized content structure: after ![2596_after_content](https://cloud.githubusercontent.com/assets/4968473/26542403/b0a42ad2-4494-11e7-8bd3-8a5bd194c6af.gif) ### 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: eb02fa967 [1ambda] fix: navbar focus color applies after folding 026379ed6 [1ambda] fix: Remove docs/.listen_test a7dd4737b [1ambda] fix: sora's comment 1.2 18c5058f7 [1ambda] fix: resolve description in python_with_zeppelin.md d3ad67c73 [1ambda] fix: sora's comment 4 d133dbbcc [1ambda] fix: resolve sora's comment 3 513c6ff2c [1ambda] fix: resolve sora's comment 1.1 4c2946928 [1ambda] fix: resovle sora's comment 2 1c3946ac6 [1ambda] fix: sora's comment 1 4d6e4267f [1ambda] fix: Resolve sola's comment 3 d0524cafe [1ambda] fix: Set less shadow for nav 5f1f998ba [1ambda] docs: Add useful_develop_tools.md 9dfd62c74 [1ambda] fix: Typo in installation.md 30f7d7e06 [1ambda] fix: Typo in helium ctrl d6877e792 [1ambda] docs: Add python_with_zeppelin.md 7027e96c0 [1ambda] docs: Improve python conda, docker doc style e55b50a9d [1ambda] fix: Invalid URLs 75ddeeaff [1ambda] docs: replace URIs in interpreter 5b43993a4 [1ambda] docs: Add sql_with_zeppelin 053794e84 [1ambda] docs: Add spark_with_zeppelin.md d4d88b9c7 [1ambda] docs: Improve proxy doc b46cdd126 [1ambda] docs: Add empty interpreter_binding_mode.md 06fcb239e [1ambda] docs: Add empty personalized_mode.md 4991cf0a7 [1ambda] docs: Update upgrading.md 53142b7a0 [1ambda] fix: Simplify install.md 8a5c1e721 [1ambda] docs: Add multi_user_support.md 34095775e [1ambda] fix: Increase font size to 15px a03b04b33 [1ambda] fix: Remove sample text from trouble_shooting.md 199842590 [1ambda] fix: Remove docker doc link 66a2a7d26 [1ambda] docs: Improve impersonation page 0a6e3fc1d [1ambda] docs: Improve install doc ccd999ed5 [1ambda] docs: Improve helium doc f8d742d08 [1ambda] fix: an invalid link in navbar b7aa5f884 [1ambda] fix: URLs in development 61a175d94 [1ambda] docs: Update install.md 4c56de5c4 [1ambda] fix: URLs in setup 0b1d63513 [1ambda] fix: URLs in quickstart 28970a4fe [1ambda] feat: Add docs/usage 735946bca [1ambda] feat: rename /quickstart b351cf237 [1ambda] fix: Add missing links b70770b4f [1ambda] feat: Change URLs in nav, index 94e80aef6 [1ambda] fix: doens't display navbar version in small 6e0cab110 [1ambda] feat: Update doc section names b9ce256ff [1ambda] feat: Hide version in navbar when md f8bab52be [1ambda] fix: Better image display in index.md eeb37d5b5 [1ambda] fix: Add RL padding for mobile browser ceb60b5ee [1ambda] feat: Style collapsed nav for mobile browser 4ebafb4b6 [1ambda] commit
2017-06-19 10:13:57 +00:00
group: usage/display_system
---
<!--
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 %}
[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](https://github.com/apache/zeppelin/commit/d5e87fb8ba98f08db5b0a4995104ce19f182c678) and [this one](https://github.com/apache/zeppelin/commit/7d6cc7e99154e2d337c11fdf8be1a874ed3e9ada) ) * [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 19:44:53 +00:00
# Basic Display System in Apache Zeppelin
<div id="toc"></div>
[ZEPPELIN-996] Improve first page and dropdown menu in documentation site ### What is this PR for? Current Zeppelin documentation site is little bit hard to find a way for Zeppelin beginners. It will not easy to improve this at a time, but I did the below as a start of this work. 1. Restructured dropdown menu and added each category names 2. Added a overview list(with short description) to first page of website (index.md) so that people can look through the overall contents in Zeppelin website at a glance. (as [Apache Spark](http://spark.apache.org/docs/latest/#where-to-go-from-here) and [Apache Mesos](http://mesos.apache.org/documentation/latest/) does) Please see the attached screenshot images :) ### What type of PR is it? Improvement & Documentation ### Todos * [x] - Change outdated screenshot images * [x] - Combine `text.md`, `table.md` and `html.md` to `basicdisplaysystem.md` * [x] - Fix dead link in `virtual_machine.md` * [x] - Improve dropdown menu and reorder * [x] - Improve first page(`index.md`) * [x] - Combine with #995 after it is merged into master ### What is the Jira issue? [ZEPPELIN-996](https://issues.apache.org/jira/browse/ZEPPELIN-996) ### How should this be tested? 1. Apply this patch and [build the docs website with jekyll](https://github.com/apache/zeppelin/tree/master/docs#build-documentation) 2. Check the first page(index.html) and dropdown menu ### Screenshots (if appropriate) - Dropdown menu ![dropdown](https://cloud.githubusercontent.com/assets/10060731/16061421/b44f8034-3241-11e6-88fd-43aa5031b453.gif) - First page <img width="717" alt="screen shot 2016-06-14 at 1 28 58 pm" src="https://cloud.githubusercontent.com/assets/10060731/16058631/3ab2cb6c-3234-11e6-95f4-180290df3d02.png"> <img width="694" alt="screen shot 2016-06-14 at 1 29 11 pm" src="https://cloud.githubusercontent.com/assets/10060731/16058639/43d68918-3234-11e6-921c-28436bfca33d.png"> <img width="649" alt="screen shot 2016-06-14 at 1 29 39 pm" src="https://cloud.githubusercontent.com/assets/10060731/16058650/501ec6d6-3234-11e6-9292-53ae84acc18a.png"> <img width="684" alt="screen shot 2016-06-14 at 1 29 57 pm" src="https://cloud.githubusercontent.com/assets/10060731/16058643/4637c8f2-3234-11e6-9b12-a233906f4c8b.png"> <img width="650" alt="screen shot 2016-06-14 at 1 30 12 pm" src="https://cloud.githubusercontent.com/assets/10060731/16058655/56c5af22-3234-11e6-8d29-9b7937728948.png"> <img width="636" alt="screen shot 2016-06-14 at 1 30 22 pm" src="https://cloud.githubusercontent.com/assets/10060731/16058656/58d1187e-3234-11e6-9171-ab7390b4a526.png"> ### 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 #1004 from AhyoungRyu/ZEPPELIN-996 and squashes the following commits: 1dbf805 [AhyoungRyu] Add 'Apache' before 'Zeppelin' 6153a50 [AhyoungRyu] Remove useless dash 61a5ad6 [AhyoungRyu] Revert to Text -> HTML -> Table in navbar 1886f8c [AhyoungRyu] Fix indentation af70939 [AhyoungRyu] Apply scrollable menu to 'more' tab & fix UI issue 2654d92 [AhyoungRyu] Combine overflow-x & overflow-y to overflow 904acd6 [AhyoungRyu] Resize dropdown menu maxheight 6e62e31 [AhyoungRyu] Change dynamicform image 230c670 [AhyoungRyu] Revert to Text -> HTML -> Table ad53799 [AhyoungRyu] Adjust image size c75c3a0 [AhyoungRyu] Add HDFS logo to available interpreter image 6a2f40b [AhyoungRyu] Address @bzz feedback 649a14d [AhyoungRyu] Address @coureadoug feedback 67cff3a [AhyoungRyu] Add all documentation list with short description to first page ce4b122 [AhyoungRyu] Limit image width 6ff4db6 [AhyoungRyu] Improve dropdown menu and reorder menus 61da430 [AhyoungRyu] Fix dead link in virtual_machine.md 6251558 [AhyoungRyu] Change 'Zeppelin Configuration' section placement so that it can be separated 4eecab8 [AhyoungRyu] Combine text.md, html.md, table.md 4d021af [AhyoungRyu] Delete outdated images and add new images
2016-06-14 21:52:46 +00:00
## Text
By default, Apache Zeppelin prints interpreter response as a plain text using `text` display system.
[ZEPPELIN-996] Improve first page and dropdown menu in documentation site ### What is this PR for? Current Zeppelin documentation site is little bit hard to find a way for Zeppelin beginners. It will not easy to improve this at a time, but I did the below as a start of this work. 1. Restructured dropdown menu and added each category names 2. Added a overview list(with short description) to first page of website (index.md) so that people can look through the overall contents in Zeppelin website at a glance. (as [Apache Spark](http://spark.apache.org/docs/latest/#where-to-go-from-here) and [Apache Mesos](http://mesos.apache.org/documentation/latest/) does) Please see the attached screenshot images :) ### What type of PR is it? Improvement & Documentation ### Todos * [x] - Change outdated screenshot images * [x] - Combine `text.md`, `table.md` and `html.md` to `basicdisplaysystem.md` * [x] - Fix dead link in `virtual_machine.md` * [x] - Improve dropdown menu and reorder * [x] - Improve first page(`index.md`) * [x] - Combine with #995 after it is merged into master ### What is the Jira issue? [ZEPPELIN-996](https://issues.apache.org/jira/browse/ZEPPELIN-996) ### How should this be tested? 1. Apply this patch and [build the docs website with jekyll](https://github.com/apache/zeppelin/tree/master/docs#build-documentation) 2. Check the first page(index.html) and dropdown menu ### Screenshots (if appropriate) - Dropdown menu ![dropdown](https://cloud.githubusercontent.com/assets/10060731/16061421/b44f8034-3241-11e6-88fd-43aa5031b453.gif) - First page <img width="717" alt="screen shot 2016-06-14 at 1 28 58 pm" src="https://cloud.githubusercontent.com/assets/10060731/16058631/3ab2cb6c-3234-11e6-95f4-180290df3d02.png"> <img width="694" alt="screen shot 2016-06-14 at 1 29 11 pm" src="https://cloud.githubusercontent.com/assets/10060731/16058639/43d68918-3234-11e6-921c-28436bfca33d.png"> <img width="649" alt="screen shot 2016-06-14 at 1 29 39 pm" src="https://cloud.githubusercontent.com/assets/10060731/16058650/501ec6d6-3234-11e6-9292-53ae84acc18a.png"> <img width="684" alt="screen shot 2016-06-14 at 1 29 57 pm" src="https://cloud.githubusercontent.com/assets/10060731/16058643/4637c8f2-3234-11e6-9b12-a233906f4c8b.png"> <img width="650" alt="screen shot 2016-06-14 at 1 30 12 pm" src="https://cloud.githubusercontent.com/assets/10060731/16058655/56c5af22-3234-11e6-8d29-9b7937728948.png"> <img width="636" alt="screen shot 2016-06-14 at 1 30 22 pm" src="https://cloud.githubusercontent.com/assets/10060731/16058656/58d1187e-3234-11e6-9171-ab7390b4a526.png"> ### 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 #1004 from AhyoungRyu/ZEPPELIN-996 and squashes the following commits: 1dbf805 [AhyoungRyu] Add 'Apache' before 'Zeppelin' 6153a50 [AhyoungRyu] Remove useless dash 61a5ad6 [AhyoungRyu] Revert to Text -> HTML -> Table in navbar 1886f8c [AhyoungRyu] Fix indentation af70939 [AhyoungRyu] Apply scrollable menu to 'more' tab & fix UI issue 2654d92 [AhyoungRyu] Combine overflow-x & overflow-y to overflow 904acd6 [AhyoungRyu] Resize dropdown menu maxheight 6e62e31 [AhyoungRyu] Change dynamicform image 230c670 [AhyoungRyu] Revert to Text -> HTML -> Table ad53799 [AhyoungRyu] Adjust image size c75c3a0 [AhyoungRyu] Add HDFS logo to available interpreter image 6a2f40b [AhyoungRyu] Address @bzz feedback 649a14d [AhyoungRyu] Address @coureadoug feedback 67cff3a [AhyoungRyu] Add all documentation list with short description to first page ce4b122 [AhyoungRyu] Limit image width 6ff4db6 [AhyoungRyu] Improve dropdown menu and reorder menus 61da430 [AhyoungRyu] Fix dead link in virtual_machine.md 6251558 [AhyoungRyu] Change 'Zeppelin Configuration' section placement so that it can be separated 4eecab8 [AhyoungRyu] Combine text.md, html.md, table.md 4d021af [AhyoungRyu] Delete outdated images and add new images
2016-06-14 21:52:46 +00:00
[ZEPPELIN-2707][DOCS][HOTFIX] fix: broken image URLs in 0.8.0-SNAPSHOT doc ### 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 ![image](https://user-images.githubusercontent.com/4968473/27685112-bcca5846-5d07-11e7-89bb-3965015cf5a5.png) #### After ![image](https://user-images.githubusercontent.com/4968473/27685218-3490fad8-5d08-11e7-9133-0e148689986e.png) ### 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
2017-06-29 11:13:41 +00:00
<img src="{{BASE_PATH}}/assets/themes/zeppelin/img/screenshots/display_text.png" />
[ZEPPELIN-996] Improve first page and dropdown menu in documentation site ### What is this PR for? Current Zeppelin documentation site is little bit hard to find a way for Zeppelin beginners. It will not easy to improve this at a time, but I did the below as a start of this work. 1. Restructured dropdown menu and added each category names 2. Added a overview list(with short description) to first page of website (index.md) so that people can look through the overall contents in Zeppelin website at a glance. (as [Apache Spark](http://spark.apache.org/docs/latest/#where-to-go-from-here) and [Apache Mesos](http://mesos.apache.org/documentation/latest/) does) Please see the attached screenshot images :) ### What type of PR is it? Improvement & Documentation ### Todos * [x] - Change outdated screenshot images * [x] - Combine `text.md`, `table.md` and `html.md` to `basicdisplaysystem.md` * [x] - Fix dead link in `virtual_machine.md` * [x] - Improve dropdown menu and reorder * [x] - Improve first page(`index.md`) * [x] - Combine with #995 after it is merged into master ### What is the Jira issue? [ZEPPELIN-996](https://issues.apache.org/jira/browse/ZEPPELIN-996) ### How should this be tested? 1. Apply this patch and [build the docs website with jekyll](https://github.com/apache/zeppelin/tree/master/docs#build-documentation) 2. Check the first page(index.html) and dropdown menu ### Screenshots (if appropriate) - Dropdown menu ![dropdown](https://cloud.githubusercontent.com/assets/10060731/16061421/b44f8034-3241-11e6-88fd-43aa5031b453.gif) - First page <img width="717" alt="screen shot 2016-06-14 at 1 28 58 pm" src="https://cloud.githubusercontent.com/assets/10060731/16058631/3ab2cb6c-3234-11e6-95f4-180290df3d02.png"> <img width="694" alt="screen shot 2016-06-14 at 1 29 11 pm" src="https://cloud.githubusercontent.com/assets/10060731/16058639/43d68918-3234-11e6-921c-28436bfca33d.png"> <img width="649" alt="screen shot 2016-06-14 at 1 29 39 pm" src="https://cloud.githubusercontent.com/assets/10060731/16058650/501ec6d6-3234-11e6-9292-53ae84acc18a.png"> <img width="684" alt="screen shot 2016-06-14 at 1 29 57 pm" src="https://cloud.githubusercontent.com/assets/10060731/16058643/4637c8f2-3234-11e6-9b12-a233906f4c8b.png"> <img width="650" alt="screen shot 2016-06-14 at 1 30 12 pm" src="https://cloud.githubusercontent.com/assets/10060731/16058655/56c5af22-3234-11e6-8d29-9b7937728948.png"> <img width="636" alt="screen shot 2016-06-14 at 1 30 22 pm" src="https://cloud.githubusercontent.com/assets/10060731/16058656/58d1187e-3234-11e6-9171-ab7390b4a526.png"> ### 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 #1004 from AhyoungRyu/ZEPPELIN-996 and squashes the following commits: 1dbf805 [AhyoungRyu] Add 'Apache' before 'Zeppelin' 6153a50 [AhyoungRyu] Remove useless dash 61a5ad6 [AhyoungRyu] Revert to Text -> HTML -> Table in navbar 1886f8c [AhyoungRyu] Fix indentation af70939 [AhyoungRyu] Apply scrollable menu to 'more' tab & fix UI issue 2654d92 [AhyoungRyu] Combine overflow-x & overflow-y to overflow 904acd6 [AhyoungRyu] Resize dropdown menu maxheight 6e62e31 [AhyoungRyu] Change dynamicform image 230c670 [AhyoungRyu] Revert to Text -> HTML -> Table ad53799 [AhyoungRyu] Adjust image size c75c3a0 [AhyoungRyu] Add HDFS logo to available interpreter image 6a2f40b [AhyoungRyu] Address @bzz feedback 649a14d [AhyoungRyu] Address @coureadoug feedback 67cff3a [AhyoungRyu] Add all documentation list with short description to first page ce4b122 [AhyoungRyu] Limit image width 6ff4db6 [AhyoungRyu] Improve dropdown menu and reorder menus 61da430 [AhyoungRyu] Fix dead link in virtual_machine.md 6251558 [AhyoungRyu] Change 'Zeppelin Configuration' section placement so that it can be separated 4eecab8 [AhyoungRyu] Combine text.md, html.md, table.md 4d021af [AhyoungRyu] Delete outdated images and add new images
2016-06-14 21:52:46 +00:00
You can explicitly say you're using `text` display system.
[ZEPPELIN-2707][DOCS][HOTFIX] fix: broken image URLs in 0.8.0-SNAPSHOT doc ### 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 ![image](https://user-images.githubusercontent.com/4968473/27685112-bcca5846-5d07-11e7-89bb-3965015cf5a5.png) #### After ![image](https://user-images.githubusercontent.com/4968473/27685218-3490fad8-5d08-11e7-9133-0e148689986e.png) ### 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
2017-06-29 11:13:41 +00:00
<img src="{{BASE_PATH}}/assets/themes/zeppelin/img/screenshots/display_text1.png" />
[ZEPPELIN-996] Improve first page and dropdown menu in documentation site ### What is this PR for? Current Zeppelin documentation site is little bit hard to find a way for Zeppelin beginners. It will not easy to improve this at a time, but I did the below as a start of this work. 1. Restructured dropdown menu and added each category names 2. Added a overview list(with short description) to first page of website (index.md) so that people can look through the overall contents in Zeppelin website at a glance. (as [Apache Spark](http://spark.apache.org/docs/latest/#where-to-go-from-here) and [Apache Mesos](http://mesos.apache.org/documentation/latest/) does) Please see the attached screenshot images :) ### What type of PR is it? Improvement & Documentation ### Todos * [x] - Change outdated screenshot images * [x] - Combine `text.md`, `table.md` and `html.md` to `basicdisplaysystem.md` * [x] - Fix dead link in `virtual_machine.md` * [x] - Improve dropdown menu and reorder * [x] - Improve first page(`index.md`) * [x] - Combine with #995 after it is merged into master ### What is the Jira issue? [ZEPPELIN-996](https://issues.apache.org/jira/browse/ZEPPELIN-996) ### How should this be tested? 1. Apply this patch and [build the docs website with jekyll](https://github.com/apache/zeppelin/tree/master/docs#build-documentation) 2. Check the first page(index.html) and dropdown menu ### Screenshots (if appropriate) - Dropdown menu ![dropdown](https://cloud.githubusercontent.com/assets/10060731/16061421/b44f8034-3241-11e6-88fd-43aa5031b453.gif) - First page <img width="717" alt="screen shot 2016-06-14 at 1 28 58 pm" src="https://cloud.githubusercontent.com/assets/10060731/16058631/3ab2cb6c-3234-11e6-95f4-180290df3d02.png"> <img width="694" alt="screen shot 2016-06-14 at 1 29 11 pm" src="https://cloud.githubusercontent.com/assets/10060731/16058639/43d68918-3234-11e6-921c-28436bfca33d.png"> <img width="649" alt="screen shot 2016-06-14 at 1 29 39 pm" src="https://cloud.githubusercontent.com/assets/10060731/16058650/501ec6d6-3234-11e6-9292-53ae84acc18a.png"> <img width="684" alt="screen shot 2016-06-14 at 1 29 57 pm" src="https://cloud.githubusercontent.com/assets/10060731/16058643/4637c8f2-3234-11e6-9b12-a233906f4c8b.png"> <img width="650" alt="screen shot 2016-06-14 at 1 30 12 pm" src="https://cloud.githubusercontent.com/assets/10060731/16058655/56c5af22-3234-11e6-8d29-9b7937728948.png"> <img width="636" alt="screen shot 2016-06-14 at 1 30 22 pm" src="https://cloud.githubusercontent.com/assets/10060731/16058656/58d1187e-3234-11e6-9171-ab7390b4a526.png"> ### 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 #1004 from AhyoungRyu/ZEPPELIN-996 and squashes the following commits: 1dbf805 [AhyoungRyu] Add 'Apache' before 'Zeppelin' 6153a50 [AhyoungRyu] Remove useless dash 61a5ad6 [AhyoungRyu] Revert to Text -> HTML -> Table in navbar 1886f8c [AhyoungRyu] Fix indentation af70939 [AhyoungRyu] Apply scrollable menu to 'more' tab & fix UI issue 2654d92 [AhyoungRyu] Combine overflow-x & overflow-y to overflow 904acd6 [AhyoungRyu] Resize dropdown menu maxheight 6e62e31 [AhyoungRyu] Change dynamicform image 230c670 [AhyoungRyu] Revert to Text -> HTML -> Table ad53799 [AhyoungRyu] Adjust image size c75c3a0 [AhyoungRyu] Add HDFS logo to available interpreter image 6a2f40b [AhyoungRyu] Address @bzz feedback 649a14d [AhyoungRyu] Address @coureadoug feedback 67cff3a [AhyoungRyu] Add all documentation list with short description to first page ce4b122 [AhyoungRyu] Limit image width 6ff4db6 [AhyoungRyu] Improve dropdown menu and reorder menus 61da430 [AhyoungRyu] Fix dead link in virtual_machine.md 6251558 [AhyoungRyu] Change 'Zeppelin Configuration' section placement so that it can be separated 4eecab8 [AhyoungRyu] Combine text.md, html.md, table.md 4d021af [AhyoungRyu] Delete outdated images and add new images
2016-06-14 21:52:46 +00:00
## Html
With `%html` directive, Zeppelin treats your output as HTML
[ZEPPELIN-2707][DOCS][HOTFIX] fix: broken image URLs in 0.8.0-SNAPSHOT doc ### 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 ![image](https://user-images.githubusercontent.com/4968473/27685112-bcca5846-5d07-11e7-89bb-3965015cf5a5.png) #### After ![image](https://user-images.githubusercontent.com/4968473/27685218-3490fad8-5d08-11e7-9133-0e148689986e.png) ### 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
2017-06-29 11:13:41 +00:00
<img src="{{BASE_PATH}}/assets/themes/zeppelin/img/screenshots/display_html.png" />
[ZEPPELIN-996] Improve first page and dropdown menu in documentation site ### What is this PR for? Current Zeppelin documentation site is little bit hard to find a way for Zeppelin beginners. It will not easy to improve this at a time, but I did the below as a start of this work. 1. Restructured dropdown menu and added each category names 2. Added a overview list(with short description) to first page of website (index.md) so that people can look through the overall contents in Zeppelin website at a glance. (as [Apache Spark](http://spark.apache.org/docs/latest/#where-to-go-from-here) and [Apache Mesos](http://mesos.apache.org/documentation/latest/) does) Please see the attached screenshot images :) ### What type of PR is it? Improvement & Documentation ### Todos * [x] - Change outdated screenshot images * [x] - Combine `text.md`, `table.md` and `html.md` to `basicdisplaysystem.md` * [x] - Fix dead link in `virtual_machine.md` * [x] - Improve dropdown menu and reorder * [x] - Improve first page(`index.md`) * [x] - Combine with #995 after it is merged into master ### What is the Jira issue? [ZEPPELIN-996](https://issues.apache.org/jira/browse/ZEPPELIN-996) ### How should this be tested? 1. Apply this patch and [build the docs website with jekyll](https://github.com/apache/zeppelin/tree/master/docs#build-documentation) 2. Check the first page(index.html) and dropdown menu ### Screenshots (if appropriate) - Dropdown menu ![dropdown](https://cloud.githubusercontent.com/assets/10060731/16061421/b44f8034-3241-11e6-88fd-43aa5031b453.gif) - First page <img width="717" alt="screen shot 2016-06-14 at 1 28 58 pm" src="https://cloud.githubusercontent.com/assets/10060731/16058631/3ab2cb6c-3234-11e6-95f4-180290df3d02.png"> <img width="694" alt="screen shot 2016-06-14 at 1 29 11 pm" src="https://cloud.githubusercontent.com/assets/10060731/16058639/43d68918-3234-11e6-921c-28436bfca33d.png"> <img width="649" alt="screen shot 2016-06-14 at 1 29 39 pm" src="https://cloud.githubusercontent.com/assets/10060731/16058650/501ec6d6-3234-11e6-9292-53ae84acc18a.png"> <img width="684" alt="screen shot 2016-06-14 at 1 29 57 pm" src="https://cloud.githubusercontent.com/assets/10060731/16058643/4637c8f2-3234-11e6-9b12-a233906f4c8b.png"> <img width="650" alt="screen shot 2016-06-14 at 1 30 12 pm" src="https://cloud.githubusercontent.com/assets/10060731/16058655/56c5af22-3234-11e6-8d29-9b7937728948.png"> <img width="636" alt="screen shot 2016-06-14 at 1 30 22 pm" src="https://cloud.githubusercontent.com/assets/10060731/16058656/58d1187e-3234-11e6-9171-ab7390b4a526.png"> ### 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 #1004 from AhyoungRyu/ZEPPELIN-996 and squashes the following commits: 1dbf805 [AhyoungRyu] Add 'Apache' before 'Zeppelin' 6153a50 [AhyoungRyu] Remove useless dash 61a5ad6 [AhyoungRyu] Revert to Text -> HTML -> Table in navbar 1886f8c [AhyoungRyu] Fix indentation af70939 [AhyoungRyu] Apply scrollable menu to 'more' tab & fix UI issue 2654d92 [AhyoungRyu] Combine overflow-x & overflow-y to overflow 904acd6 [AhyoungRyu] Resize dropdown menu maxheight 6e62e31 [AhyoungRyu] Change dynamicform image 230c670 [AhyoungRyu] Revert to Text -> HTML -> Table ad53799 [AhyoungRyu] Adjust image size c75c3a0 [AhyoungRyu] Add HDFS logo to available interpreter image 6a2f40b [AhyoungRyu] Address @bzz feedback 649a14d [AhyoungRyu] Address @coureadoug feedback 67cff3a [AhyoungRyu] Add all documentation list with short description to first page ce4b122 [AhyoungRyu] Limit image width 6ff4db6 [AhyoungRyu] Improve dropdown menu and reorder menus 61da430 [AhyoungRyu] Fix dead link in virtual_machine.md 6251558 [AhyoungRyu] Change 'Zeppelin Configuration' section placement so that it can be separated 4eecab8 [AhyoungRyu] Combine text.md, html.md, table.md 4d021af [AhyoungRyu] Delete outdated images and add new images
2016-06-14 21:52:46 +00:00
[ZEPPELIN-777] Math formula support ### What is this PR for? This PR adds support for formatting math formula formatting in %html display system using MathJax library. ### What type of PR is it? Feature ### Todos * [x] - Format math formula with MathJax library ### What is the Jira issue? https://issues.apache.org/jira/browse/ZEPPELIN-777 ### How should this be tested? try run following codes. ``` %md When \\(a \\ne 0\\), there are two solutions to \\(ax^2 + bx + c = 0\\) and they are $$x = {-b \pm \sqrt{b^2-4ac} \over 2a}.$$ ``` Note MathJax works better with `markdown.parser.type` property set `pegdown`, in markdown interpreter. With default markdown4j parser, some formula is not well displayed. (for example, ax^2) I think this will not be a big problem because of we'll remove markdown4j https://github.com/apache/zeppelin/pull/1594 ``` %sh echo -e "%html \$\$a = b\$\$" ``` ``` %spark println("%html $$b = c$$") ``` ### Screenshots (if appropriate) ![image](https://cloud.githubusercontent.com/assets/1540981/20040864/3b69c540-a414-11e6-8f8a-fdf7ee1370a6.png) ### Questions: * Does the licenses files need update? yes * Is there breaking changes for older versions? no * Does this needs documentation? yes Author: Lee moon soo <moon@apache.org> Closes #1606 from Leemoonsoo/ZEPPELIN-777 and squashes the following commits: af8e079 [Lee moon soo] Package MathJax resources 2afedde [Lee moon soo] Fix typo dd02bec [Lee moon soo] Add doc for mathmetical expression 174d7ad [Lee moon soo] Add license bb762c3 [Lee moon soo] Format formula using MathJax
2016-11-07 17:43:50 +00:00
### Mathematical expressions
HTML display system automatically formats mathematical expression using [MathJax](https://www.mathjax.org/). You can use
`\\( INLINE EXPRESSION \\)` and `$$ EXPRESSION $$` to format. For example
[ZEPPELIN-2707][DOCS][HOTFIX] fix: broken image URLs in 0.8.0-SNAPSHOT doc ### 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 ![image](https://user-images.githubusercontent.com/4968473/27685112-bcca5846-5d07-11e7-89bb-3965015cf5a5.png) #### After ![image](https://user-images.githubusercontent.com/4968473/27685218-3490fad8-5d08-11e7-9133-0e148689986e.png) ### 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
2017-06-29 11:13:41 +00:00
<img src="{{BASE_PATH}}/assets/themes/zeppelin/img/screenshots/display_formula.png" />
[ZEPPELIN-777] Math formula support ### What is this PR for? This PR adds support for formatting math formula formatting in %html display system using MathJax library. ### What type of PR is it? Feature ### Todos * [x] - Format math formula with MathJax library ### What is the Jira issue? https://issues.apache.org/jira/browse/ZEPPELIN-777 ### How should this be tested? try run following codes. ``` %md When \\(a \\ne 0\\), there are two solutions to \\(ax^2 + bx + c = 0\\) and they are $$x = {-b \pm \sqrt{b^2-4ac} \over 2a}.$$ ``` Note MathJax works better with `markdown.parser.type` property set `pegdown`, in markdown interpreter. With default markdown4j parser, some formula is not well displayed. (for example, ax^2) I think this will not be a big problem because of we'll remove markdown4j https://github.com/apache/zeppelin/pull/1594 ``` %sh echo -e "%html \$\$a = b\$\$" ``` ``` %spark println("%html $$b = c$$") ``` ### Screenshots (if appropriate) ![image](https://cloud.githubusercontent.com/assets/1540981/20040864/3b69c540-a414-11e6-8f8a-fdf7ee1370a6.png) ### Questions: * Does the licenses files need update? yes * Is there breaking changes for older versions? no * Does this needs documentation? yes Author: Lee moon soo <moon@apache.org> Closes #1606 from Leemoonsoo/ZEPPELIN-777 and squashes the following commits: af8e079 [Lee moon soo] Package MathJax resources 2afedde [Lee moon soo] Fix typo dd02bec [Lee moon soo] Add doc for mathmetical expression 174d7ad [Lee moon soo] Add license bb762c3 [Lee moon soo] Format formula using MathJax
2016-11-07 17:43:50 +00:00
[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-05 04:54:02 +00:00
## Table
[HOT FIX] Fix broken display_formula.png by using relative path ### What is this PR for? Currently `display_formula.png` (added by #1606) is broken in here: http://zeppelin.apache.org/docs/0.7.0-SNAPSHOT/displaysystem/basicdisplaysystem.html#mathematical-expressions Fixed it by using relative path for the image. But have no idea why the other image files are not broken in that page. ### What type of PR is it? Documentation | Hot Fix ### Todos * [ ] - Task ### What is the Jira issue? N/A ### How should this be tested? It can't be reproduced using docs dev mode. Needs to be tested with below steps. ``` 1) build gh-pages (website) branch JEKYLL_ENV=production bundle exec jekyll build cp -r _site/ /tmp/zeppelin_website/ mkdir -p /tmp/zeppelin_website/docs/0.7.0-SNAPSHOT 2) build this patch (docs) and copy it under docs/0.7.0-SNAPSHOT of website cd docs bundle exec jekyll build --safe cp -r _site/ /tmp/zeppelin_website/0.7.0-SNAPSHOT/ 3) start httpserver and browse http://localhost:8000/docs/0.7.0-SNAPSHOT/ cd /tmp/zeppelin_website python -m SimpleHTTPServer ``` ### Screenshots (if appropriate) **Before** - In the official website <img width="938" alt="screen shot 2016-12-13 at 7 07 27 pm" src="https://cloud.githubusercontent.com/assets/10060731/21136061/72c230b6-c167-11e6-9805-12d6f11f3270.png"> ``` GET http://zeppelin.apache.org/assets/themes/zeppelin/img/screenshots/display_formula.png 404 (Not Found) ``` **After** - test locally using same with production path <img width="877" alt="screen shot 2016-12-13 at 7 09 42 pm" src="https://cloud.githubusercontent.com/assets/10060731/21136136/bbff660e-c167-11e6-9ed3-384e609886fe.png"> ### Questions: * Does the licenses files need update? * Is there breaking changes for older versions? * Does this needs documentation? Author: AhyoungRyu <fbdkdud93@hanmail.net> Closes #1752 from AhyoungRyu/fix-img-path and squashes the following commits: 4be330b [AhyoungRyu] Fix broken display_formula.png by using relative path
2016-12-13 10:01:21 +00:00
If you have data that row separated by `\n` (newline) and column separated by `\t` (tab) with first row as header row, for example
[ZEPPELIN-2707][DOCS][HOTFIX] fix: broken image URLs in 0.8.0-SNAPSHOT doc ### 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 ![image](https://user-images.githubusercontent.com/4968473/27685112-bcca5846-5d07-11e7-89bb-3965015cf5a5.png) #### After ![image](https://user-images.githubusercontent.com/4968473/27685218-3490fad8-5d08-11e7-9133-0e148689986e.png) ### 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
2017-06-29 11:13:41 +00:00
<img src="{{BASE_PATH}}/assets/themes/zeppelin/img/screenshots/display_table.png" />
[ZEPPELIN-996] Improve first page and dropdown menu in documentation site ### What is this PR for? Current Zeppelin documentation site is little bit hard to find a way for Zeppelin beginners. It will not easy to improve this at a time, but I did the below as a start of this work. 1. Restructured dropdown menu and added each category names 2. Added a overview list(with short description) to first page of website (index.md) so that people can look through the overall contents in Zeppelin website at a glance. (as [Apache Spark](http://spark.apache.org/docs/latest/#where-to-go-from-here) and [Apache Mesos](http://mesos.apache.org/documentation/latest/) does) Please see the attached screenshot images :) ### What type of PR is it? Improvement & Documentation ### Todos * [x] - Change outdated screenshot images * [x] - Combine `text.md`, `table.md` and `html.md` to `basicdisplaysystem.md` * [x] - Fix dead link in `virtual_machine.md` * [x] - Improve dropdown menu and reorder * [x] - Improve first page(`index.md`) * [x] - Combine with #995 after it is merged into master ### What is the Jira issue? [ZEPPELIN-996](https://issues.apache.org/jira/browse/ZEPPELIN-996) ### How should this be tested? 1. Apply this patch and [build the docs website with jekyll](https://github.com/apache/zeppelin/tree/master/docs#build-documentation) 2. Check the first page(index.html) and dropdown menu ### Screenshots (if appropriate) - Dropdown menu ![dropdown](https://cloud.githubusercontent.com/assets/10060731/16061421/b44f8034-3241-11e6-88fd-43aa5031b453.gif) - First page <img width="717" alt="screen shot 2016-06-14 at 1 28 58 pm" src="https://cloud.githubusercontent.com/assets/10060731/16058631/3ab2cb6c-3234-11e6-95f4-180290df3d02.png"> <img width="694" alt="screen shot 2016-06-14 at 1 29 11 pm" src="https://cloud.githubusercontent.com/assets/10060731/16058639/43d68918-3234-11e6-921c-28436bfca33d.png"> <img width="649" alt="screen shot 2016-06-14 at 1 29 39 pm" src="https://cloud.githubusercontent.com/assets/10060731/16058650/501ec6d6-3234-11e6-9292-53ae84acc18a.png"> <img width="684" alt="screen shot 2016-06-14 at 1 29 57 pm" src="https://cloud.githubusercontent.com/assets/10060731/16058643/4637c8f2-3234-11e6-9b12-a233906f4c8b.png"> <img width="650" alt="screen shot 2016-06-14 at 1 30 12 pm" src="https://cloud.githubusercontent.com/assets/10060731/16058655/56c5af22-3234-11e6-8d29-9b7937728948.png"> <img width="636" alt="screen shot 2016-06-14 at 1 30 22 pm" src="https://cloud.githubusercontent.com/assets/10060731/16058656/58d1187e-3234-11e6-9171-ab7390b4a526.png"> ### 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 #1004 from AhyoungRyu/ZEPPELIN-996 and squashes the following commits: 1dbf805 [AhyoungRyu] Add 'Apache' before 'Zeppelin' 6153a50 [AhyoungRyu] Remove useless dash 61a5ad6 [AhyoungRyu] Revert to Text -> HTML -> Table in navbar 1886f8c [AhyoungRyu] Fix indentation af70939 [AhyoungRyu] Apply scrollable menu to 'more' tab & fix UI issue 2654d92 [AhyoungRyu] Combine overflow-x & overflow-y to overflow 904acd6 [AhyoungRyu] Resize dropdown menu maxheight 6e62e31 [AhyoungRyu] Change dynamicform image 230c670 [AhyoungRyu] Revert to Text -> HTML -> Table ad53799 [AhyoungRyu] Adjust image size c75c3a0 [AhyoungRyu] Add HDFS logo to available interpreter image 6a2f40b [AhyoungRyu] Address @bzz feedback 649a14d [AhyoungRyu] Address @coureadoug feedback 67cff3a [AhyoungRyu] Add all documentation list with short description to first page ce4b122 [AhyoungRyu] Limit image width 6ff4db6 [AhyoungRyu] Improve dropdown menu and reorder menus 61da430 [AhyoungRyu] Fix dead link in virtual_machine.md 6251558 [AhyoungRyu] Change 'Zeppelin Configuration' section placement so that it can be separated 4eecab8 [AhyoungRyu] Combine text.md, html.md, table.md 4d021af [AhyoungRyu] Delete outdated images and add new images
2016-06-14 21:52:46 +00:00
You can simply use `%table` display system to leverage Zeppelin's built in visualization.
[ZEPPELIN-2707][DOCS][HOTFIX] fix: broken image URLs in 0.8.0-SNAPSHOT doc ### 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 ![image](https://user-images.githubusercontent.com/4968473/27685112-bcca5846-5d07-11e7-89bb-3965015cf5a5.png) #### After ![image](https://user-images.githubusercontent.com/4968473/27685218-3490fad8-5d08-11e7-9133-0e148689986e.png) ### 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
2017-06-29 11:13:41 +00:00
<img src="{{BASE_PATH}}/assets/themes/zeppelin/img/screenshots/display_table1.png" />
[ZEPPELIN-996] Improve first page and dropdown menu in documentation site ### What is this PR for? Current Zeppelin documentation site is little bit hard to find a way for Zeppelin beginners. It will not easy to improve this at a time, but I did the below as a start of this work. 1. Restructured dropdown menu and added each category names 2. Added a overview list(with short description) to first page of website (index.md) so that people can look through the overall contents in Zeppelin website at a glance. (as [Apache Spark](http://spark.apache.org/docs/latest/#where-to-go-from-here) and [Apache Mesos](http://mesos.apache.org/documentation/latest/) does) Please see the attached screenshot images :) ### What type of PR is it? Improvement & Documentation ### Todos * [x] - Change outdated screenshot images * [x] - Combine `text.md`, `table.md` and `html.md` to `basicdisplaysystem.md` * [x] - Fix dead link in `virtual_machine.md` * [x] - Improve dropdown menu and reorder * [x] - Improve first page(`index.md`) * [x] - Combine with #995 after it is merged into master ### What is the Jira issue? [ZEPPELIN-996](https://issues.apache.org/jira/browse/ZEPPELIN-996) ### How should this be tested? 1. Apply this patch and [build the docs website with jekyll](https://github.com/apache/zeppelin/tree/master/docs#build-documentation) 2. Check the first page(index.html) and dropdown menu ### Screenshots (if appropriate) - Dropdown menu ![dropdown](https://cloud.githubusercontent.com/assets/10060731/16061421/b44f8034-3241-11e6-88fd-43aa5031b453.gif) - First page <img width="717" alt="screen shot 2016-06-14 at 1 28 58 pm" src="https://cloud.githubusercontent.com/assets/10060731/16058631/3ab2cb6c-3234-11e6-95f4-180290df3d02.png"> <img width="694" alt="screen shot 2016-06-14 at 1 29 11 pm" src="https://cloud.githubusercontent.com/assets/10060731/16058639/43d68918-3234-11e6-921c-28436bfca33d.png"> <img width="649" alt="screen shot 2016-06-14 at 1 29 39 pm" src="https://cloud.githubusercontent.com/assets/10060731/16058650/501ec6d6-3234-11e6-9292-53ae84acc18a.png"> <img width="684" alt="screen shot 2016-06-14 at 1 29 57 pm" src="https://cloud.githubusercontent.com/assets/10060731/16058643/4637c8f2-3234-11e6-9b12-a233906f4c8b.png"> <img width="650" alt="screen shot 2016-06-14 at 1 30 12 pm" src="https://cloud.githubusercontent.com/assets/10060731/16058655/56c5af22-3234-11e6-8d29-9b7937728948.png"> <img width="636" alt="screen shot 2016-06-14 at 1 30 22 pm" src="https://cloud.githubusercontent.com/assets/10060731/16058656/58d1187e-3234-11e6-9171-ab7390b4a526.png"> ### 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 #1004 from AhyoungRyu/ZEPPELIN-996 and squashes the following commits: 1dbf805 [AhyoungRyu] Add 'Apache' before 'Zeppelin' 6153a50 [AhyoungRyu] Remove useless dash 61a5ad6 [AhyoungRyu] Revert to Text -> HTML -> Table in navbar 1886f8c [AhyoungRyu] Fix indentation af70939 [AhyoungRyu] Apply scrollable menu to 'more' tab & fix UI issue 2654d92 [AhyoungRyu] Combine overflow-x & overflow-y to overflow 904acd6 [AhyoungRyu] Resize dropdown menu maxheight 6e62e31 [AhyoungRyu] Change dynamicform image 230c670 [AhyoungRyu] Revert to Text -> HTML -> Table ad53799 [AhyoungRyu] Adjust image size c75c3a0 [AhyoungRyu] Add HDFS logo to available interpreter image 6a2f40b [AhyoungRyu] Address @bzz feedback 649a14d [AhyoungRyu] Address @coureadoug feedback 67cff3a [AhyoungRyu] Add all documentation list with short description to first page ce4b122 [AhyoungRyu] Limit image width 6ff4db6 [AhyoungRyu] Improve dropdown menu and reorder menus 61da430 [AhyoungRyu] Fix dead link in virtual_machine.md 6251558 [AhyoungRyu] Change 'Zeppelin Configuration' section placement so that it can be separated 4eecab8 [AhyoungRyu] Combine text.md, html.md, table.md 4d021af [AhyoungRyu] Delete outdated images and add new images
2016-06-14 21:52:46 +00:00
If table contents start with `%html`, it is interpreted as an HTML.
[ZEPPELIN-2707][DOCS][HOTFIX] fix: broken image URLs in 0.8.0-SNAPSHOT doc ### 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 ![image](https://user-images.githubusercontent.com/4968473/27685112-bcca5846-5d07-11e7-89bb-3965015cf5a5.png) #### After ![image](https://user-images.githubusercontent.com/4968473/27685218-3490fad8-5d08-11e7-9133-0e148689986e.png) ### 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
2017-06-29 11:13:41 +00:00
<img src="{{BASE_PATH}}/assets/themes/zeppelin/img/screenshots/display_table_html.png" />
[ZEPPELIN-996] Improve first page and dropdown menu in documentation site ### What is this PR for? Current Zeppelin documentation site is little bit hard to find a way for Zeppelin beginners. It will not easy to improve this at a time, but I did the below as a start of this work. 1. Restructured dropdown menu and added each category names 2. Added a overview list(with short description) to first page of website (index.md) so that people can look through the overall contents in Zeppelin website at a glance. (as [Apache Spark](http://spark.apache.org/docs/latest/#where-to-go-from-here) and [Apache Mesos](http://mesos.apache.org/documentation/latest/) does) Please see the attached screenshot images :) ### What type of PR is it? Improvement & Documentation ### Todos * [x] - Change outdated screenshot images * [x] - Combine `text.md`, `table.md` and `html.md` to `basicdisplaysystem.md` * [x] - Fix dead link in `virtual_machine.md` * [x] - Improve dropdown menu and reorder * [x] - Improve first page(`index.md`) * [x] - Combine with #995 after it is merged into master ### What is the Jira issue? [ZEPPELIN-996](https://issues.apache.org/jira/browse/ZEPPELIN-996) ### How should this be tested? 1. Apply this patch and [build the docs website with jekyll](https://github.com/apache/zeppelin/tree/master/docs#build-documentation) 2. Check the first page(index.html) and dropdown menu ### Screenshots (if appropriate) - Dropdown menu ![dropdown](https://cloud.githubusercontent.com/assets/10060731/16061421/b44f8034-3241-11e6-88fd-43aa5031b453.gif) - First page <img width="717" alt="screen shot 2016-06-14 at 1 28 58 pm" src="https://cloud.githubusercontent.com/assets/10060731/16058631/3ab2cb6c-3234-11e6-95f4-180290df3d02.png"> <img width="694" alt="screen shot 2016-06-14 at 1 29 11 pm" src="https://cloud.githubusercontent.com/assets/10060731/16058639/43d68918-3234-11e6-921c-28436bfca33d.png"> <img width="649" alt="screen shot 2016-06-14 at 1 29 39 pm" src="https://cloud.githubusercontent.com/assets/10060731/16058650/501ec6d6-3234-11e6-9292-53ae84acc18a.png"> <img width="684" alt="screen shot 2016-06-14 at 1 29 57 pm" src="https://cloud.githubusercontent.com/assets/10060731/16058643/4637c8f2-3234-11e6-9b12-a233906f4c8b.png"> <img width="650" alt="screen shot 2016-06-14 at 1 30 12 pm" src="https://cloud.githubusercontent.com/assets/10060731/16058655/56c5af22-3234-11e6-8d29-9b7937728948.png"> <img width="636" alt="screen shot 2016-06-14 at 1 30 22 pm" src="https://cloud.githubusercontent.com/assets/10060731/16058656/58d1187e-3234-11e6-9171-ab7390b4a526.png"> ### 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 #1004 from AhyoungRyu/ZEPPELIN-996 and squashes the following commits: 1dbf805 [AhyoungRyu] Add 'Apache' before 'Zeppelin' 6153a50 [AhyoungRyu] Remove useless dash 61a5ad6 [AhyoungRyu] Revert to Text -> HTML -> Table in navbar 1886f8c [AhyoungRyu] Fix indentation af70939 [AhyoungRyu] Apply scrollable menu to 'more' tab & fix UI issue 2654d92 [AhyoungRyu] Combine overflow-x & overflow-y to overflow 904acd6 [AhyoungRyu] Resize dropdown menu maxheight 6e62e31 [AhyoungRyu] Change dynamicform image 230c670 [AhyoungRyu] Revert to Text -> HTML -> Table ad53799 [AhyoungRyu] Adjust image size c75c3a0 [AhyoungRyu] Add HDFS logo to available interpreter image 6a2f40b [AhyoungRyu] Address @bzz feedback 649a14d [AhyoungRyu] Address @coureadoug feedback 67cff3a [AhyoungRyu] Add all documentation list with short description to first page ce4b122 [AhyoungRyu] Limit image width 6ff4db6 [AhyoungRyu] Improve dropdown menu and reorder menus 61da430 [AhyoungRyu] Fix dead link in virtual_machine.md 6251558 [AhyoungRyu] Change 'Zeppelin Configuration' section placement so that it can be separated 4eecab8 [AhyoungRyu] Combine text.md, html.md, table.md 4d021af [AhyoungRyu] Delete outdated images and add new images
2016-06-14 21:52:46 +00:00
> **Note :** Display system is backend independent.
[ZEPPELIN-2222] Add Network Visualization ### What is this PR for? This issue is about a new network visualization that can leverage the Property Graph Model (https://github.com/tinkerpop/gremlin/wiki/Defining-a-Property-Graph), but also simple graphs in order to provide a set of base apis that can be used by graph dbs (like Neo4j) or graph processing frameworks (like GraphX or Giraph). ### What type of PR is it? [Feature] Is related to the #1582 ### Todos * [x] - Added the intepreter apis to manage graphs (under the pakage **org.apache.zeppelin.interpreter.graph**) * [x] - Added the frontend apis to manage graphs (via d3js) ### What is the Jira issue? https://issues.apache.org/jira/browse/ZEPPELIN-2222 ### How should this be tested? You can download [this notebook](https://gist.github.com/conker84/9574127c2389d08164423894aa93b67f) to test the PR ### Screenshots (if appropriate) ![zeppelin-pr-screen](https://cloud.githubusercontent.com/assets/1833335/23830683/b883e916-0710-11e7-980d-c8ab6bf6d26b.PNG) ### Video ![zeppelin](https://cloud.githubusercontent.com/assets/1833335/23902630/1e121a0c-08c2-11e7-9f28-134866dba077.gif) ### Questions: * Does the licenses files need update? No * Is there breaking changes for older versions? No * Does this needs documentation? Yes Author: conker84 <santand@gmail.com> Closes #2125 from conker84/master and squashes the following commits: b6062a0b0 [conker84] Removed package org.apache.zeppelin.interpreter.graph e98ca7a67 [conker84] Comments of review 14/03/2017 b31b7b7ac [conker84] Rebase of 07/04/2017 3257bea24 [conker84] Rebase 30/4 6e74eb9f3 [conker84] Rebase 30/04
2017-06-08 12:48:01 +00:00
## Network
With the `%network` directive, Zeppelin treats your output as a graph. Zeppelin can leverage the Property Graph Model.
### What is the Labelled Property Graph Model?
A [Property Graph](https://github.com/tinkerpop/gremlin/wiki/Defining-a-Property-Graph) is a graph that has these elements:
* a set of vertices
* each vertex has a unique identifier.
* each vertex has a set of outgoing edges.
* each vertex has a set of incoming edges.
* each vertex has a collection of properties defined by a map from key to value
* a set of edges
* each edge has a unique identifier.
* each edge has an outgoing tail vertex.
* each edge has an incoming head vertex.
* each edge has a label that denotes the type of relationship between its two vertices.
* each edge has a collection of properties defined by a map from key to value.
<img src="https://github.com/tinkerpop/gremlin/raw/master/doc/images/graph-example-1.jpg" />
A [Labelled Property Graph](https://neo4j.com/developer/graph-database/#property-graph) is a Property Graph where the nodes can be tagged with **labels** representing their different roles in the graph model
<img src="http://s3.amazonaws.com/dev.assets.neo4j.com/wp-content/uploads/property_graph_model.png" />
### What are the APIs?
The new NETWORK visualization is based on json with the following params:
* "nodes" (mandatory): list of nodes of the graph every node can have the following params:
* "id" (mandatory): the id of the node (must be unique);
* "label": the main Label of the node;
* "labels": the list of the labels of the node;
* "data": the data attached to the node;
* "edges": list of the edges of the graph;
* "id" (mandatory): the id of the edge (must be unique);
* "source" (mandatory): the id of source node of the edge;
* "target" (mandatory): the id of target node of the edge;
* "label": the main type of the edge;
* "data": the data attached to the edge;
* "labels": a map (K, V) where K is the node label and V is the color of the node;
* "directed": (true/false, default false) wich tells if is directed graph or not;
* "types": a *distinct* list of the edge types of the graph
If you click on a node or edge on the bottom of the paragraph you find a list of entity properties
[ZEPPELIN-2707][DOCS][HOTFIX] fix: broken image URLs in 0.8.0-SNAPSHOT doc ### 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 ![image](https://user-images.githubusercontent.com/4968473/27685112-bcca5846-5d07-11e7-89bb-3965015cf5a5.png) #### After ![image](https://user-images.githubusercontent.com/4968473/27685218-3490fad8-5d08-11e7-9133-0e148689986e.png) ### 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
2017-06-29 11:13:41 +00:00
<img src="{{BASE_PATH}}/assets/themes/zeppelin/img/screenshots/display_network.png" />
[ZEPPELIN-2222] Add Network Visualization ### What is this PR for? This issue is about a new network visualization that can leverage the Property Graph Model (https://github.com/tinkerpop/gremlin/wiki/Defining-a-Property-Graph), but also simple graphs in order to provide a set of base apis that can be used by graph dbs (like Neo4j) or graph processing frameworks (like GraphX or Giraph). ### What type of PR is it? [Feature] Is related to the #1582 ### Todos * [x] - Added the intepreter apis to manage graphs (under the pakage **org.apache.zeppelin.interpreter.graph**) * [x] - Added the frontend apis to manage graphs (via d3js) ### What is the Jira issue? https://issues.apache.org/jira/browse/ZEPPELIN-2222 ### How should this be tested? You can download [this notebook](https://gist.github.com/conker84/9574127c2389d08164423894aa93b67f) to test the PR ### Screenshots (if appropriate) ![zeppelin-pr-screen](https://cloud.githubusercontent.com/assets/1833335/23830683/b883e916-0710-11e7-980d-c8ab6bf6d26b.PNG) ### Video ![zeppelin](https://cloud.githubusercontent.com/assets/1833335/23902630/1e121a0c-08c2-11e7-9f28-134866dba077.gif) ### Questions: * Does the licenses files need update? No * Is there breaking changes for older versions? No * Does this needs documentation? Yes Author: conker84 <santand@gmail.com> Closes #2125 from conker84/master and squashes the following commits: b6062a0b0 [conker84] Removed package org.apache.zeppelin.interpreter.graph e98ca7a67 [conker84] Comments of review 14/03/2017 b31b7b7ac [conker84] Rebase of 07/04/2017 3257bea24 [conker84] Rebase 30/4 6e74eb9f3 [conker84] Rebase 30/04
2017-06-08 12:48:01 +00:00
This kind of graph can be easily *flatten* in order to support other visualization formats provided by Zeppelin.
[ZEPPELIN-2707][DOCS][HOTFIX] fix: broken image URLs in 0.8.0-SNAPSHOT doc ### 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 ![image](https://user-images.githubusercontent.com/4968473/27685112-bcca5846-5d07-11e7-89bb-3965015cf5a5.png) #### After ![image](https://user-images.githubusercontent.com/4968473/27685218-3490fad8-5d08-11e7-9133-0e148689986e.png) ### 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
2017-06-29 11:13:41 +00:00
<img src="{{BASE_PATH}}/assets/themes/zeppelin/img/screenshots/display_network_flatten.png" />
[ZEPPELIN-2222] Add Network Visualization ### What is this PR for? This issue is about a new network visualization that can leverage the Property Graph Model (https://github.com/tinkerpop/gremlin/wiki/Defining-a-Property-Graph), but also simple graphs in order to provide a set of base apis that can be used by graph dbs (like Neo4j) or graph processing frameworks (like GraphX or Giraph). ### What type of PR is it? [Feature] Is related to the #1582 ### Todos * [x] - Added the intepreter apis to manage graphs (under the pakage **org.apache.zeppelin.interpreter.graph**) * [x] - Added the frontend apis to manage graphs (via d3js) ### What is the Jira issue? https://issues.apache.org/jira/browse/ZEPPELIN-2222 ### How should this be tested? You can download [this notebook](https://gist.github.com/conker84/9574127c2389d08164423894aa93b67f) to test the PR ### Screenshots (if appropriate) ![zeppelin-pr-screen](https://cloud.githubusercontent.com/assets/1833335/23830683/b883e916-0710-11e7-980d-c8ab6bf6d26b.PNG) ### Video ![zeppelin](https://cloud.githubusercontent.com/assets/1833335/23902630/1e121a0c-08c2-11e7-9f28-134866dba077.gif) ### Questions: * Does the licenses files need update? No * Is there breaking changes for older versions? No * Does this needs documentation? Yes Author: conker84 <santand@gmail.com> Closes #2125 from conker84/master and squashes the following commits: b6062a0b0 [conker84] Removed package org.apache.zeppelin.interpreter.graph e98ca7a67 [conker84] Comments of review 14/03/2017 b31b7b7ac [conker84] Rebase of 07/04/2017 3257bea24 [conker84] Rebase 30/4 6e74eb9f3 [conker84] Rebase 30/04
2017-06-08 12:48:01 +00:00
### How to use it?
An example of a simple graph
```
%spark
print(s"""
%network {
"nodes": [
{"id": 1},
{"id": 2},
{"id": 3}
],
"edges": [
{"source": 1, "target": 2, "id" : 1},
{"source": 2, "target": 3, "id" : 2},
{"source": 1, "target": 2, "id" : 3},
{"source": 1, "target": 2, "id" : 4},
{"source": 2, "target": 1, "id" : 5},
{"source": 2, "target": 1, "id" : 6}
]
}
""")
```
that will look like:
[ZEPPELIN-2707][DOCS][HOTFIX] fix: broken image URLs in 0.8.0-SNAPSHOT doc ### 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 ![image](https://user-images.githubusercontent.com/4968473/27685112-bcca5846-5d07-11e7-89bb-3965015cf5a5.png) #### After ![image](https://user-images.githubusercontent.com/4968473/27685218-3490fad8-5d08-11e7-9133-0e148689986e.png) ### 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
2017-06-29 11:13:41 +00:00
<img src="{{BASE_PATH}}/assets/themes/zeppelin/img/screenshots/display_simple_network.png" />
[ZEPPELIN-2222] Add Network Visualization ### What is this PR for? This issue is about a new network visualization that can leverage the Property Graph Model (https://github.com/tinkerpop/gremlin/wiki/Defining-a-Property-Graph), but also simple graphs in order to provide a set of base apis that can be used by graph dbs (like Neo4j) or graph processing frameworks (like GraphX or Giraph). ### What type of PR is it? [Feature] Is related to the #1582 ### Todos * [x] - Added the intepreter apis to manage graphs (under the pakage **org.apache.zeppelin.interpreter.graph**) * [x] - Added the frontend apis to manage graphs (via d3js) ### What is the Jira issue? https://issues.apache.org/jira/browse/ZEPPELIN-2222 ### How should this be tested? You can download [this notebook](https://gist.github.com/conker84/9574127c2389d08164423894aa93b67f) to test the PR ### Screenshots (if appropriate) ![zeppelin-pr-screen](https://cloud.githubusercontent.com/assets/1833335/23830683/b883e916-0710-11e7-980d-c8ab6bf6d26b.PNG) ### Video ![zeppelin](https://cloud.githubusercontent.com/assets/1833335/23902630/1e121a0c-08c2-11e7-9f28-134866dba077.gif) ### Questions: * Does the licenses files need update? No * Is there breaking changes for older versions? No * Does this needs documentation? Yes Author: conker84 <santand@gmail.com> Closes #2125 from conker84/master and squashes the following commits: b6062a0b0 [conker84] Removed package org.apache.zeppelin.interpreter.graph e98ca7a67 [conker84] Comments of review 14/03/2017 b31b7b7ac [conker84] Rebase of 07/04/2017 3257bea24 [conker84] Rebase 30/4 6e74eb9f3 [conker84] Rebase 30/04
2017-06-08 12:48:01 +00:00
A little more complex graph:
```
%spark
print(s"""
%network {
"nodes": [{"id": 1, "label": "User", "data": {"fullName":"Andrea Santurbano"}},{"id": 2, "label": "User", "data": {"fullName":"Lee Moon Soo"}},{"id": 3, "label": "Project", "data": {"name":"Zeppelin"}}],
"edges": [{"source": 2, "target": 1, "id" : 1, "label": "HELPS"},{"source": 2, "target": 3, "id" : 2, "label": "CREATE"},{"source": 1, "target": 3, "id" : 3, "label": "CONTRIBUTE_TO", "data": {"oldPR": "https://github.com/apache/zeppelin/pull/1582"}}],
"labels": {"User": "#8BC34A", "Project": "#3071A9"},
"directed": true,
"types": ["HELPS", "CREATE", "CONTRIBUTE_TO"]
}
""")
```
that will look like:
[ZEPPELIN-2707][DOCS][HOTFIX] fix: broken image URLs in 0.8.0-SNAPSHOT doc ### 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 ![image](https://user-images.githubusercontent.com/4968473/27685112-bcca5846-5d07-11e7-89bb-3965015cf5a5.png) #### After ![image](https://user-images.githubusercontent.com/4968473/27685218-3490fad8-5d08-11e7-9133-0e148689986e.png) ### 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
2017-06-29 11:13:41 +00:00
<img src="{{BASE_PATH}}/assets/themes/zeppelin/img/screenshots/display_complex_network.png" />