Skip to content

[ZEPPELIN-998] Extend install.md -> Quick Start#1010

Closed
AhyoungRyu wants to merge 4 commits intoapache:masterfrom
AhyoungRyu:ZEPPELIN-998
Closed

[ZEPPELIN-998] Extend install.md -> Quick Start#1010
AhyoungRyu wants to merge 4 commits intoapache:masterfrom
AhyoungRyu:ZEPPELIN-998

Conversation

@AhyoungRyu
Copy link
Copy Markdown
Contributor

@AhyoungRyu AhyoungRyu commented Jun 14, 2016 •
edited
Loading

What is this PR for?

Most of other projects have Quick Start or Getting Started page for the beginner. Currently, Zeppelin also has Zeppelin Install which is similar with those kind of instruction page. But it has only contents that explain just installation and configuration. So I updated this page to Quick Start so that it can include step by step guide for the beginners.

What type of PR is it?

Improvement & Documentation

Todos

  • - Add each title link to the head of documentation
  • - Add more information about Zeppelin installation
  • - Reorder contents

What is the Jira issue?

ZEPPELIN-998

How should this be tested?

See the attached screenshot images

Screenshots (if appropriate)

screen shot 2016-06-14 at 2 59 47 pm

screen shot 2016-06-14 at 3 00 01 pm

screen shot 2016-06-14 at 3 00 15 pm

screen shot 2016-06-14 at 3 00 27 pm

screen shot 2016-06-14 at 3 00 38 pm

### Questions: - Does the licenses files need update? No - Is there breaking changes for older versions? No - Does this needs documentation? No

bzz
bzz reviewed Jun 14, 2016
View reviewed changes
docs/install/install.md Outdated
```

## What is the next?
Congratulation to your successful Zeppelin installation! Here are two next steps you might need.
Copy link
Copy Markdown
Member

@bzz bzz Jun 14, 2016 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I belive it is a typo - it should be Congratulation _on_ as it's not an Apache Zeppelin installation that is being congratulated here, but the user.

Copy link
Copy Markdown
Contributor Author

@AhyoungRyu AhyoungRyu Jun 14, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@bzz Yeah you're right. I just updated it :)

@bzz
Copy link
Copy Markdown
Member

bzz commented Jun 14, 2016

@AhyoungRyu thank you for great effort structuring the docs!

It looks awesome, just two things that I have noticed:

  1. can you please double check that project is referred as Apache Zeppelin everywhere (following branding guidelines)

  2. having npm installed is not a requirement to build project from sources

    mvn package should be enough and will take care of installing both, local node as well as NPM so I would suggest we remove mention of npm from 'building from source section'

@AhyoungRyu
Copy link
Copy Markdown
Contributor Author

AhyoungRyu commented Jun 14, 2016

@bzz Really appreciated to your review again :)

  • I added Apache before the most of Zeppelin.
  • I didn't noticed that "npm, downloaded by Maven during build phase" in README.md#requirements. So I removed it as you said.

@bzz
Copy link
Copy Markdown
Member

bzz commented Jun 15, 2016 •
edited
Loading

@AhyoungRyu great job! Let me take another pass on it plz.

Meanwhile, is removal of conf/shiro.ini a part of this quickstart?

bzz
bzz reviewed Jun 15, 2016
View reviewed changes
docs/install/install.md Outdated
Welcome to your first trial to explore Zeppelin!
# Quick Start
Welcome to your first trial to explore Apache Zeppelin!
This page will help you to get started with Apache Zeppelin. Here is the list of this page.
Copy link
Copy Markdown
Member

@bzz bzz Jun 15, 2016

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 here is the list of topics covered

@AhyoungRyu
Copy link
Copy Markdown
Contributor Author

AhyoungRyu commented Jun 15, 2016

@bzz Oh my. That's my bad. I'll revert it now :)

bzz
bzz reviewed Jun 15, 2016
View reviewed changes
docs/install/install.md Outdated
## Installation

If you want to install Zeppelin with latest binary package, please visit [this page](http://zeppelin.apache.org/download.html).
Apache Zeppelin officially tested on the below environment.
Copy link
Copy Markdown
Member

@bzz bzz Jun 15, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Apache Zeppelin officially supports and is tested on next environments

bzz
bzz reviewed Jun 15, 2016
View reviewed changes
docs/install/install.md Outdated
After unpacking, jump to [Starting Apache Zeppelin with Command Line](#starting-apache-zeppelin-with-command-line) section.

### Building from Source
If you want to build from the source, there are more requirements.
Copy link
Copy Markdown
Member

@bzz bzz Jun 15, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If you want to build from the source, the software below needs to be installed on your system

@bzz
Copy link
Copy Markdown
Member

bzz commented Jun 15, 2016

Thanks for prompt response!
Your documentation update looks great to me, modulo few minor suggestions above.

Please feel free to use them at your will, otherwise I think it's ready to be merged.

@AhyoungRyu
Copy link
Copy Markdown
Contributor Author

AhyoungRyu commented Jun 15, 2016

@bzz Thanks for all of your suggestions again. I've just addressed them. Please check my last commit :)

@AhyoungRyu AhyoungRyu closed this Jun 15, 2016
@AhyoungRyu AhyoungRyu reopened this Jun 15, 2016
@AhyoungRyu AhyoungRyu force-pushed the ZEPPELIN-998 branch 3 times, most recently from 5aa330c to b2b1aa8 Compare June 15, 2016 20:46
@AhyoungRyu AhyoungRyu changed the title [ZEPPELIN-998] Extend install.md -> Quick Start [ZEPPELIN-998][WIP] Extend install.md -> Quick Start Jun 16, 2016
@bzz
Copy link
Copy Markdown
Member

bzz commented Jun 17, 2016

Looks great to me, thank you @AhyoungRyu

Will merge to master, if there is no further discussion

@AhyoungRyu AhyoungRyu changed the title [ZEPPELIN-998][WIP] Extend install.md -> Quick Start [ZEPPELIN-998] Extend install.md -> Quick Start Jun 17, 2016
@AhyoungRyu AhyoungRyu mentioned this pull request Jun 17, 2016
Closed
6 tasks
@asfgit asfgit closed this in 70d22d3 Jun 20, 2016
asfgit pushed a commit that referenced this pull request Jun 24, 2016
@AhyoungRyu @minahlee
[ZEPPELIN-998] Extend install.md -> Quick Start
b53019c 
### What is this PR for?
Most of other projects have **Quick Start** or **Getting Started** page for the beginner. Currently, Zeppelin also has [Zeppelin Install](https://zeppelin.apache.org/docs/0.6.0-SNAPSHOT/install/install.html) which is similar with those kind of instruction page. But it has only contents that explain just installation and configuration. So I updated this page to **Quick Start** so that it can include step by step guide for the beginners.

### What type of PR is it?
Improvement & Documentation

### Todos
* [x] - Add each title link to the head of documentation
* [x] - Add more information about Zeppelin installation
* [x] - Reorder contents

### What is the Jira issue?
[ZEPPELIN-998](https://issues.apache.org/jira/browse/ZEPPELIN-998)

### How should this be tested?
See the attached screenshot images

### Screenshots (if appropriate)
<img width="809" alt="screen shot 2016-06-14 at 2 59 47 pm" src="https://cloud.githubusercontent.com/assets/10060731/16061227/d88abe56-3240-11e6-845c-e37a9975aceb.png">
<img width="796" alt="screen shot 2016-06-14 at 3 00 01 pm" src="https://cloud.githubusercontent.com/assets/10060731/16061229/daca8b06-3240-11e6-821b-7d118b7b3e09.png">
<img width="789" alt="screen shot 2016-06-14 at 3 00 15 pm" src="https://cloud.githubusercontent.com/assets/10060731/16061234/dd12072c-3240-11e6-9a0a-cf1e320fd879.png">
<img width="785" alt="screen shot 2016-06-14 at 3 00 27 pm" src="https://cloud.githubusercontent.com/assets/10060731/16061238/df7f904c-3240-11e6-83e0-73f3688c0815.png">
<img width="789" alt="screen shot 2016-06-14 at 3 00 38 pm" src="https://cloud.githubusercontent.com/assets/10060731/16061242/e1ad1402-3240-11e6-81ba-2e7125cec98e.png">

### 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 #1010 from AhyoungRyu/ZEPPELIN-998 and squashes the following commits:

b2b1aa8 [AhyoungRyu] Change some sentences as @bzz suggested
12da298 [AhyoungRyu] Fix pointing link in index.md
af50576 [AhyoungRyu] Address @bzz feedback
af68a32 [AhyoungRyu] Extend install.md -> Quick Start

(cherry picked from commit 70d22d3)
Signed-off-by: Mina Lee <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@AhyoungRyu @bzz