Repository: incubator-zeppelin Updated Branches: refs/heads/master 48c3c4727 -> 83b4eea59
[ZEPPELIN-585] Add new doc on how to embed Note\Paragraph plots into ⦠### What is this PR for? Sorry for the late PR. According to the user feedback, seems that it's not clear how to **embed output plots into other websites**. So I made a documentation for explaining this feature. ### What type of PR is it? Documentation ### Todos * [x] - Write a documentation for How can we publish Zeppelin paragraph results ### Is there a relevant Jira issue? [ZEPPELIN-585](https://issues.apache.org/jira/browse/ZEPPELIN-585) ### How should this be tested? After apply this PR, just click `Quick Start -> Publish your Paragraph ### 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: Ryu Ah young <[email protected]> Closes #672 from AhyoungRyu/ZEPPELIN-585-test and squashes the following commits: 746b13c [Ryu Ah young] ZEPPELIN-585: Add a warning sentence a728c28 [Ryu Ah young] ZEPPELIN-585: ping travis edab76d [Ryu Ah young] ZEPPELIN-585: Fix grammar error fea0c4f [Ryu Ah young] ZEPPELIN-585: Change a note sentence 9b877f6 [Ryu Ah young] ZEPPELIN-585: Change a sentence in index.md 4e92c9f [Ryu Ah young] ZEPPELIN-585: Change a word 'tab' -> 'menu' c7d380b [Ryu Ah young] ZEPPELIN-585: Change some sentences for normal use case 648067d [Ryu Ah young] ZEPPELIN-585: Fix a sentence in index.md 5599d69 [Ryu Ah young] ZEPPELIN-585: Add new doc on how to embedd Note\Paragraph plots into other websites Project: http://git-wip-us.apache.org/repos/asf/incubator-zeppelin/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-zeppelin/commit/83b4eea5 Tree: http://git-wip-us.apache.org/repos/asf/incubator-zeppelin/tree/83b4eea5 Diff: http://git-wip-us.apache.org/repos/asf/incubator-zeppelin/diff/83b4eea5 Branch: refs/heads/master Commit: 83b4eea5927936bd9fa3462ba9d84a1ad677e821 Parents: 48c3c47 Author: Ryu Ah young <[email protected]> Authored: Sat Feb 13 15:21:38 2016 +0900 Committer: Felix Cheung <[email protected]> Committed: Mon Feb 15 13:46:53 2016 -0800 ---------------------------------------------------------------------- docs/_includes/themes/zeppelin/_navigation.html | 3 +- .../zeppelin/img/docs-img/copy-the-link.png | Bin 0 -> 189588 bytes .../img/docs-img/link-the-paragraph.png | Bin 0 -> 318087 bytes .../zeppelin/img/docs-img/your-website.png | Bin 0 -> 434847 bytes docs/index.md | 8 ++-- docs/manual/publish.md | 48 +++++++++++++++++++ 6 files changed, 53 insertions(+), 6 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-zeppelin/blob/83b4eea5/docs/_includes/themes/zeppelin/_navigation.html ---------------------------------------------------------------------- diff --git a/docs/_includes/themes/zeppelin/_navigation.html b/docs/_includes/themes/zeppelin/_navigation.html index 4633b09..22496b8 100644 --- a/docs/_includes/themes/zeppelin/_navigation.html +++ b/docs/_includes/themes/zeppelin/_navigation.html @@ -31,6 +31,7 @@ <li role="separator" class="divider"></li> <!-- li><span><b>Guide</b><span></li --> <li><a href="{{BASE_PATH}}/manual/dynamicform.html">Dynamic Form</a></li> + <li><a href="{{BASE_PATH}}/manual/publish.html">Publish your Paragraph</a></li> </ul> </li> <li> @@ -92,4 +93,4 @@ </ul> </nav><!--/.navbar-collapse --> </div> - </div> + </div> \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-zeppelin/blob/83b4eea5/docs/assets/themes/zeppelin/img/docs-img/copy-the-link.png ---------------------------------------------------------------------- diff --git a/docs/assets/themes/zeppelin/img/docs-img/copy-the-link.png b/docs/assets/themes/zeppelin/img/docs-img/copy-the-link.png new file mode 100644 index 0000000..b8f82a8 Binary files /dev/null and b/docs/assets/themes/zeppelin/img/docs-img/copy-the-link.png differ http://git-wip-us.apache.org/repos/asf/incubator-zeppelin/blob/83b4eea5/docs/assets/themes/zeppelin/img/docs-img/link-the-paragraph.png ---------------------------------------------------------------------- diff --git a/docs/assets/themes/zeppelin/img/docs-img/link-the-paragraph.png b/docs/assets/themes/zeppelin/img/docs-img/link-the-paragraph.png new file mode 100644 index 0000000..f0f4d9a Binary files /dev/null and b/docs/assets/themes/zeppelin/img/docs-img/link-the-paragraph.png differ http://git-wip-us.apache.org/repos/asf/incubator-zeppelin/blob/83b4eea5/docs/assets/themes/zeppelin/img/docs-img/your-website.png ---------------------------------------------------------------------- diff --git a/docs/assets/themes/zeppelin/img/docs-img/your-website.png b/docs/assets/themes/zeppelin/img/docs-img/your-website.png new file mode 100644 index 0000000..bca0dbd Binary files /dev/null and b/docs/assets/themes/zeppelin/img/docs-img/your-website.png differ http://git-wip-us.apache.org/repos/asf/incubator-zeppelin/blob/83b4eea5/docs/index.md ---------------------------------------------------------------------- diff --git a/docs/index.md b/docs/index.md index 1648f45..2c566b9 100644 --- a/docs/index.md +++ b/docs/index.md @@ -37,7 +37,6 @@ limitations under the License. <div class="col-md-7"><img class="img-responsive" style="border: 1px solid #ecf0f1;" height="auto" src="/assets/themes/zeppelin/img/notebook.png" /></div> </div> - <br /> ### Multiple language backend @@ -86,7 +85,6 @@ With simple drag and drop Zeppelin aggeregates the values and display them in pi </div> Learn more about Zeppelin's Display system. ( [text](./displaysystem/display.html), [html](./displaysystem/display.html#html), [table](./displaysystem/table.html), [angular](./displaysystem/angular.html) ) - <br /> ### Dynamic forms @@ -96,7 +94,6 @@ Zeppelin can dynamically create some input forms into your notebook. Learn more about [Dynamic Forms](./manual/dynamicform.html). - <br /> ### Collaboration @@ -114,6 +111,8 @@ This way, you can easily embed it as an iframe inside of your website.</p> <img class="img-responsive center-block" src="/assets/themes/zeppelin/img/screenshots/publish.png" /> </div> +If you want to learn more about this feature, please visit [this page](./manual/publish.html). + <br /> ### 100% Opensource @@ -124,5 +123,4 @@ Join the [Mailing list](./community.html) and report issues on our [Issue tracke <br /> ### Undergoing Incubation -Apache Zeppelin is an effort undergoing [incubation](https://incubator.apache.org/index.html) at The Apache Software Foundation (ASF), sponsored by the Incubator. Incubation is required of all newly accepted projects until a further review indicates that the infrastructure, communications, and decision making process have stabilized in a manner consistent with other successful ASF projects. While incubation status is not necessarily a reflection of the completeness or stability of the code, it does indicate that the project has yet to be fully endorsed by the ASF. - +Apache Zeppelin is an effort undergoing [incubation](https://incubator.apache.org/index.html) at The Apache Software Foundation (ASF), sponsored by the Incubator. Incubation is required of all newly accepted projects until a further review indicates that the infrastructure, communications, and decision making process have stabilized in a manner consistent with other successful ASF projects. While incubation status is not necessarily a reflection of the completeness or stability of the code, it does indicate that the project has yet to be fully endorsed by the ASF. \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-zeppelin/blob/83b4eea5/docs/manual/publish.md ---------------------------------------------------------------------- diff --git a/docs/manual/publish.md b/docs/manual/publish.md new file mode 100644 index 0000000..1559fba --- /dev/null +++ b/docs/manual/publish.md @@ -0,0 +1,48 @@ +--- +layout: page +title: "Publish your Paragraph" +description: "" +group: manual +--- +<!-- +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 %} + +## How can you publish your paragraph ? +Zeppelin provides a feature for publishing your notebook paragraph results. Using this feature, you can show Zeppelin notebook paragraph results in your own website. +It's very straightforward. Just use `<iframe>` tag in your page. + +> **Warning**: Please use this feature with caution and in a trusted environment only, as Zeppelin entire Webapp could be accessible for whoever visits your website. + +### Copy a Paragraph Link +A first step to publish your paragraph result is **Copy a Paragraph Link**. + + * After running a paragraph in your Zeppelin notebook, click a gear button located on the right side. Then, click **Link this Paragraph** menu like below image. +<center><img src="../assets/themes/zeppelin/img/docs-img/link-the-paragraph.png" height="100%" width="100%"></center> + + * Just copy the provided link. +<center><img src="../assets/themes/zeppelin/img/docs-img/copy-the-link.png" height="100%" width="100%"></center> + +### Embed the Paragraph to Your Website +For publishing the copied paragraph, you may use `<iframe>` tag in your website page. +For example, + +``` +<iframe src="http://< ip-address >:< port >/#/notebook/2B3QSZTKR/paragraph/...?asIframe" height="" width="" ></iframe> +``` + +Finally, you can show off your beautiful visualization results in your website. +<center><img src="../assets/themes/zeppelin/img/docs-img/your-website.png" height="90%" width="90%"></center> + +> **Note**: To embed the paragraph in a website, Zeppelin needs to be reachable by that website.
