GitHub user 1ambda opened a pull request:
https://github.com/apache/zeppelin/pull/2371
[ZEPPELIN-2596] Improving documentation page
### What is this PR for?
Improving documentation page. Please check *TODO* and *Screenshots*
sections for detail.
The motivation is described in [the JIRA
ticket](https://issues.apache.org/jira/browse/ZEPPELIN-2583) and discussion is
ongoing on the mailing list.
### What type of PR is it?
[Improvement | Documentation]
### Todos
* [x] - improved the navbar style
* [x] - improved the main page
* [x] - re-organized content structure
* [x] - added tutorial pages: `spark_with_zeppelin.md`,
`python_with_zeppelin.md`, `sql_with_zeppelin.md` for overview
* [x] - added `multi_user_support.md` page to provide overview
* [x] - added the empty `interpreter_binding_mode` page. This will be
handed in the different issue:
[ZEPPELIN-2582](https://issues.apache.org/jira/browse/ZEPPELIN-2582)
### What is the Jira issue?
[ZEPPELIN-2596](https://issues.apache.org/jira/browse/ZEPPELIN-2596)
### How should this be tested?
1. checkout
2. `cd docs`
3. `bundle install` (make sure that you have ruby 2.1.0+ and bundle)
4. `bundle exec jekyll serve --watch`
5. open `localhost:4000`
### Screenshots (if appropriate)
#### better navbar: before
#### better navbar: after
#### improved main page: before
#### improved main page: after
#### organized content structure: before
#### organized content structure: after
### Questions:
* Does the licenses files need update? - NO
* Is there breaking changes for older versions? - NO
* Does this needs documentation? - related with docs
You can merge this pull request into a Git repository by running:
$ git pull https://github.com/1ambda/zeppelin updating-version-doc
Alternatively you can review and apply these changes as the patch at:
https://github.com/apache/zeppelin/pull/2371.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 #2371
----
commit bb44cc5419785433fb5170334293862322864d68
Author: 1ambda <[email protected]>
Date: 2017-05-25T02:22:51Z
commit
commit a5d4b4167c0bd6cacff2de63388c3dd7bbac0da6
Author: 1ambda <[email protected]>
Date: 2017-05-26T01:21:42Z
feat: Style collapsed nav for mobile browser
commit a89be9dc1bb39420f65509a7a929fb712373a1db
Author: 1ambda <[email protected]>
Date: 2017-05-26T01:24:52Z
fix: Add RL padding for mobile browser
commit 1d55a60715f6e5148ca7d9fe088a12754f9488f9
Author: 1ambda <[email protected]>
Date: 2017-05-26T01:29:02Z
fix: Better image display in index.md
commit 50aad6ba09dc1aa52f12c8969ec7aa1061a3c79f
Author: 1ambda <[email protected]>
Date: 2017-05-26T05:13:44Z
feat: Hide version in navbar when md
commit 111bdbaf0eeb94ef64f068b2195e00e09bc593bb
Author: 1ambda <[email protected]>
Date: 2017-05-26T05:40:20Z
feat: Update doc section names
commit dc58dcdc5b975f330cd23faf331c58a955a0952a
Author: 1ambda <[email protected]>
Date: 2017-05-26T06:15:03Z
fix: doens't display navbar version in small
commit ccfb100920c37ef4bc60209a718c257803499ff3
Author: 1ambda <[email protected]>
Date: 2017-05-26T08:26:01Z
feat: Change URLs in nav, index
commit b75903aefcd90bfc55a90fe4a569e1bb6394fb31
Author: 1ambda <[email protected]>
Date: 2017-05-26T08:46:43Z
fix: Add missing links
commit fd2e6c7d33976e8b8c0cd591470db5162083a364
Author: 1ambda <[email protected]>
Date: 2017-05-26T09:02:25Z
feat: rename /quickstart
commit 6b393a93eb96a1d199fd456ec7637a1d33ab9fbe
Author: 1ambda <[email protected]>
Date: 2017-05-26T13:02:20Z
feat: Add docs/usage
commit 97aea24860a741647f55cb1a18a31b63eca67a8b
Author: 1ambda <[email protected]>
Date: 2017-05-27T01:03:40Z
fix: URLs in quickstart
commit 8b079a06614c09d064d60cdd4749f0ab4e9c0428
Author: 1ambda <[email protected]>
Date: 2017-05-27T01:03:52Z
fix: URLs in setup
commit fada89fa3390219651de556990b3239ce6ed7cf1
Author: 1ambda <[email protected]>
Date: 2017-05-27T01:09:20Z
docs: Update install.md
commit b3c98ab58a2669f2a43ad9c574f446172b67cf7c
Author: 1ambda <[email protected]>
Date: 2017-05-27T01:25:09Z
fix: URLs in development
commit abad22029d4d43b6cf67fbb280d87d275fa14654
Author: 1ambda <[email protected]>
Date: 2017-05-27T01:26:20Z
fix: an invalid link in navbar
commit 21f417d0cb9330d21baa14310181ac7df79e7550
Author: 1ambda <[email protected]>
Date: 2017-05-28T02:45:38Z
docs: Improve helium doc
commit 8dbc68f2aa7bcf1a8a88c6603ad454f0086d9fca
Author: 1ambda <[email protected]>
Date: 2017-05-28T02:58:25Z
docs: Improve install doc
commit 0cc10a3a587aaf4533d000b42e763015f361bb05
Author: 1ambda <[email protected]>
Date: 2017-05-28T03:21:04Z
docs: Improve impersonation page
commit 2b442e7bd156abf1f607795a3355223d358f79d1
Author: 1ambda <[email protected]>
Date: 2017-05-28T03:21:58Z
fix: Remove docker doc link
commit 8e0bdab2f2d306227a05df003b99ae5cc5e0f3bb
Author: 1ambda <[email protected]>
Date: 2017-05-29T04:11:05Z
fix: Remove sample text from trouble_shooting.md
commit 2dce7cd94754113ee682137d986d439e91e2bd41
Author: 1ambda <[email protected]>
Date: 2017-05-29T04:35:54Z
fix: Increase font size to 15px
commit c4e77d773d96b622d263fef7008c21c3288e5673
Author: 1ambda <[email protected]>
Date: 2017-05-29T04:38:22Z
docs: Add multi_user_support.md
commit 84c700ac4f565f6e2466142cee488e31df193339
Author: 1ambda <[email protected]>
Date: 2017-05-29T04:42:44Z
fix: Simplify install.md
commit 2993c8e74a561f6350e451877de55d61efc30aa2
Author: 1ambda <[email protected]>
Date: 2017-05-29T04:52:57Z
docs: Update upgrading.md
commit 90003e3c7e15ca735feb18276dd71be78b7afc23
Author: 1ambda <[email protected]>
Date: 2017-05-29T05:00:07Z
docs: Add empty personalized_mode.md
commit 9a689eae32e32542a6e3e9eca092ec7dc1af3e1c
Author: 1ambda <[email protected]>
Date: 2017-05-29T05:04:38Z
docs: Add empty interpreter_binding_mode.md
commit 88e94b7e18fb80190860179a048fbfc6d75daf96
Author: 1ambda <[email protected]>
Date: 2017-05-29T05:37:17Z
docs: Improve proxy doc
commit 0002d95890acf8eabd5ecf77655fc7eb1508f768
Author: 1ambda <[email protected]>
Date: 2017-05-29T06:29:22Z
docs: Add spark_with_zeppelin.md
commit fe44e45a3e3c50fd5b77132380c78b9ed68a86c9
Author: 1ambda <[email protected]>
Date: 2017-05-29T06:56:48Z
docs: Add sql_with_zeppelin
----
---
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.
---
