GitHub user Leemoonsoo opened a pull request:
https://github.com/apache/zeppelin/pull/1615
[ZEPPELIN-1644] make document easier to follow key instructions
### What is this PR for?
Doc should deliver key features and recommended usage more simple and easy
way.
- docs/install/install.md has lots of duplicated section with README.md.
- docs/install/install.md includes install from binary as well as build
from source. I've seen that makes some beginners try download binary and then
source build it again.
- recommended and key usage need to be highlighted.
- Be less verbose in key instructions. Move optional, additional info from
in the middle of key instruction to end of the each page.
### What type of PR is it?
Improvement
### Todos
* [x] - improve doc
### What is the Jira issue?
https://issues.apache.org/jira/browse/ZEPPELIN-1644
### How should this be tested?
Run doc locally
### Screenshots (if appropriate)
### 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/Leemoonsoo/zeppelin ZEPPELIN-1644
Alternatively you can review and apply these changes as the patch at:
https://github.com/apache/zeppelin/pull/1615.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 #1615
----
commit e59fe3fa615b87eccb6b854b37a3901f077f7c18
Author: Lee moon soo <[email protected]>
Date: 2016-11-08T18:46:21Z
make document easier to follow key instructions
----
---
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.
---