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 <[email protected]>
Date: 2016-06-13T10:28:36Z
Delete outdated images and add new images
commit 54d9b1e6694c057a5eeecdba252c279b8193e1d0
Author: AhyoungRyu <[email protected]>
Date: 2016-06-13T10:29:21Z
Combine text.md, html.md, table.md
commit d8bf2683cb45352282fd979b076c766fd3933f6a
Author: AhyoungRyu <[email protected]>
Date: 2016-06-13T10:32:01Z
Change 'Zeppelin Configuration' section placement so that it can be
separated
commit 0219877bda2d4409791a870b4be35f89b904db88
Author: AhyoungRyu <[email protected]>
Date: 2016-06-13T10:32:53Z
Fix dead link in virtual_machine.md
commit 725c50c64b439a5053eddfe86e0b32378a946c42
Author: AhyoungRyu <[email protected]>
Date: 2016-06-13T10:33:36Z
Improve dropdown menu and reorder menus
commit f07a43ca5b053124dbc3304e2a8c15c780be854a
Author: AhyoungRyu <[email protected]>
Date: 2016-06-13T10:37:31Z
Limit image width
commit c861c6b1f07cdd9f984f47b4b33c682e714894f9
Author: AhyoungRyu <[email protected]>
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 [email protected] or file a JIRA ticket
with INFRA.
---
