-
Notifications
You must be signed in to change notification settings - Fork 2.8k
[ZEPPELIN-1219] Add searching feature to Zeppelin docs site #1266
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
docs/install/install.md
Outdated
| title: "Getting Started" | ||
| description: "" | ||
| title: "Quick Start" | ||
| description: "Welcome to your first trial to explore Apache Zeppelin! This page will help you to get started with some guide about installing Zeppelin, Starting with command line and configuration." |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This page will help you to get started and guide you through installation of Apache Zeppelin, running it in the command line and basic configuration options.
|
Great improvement @AhyoungRyu ! Posted few suggestions above. |
|
@bzz Really appreciate for your all precise comments! Updated several docs as you suggested :) |
d505e5d to
19d6c2c
Compare
fba800d to
7ec8854
Compare
|
It seems the CI failure is irrelevant with this PR. Can someone review this one? |
|
@AhyoungRyu it's better to post CI failure to help getting feedback faster AND search existing JIRA issues, to see if that is something know or being addressed elsewhere. Here is an example of what I mean for this PR: Single CI profile Spark 1.4\Scala 2.10 is failing here with Searching JIRA for Hope this helps! In this particular case (single test failure) it might be work to close and re-open to PR to see if the test failure is persistent\reproducible. In my experience if PR author try to follow such steps - that speeds up the review process by order of magnitude AND helps the project to make CI more stable. Documentation update + search looks great to me, merging to master after CI is re-triggered by @AhyoungRyu , if there is no further discussion. |
Yeah right, I should've done that. It was my bad. Let me re-trigger CI then :) |
|
@bzz After re-triggered CI build, it fails again only in |
No worries! A lot of people do not do this and ask no excuses. So let's just show them what excellence means, by annotating further CI failures in case of any, as you did for the last one here :) Different profile fails with the same flaky test, not relevant to the changeset. Looks great to me, and merging to master if there is no further discussion! |
### What is this PR for? Recently I added auto generated Table of Contents by #1031 and searching feature by #1266. So I wrote some guide to `docs/CONTRIBUTING.md` about how to use and how they can be applied to docs page. Hope this helps to new Zeppelin (docs) contributors :) ### What type of PR is it? Documentation ### Todos * [x] - Update `docs/README.md` ### What is the Jira issue? [ZEPPELIN-1323](https://issues.apache.org/jira/browse/ZEPPELIN-1323) ### How should this be tested? Just click `View` button on the top of the file diff :) ### Screenshots (if appropriate) ### Questions: * Does the licenses files need update? no * Is there breaking changes for older versions? no * Does this needs documentation? no Author: AhyoungRyu <[email protected]> Closes #1326 from AhyoungRyu/ZEPPELIN-1323 and squashes the following commits: e23286b [AhyoungRyu] Update some contents f74c676 [AhyoungRyu] Attach 'Apache' to the title in README.md f1eb6b3 [AhyoungRyu] Change Zeppelin docs link version to latest 2879ada [AhyoungRyu] Exclude docs/CONTRIBUTING.md 2f7520b [AhyoungRyu] Remove useless back slash b58183b [AhyoungRyu] Add new files: CONTRIBUTING.md 3c05b47 [AhyoungRyu] Update contents in docs/README.md
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 based site) using lunr.js.
How does it work?
I created

search_data.jsonwhich is used for docs info template.lunr.jscombines all of the text from all of the docs indocs/into_site/search_data.json. It looks like below.All the info are comes from Jekyll YAML front matter variables. (i.e. title, group, description.. that's why I rewrote all docs' title and description.)
search.js will do this job using this data!
What type of PR is it?
Improvement & Feature
Todos
TitleDescriptionsection (this will be used as the result preview)lunr.min.jsWhat is the Jira issue?
ZEPPELIN-1219
How should this be tested?
ZEPPELIN_HOME/docsdir -> please see docs/README.md#build-documentationsearchicon in navbar and go tosearch.htmlpagepython,spark,dynamic... )Screenshots (if appropriate)
Questions:
lunr.min.js