You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@zeppelin.apache.org by AhyoungRyu <gi...@git.apache.org> on 2016/06/13 11:09:58 UTC
[GitHub] zeppelin pull request #1004: Improve first page and dropdown menu in documen...
GitHub user AhyoungRyu opened a pull request:
https://github.com/apache/zeppelin/pull/1004
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's hard 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`)
* [ ] - Combine with #995 after it 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)
### Screenshots (if appropriate)
- Dropdown menu
- First page
- **Before**
- **After**
### Questions:
* Does the licenses files need update? No
* Is there breaking changes for older versions? No
* Does this needs documentation? No
You can merge this pull request into a Git repository by running:
$ git pull https://github.com/AhyoungRyu/incubator-zeppelin ZEPPELIN-996
Alternatively you can review and apply these changes as the patch at:
https://github.com/apache/zeppelin/pull/1004.patch
To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:
This closes #1004
----
commit c910bf8434fbc5740ffba47dcab4a12bd4cdf1a3
Author: AhyoungRyu <fb...@hanmail.net>
Date: 2016-06-13T10:28:36Z
Delete outdated images and add new images
commit 54d9b1e6694c057a5eeecdba252c279b8193e1d0
Author: AhyoungRyu <fb...@hanmail.net>
Date: 2016-06-13T10:29:21Z
Combine text.md, html.md, table.md
commit d8bf2683cb45352282fd979b076c766fd3933f6a
Author: AhyoungRyu <fb...@hanmail.net>
Date: 2016-06-13T10:32:01Z
Change 'Zeppelin Configuration' section placement so that it can be separated
commit 0219877bda2d4409791a870b4be35f89b904db88
Author: AhyoungRyu <fb...@hanmail.net>
Date: 2016-06-13T10:32:53Z
Fix dead link in virtual_machine.md
commit 725c50c64b439a5053eddfe86e0b32378a946c42
Author: AhyoungRyu <fb...@hanmail.net>
Date: 2016-06-13T10:33:36Z
Improve dropdown menu and reorder menus
commit f07a43ca5b053124dbc3304e2a8c15c780be854a
Author: AhyoungRyu <fb...@hanmail.net>
Date: 2016-06-13T10:37:31Z
Limit image width
commit c861c6b1f07cdd9f984f47b4b33c682e714894f9
Author: AhyoungRyu <fb...@hanmail.net>
Date: 2016-06-13T10:40:36Z
Add all documentation list with short description to first page
----
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] zeppelin pull request #1004: [ZEPPELIN-996] Improve first page and dropdown ...
Posted by asfgit <gi...@git.apache.org>.
Github user asfgit closed the pull request at:
https://github.com/apache/zeppelin/pull/1004
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] zeppelin issue #1004: [ZEPPELIN-996] Improve first page and dropdown menu in...
Posted by AhyoungRyu <gi...@git.apache.org>.
Github user AhyoungRyu commented on the issue:
https://github.com/apache/zeppelin/pull/1004
@bzz Thanks for your prudent review! I just addressed them in [6a2f40b](https://github.com/apache/zeppelin/pull/1004/commits/6a2f40b73e65986bdd61b611c76243f7a8bd7916).
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] zeppelin issue #1004: [ZEPPELIN-996] Improve first page and dropdown menu in...
Posted by minahlee <gi...@git.apache.org>.
Github user minahlee commented on the issue:
https://github.com/apache/zeppelin/pull/1004
merging if there is no more discussion
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] zeppelin issue #1004: [ZEPPELIN-996] Improve first page and dropdown menu in...
Posted by AhyoungRyu <gi...@git.apache.org>.
Github user AhyoungRyu commented on the issue:
https://github.com/apache/zeppelin/pull/1004
@corneadoug Yeah you're right and it makes sense indeed. I addressed it :)
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] zeppelin issue #1004: [ZEPPELIN-996] Improve first page and dropdown menu in...
Posted by corneadoug <gi...@git.apache.org>.
Github user corneadoug commented on the issue:
https://github.com/apache/zeppelin/pull/1004
Great work,
Maybe in the case of the interpreter menu, we should bring the usage section before the available interpeters (since there is only one item)
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] zeppelin issue #1004: [ZEPPELIN-996] Improve first page and dropdown menu in...
Posted by AhyoungRyu <gi...@git.apache.org>.
Github user AhyoungRyu commented on the issue:
https://github.com/apache/zeppelin/pull/1004
@minahlee Thanks for your prudent feedback. I just addressed them to my last some commits as you said. And I also applied scrollbar to "More" tab.
BTW, I found an UI issue on "More" tab. When the screen width is small, some long text in the list are not visible. It was also fixed at [af70939](https://github.com/apache/zeppelin/pull/1004/commits/af70939b4231101e7f3760b6367a05704d3912c4)
- Before
- After
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] zeppelin issue #1004: [ZEPPELIN-996] Improve first page and dropdown menu in...
Posted by minahlee <gi...@git.apache.org>.
Github user minahlee commented on the issue:
https://github.com/apache/zeppelin/pull/1004
<img width="1280" alt="screen shot 2016-06-14 at 10 34 51 am" src="https://cloud.githubusercontent.com/assets/8503346/16052985/ad3fa0ec-321b-11e6-9f15-e9725cee700f.png">
This is what I see from my screen, and cannot scroll down lower. Can you adjust size of the dropdown menu?
And also, can we rollback the change of display system menu order to text -> html -> table? if there are a lot of menu then alphabetical order makes sense, but in this case I think better to display in order of basic to advanced
Other than above comments, this PR looks awesome!
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] zeppelin issue #1004: [ZEPPELIN-996] Improve first page and dropdown menu in...
Posted by corneadoug <gi...@git.apache.org>.
Github user corneadoug commented on the issue:
https://github.com/apache/zeppelin/pull/1004
Oh indeed,
Since they are more generalistic and also a but hidden down there, it could be a better read flow to have them right below the overview
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---