Skip to content

Conversation

@AhyoungRyu
Copy link
Contributor

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

  • - Write a documentation for How can we publish Zeppelin paragraph results

Is there a relevant Jira issue?

ZEPPELIN-585

How should this be tested?

After apply this PR, just click `Quick Start -> Publish your Paragraph

Screenshots (if appropriate)

picture
picture2

Questions:

  • Does the licenses files need update? No
  • Is there breaking changes for older versions? No
  • Does this needs documentation? No

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think changing host name only necessary if someone is running Zeppelin locally (like a laptop) but want it to be accessible outside of it? In normal use cases, Zeppelin should be running on a server?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@felixcheung You're right. I think I have to change this line for the normal use case : )

@AhyoungRyu
Copy link
Contributor Author

@felixcheung Thank you for the review. I changed some sentences as your comments.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure what's the right name for it, maybe it's not a 'tab'? Is it a menu item?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@felixcheung I applied it too : )

@felixcheung
Copy link
Member

looks good.

docs/index.md Outdated
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

please checkout [here]
--> please visit [this page]

@corneadoug
Copy link
Contributor

We might want to add some kind of disclaimer because of security issues with that feature:

  • To embed the paragraph in a website, Zeppelin needs to reachable for that Website.
  • With that iframe url, anybody that visit the website might be able to access Zeppelin if the allow-access is not properly set
  • I'm not sure that this feature works if Shiro is activated on Zeppelin

@AhyoungRyu
Copy link
Contributor Author

@corneadoug
I applied your first issue.
However, so far, I'm not sure how we can deal with the second one. I just addressed as the current status of Zeppelin in this documentation.
And I think the third one needs to be tested. So I'll test it and ping this PR again : )

@felixcheung
Copy link
Member

"Zeppelin needs to be reachable for that Website" is probably better

@AhyoungRyu
Copy link
Contributor Author

@felixcheung Shamed. You're right. A verb is needed after to. I pushed it again : )

@AhyoungRyu
Copy link
Contributor Author

@corneadoug Sorry for the late response. I tested this feature with Shiro on. If Shiro is activated, the user need to enter userid & password in their website like below image.
captureimg

Then, after loggin in, the published paragraph is shown.
screen shot 2016-02-11 at 6 09 19 pm

Therefore, if anyone want to show their Zeppelin paragraph in their outside website, they need to deactivate Shiro authentication. (Actually, Shiro is deactivated by default until the user activate it on purpose.)
Do I need to address this issue in the docs?

Finally, you can see your beautiful visualization results in your web site.
<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 for that Website.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

reachable for -> reachable by

@AhyoungRyu
Copy link
Contributor Author

@corneadoug Thanks! I added a warning sentence to this docs as you said.

@corneadoug
Copy link
Contributor

LGTM

@felixcheung
Copy link
Member

merging then...

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants