You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@zeppelin.apache.org by rfilmyer <gi...@git.apache.org> on 2016/09/08 18:56:39 UTC
[GitHub] zeppelin pull request #1416: Rewrite of "Quick Start" page.
GitHub user rfilmyer opened a pull request:
https://github.com/apache/zeppelin/pull/1416
Rewrite of "Quick Start" page.
### What is this PR for?
A few sentences describing the overall goals of the pull request's commits.
First time? Check out the contributing guide - https://github.com/apache/zeppelin/blob/master/CONTRIBUTING.md
This is a rewrite of the "Quick Start" page, fixing syntax/grammar issues while trying to keep to the original content. I may look at other pages, but I wanted my first PR to be very small.
### What type of PR is it?
Documentation
### Todos
Verify the accuracy of the configuration settings section
### What is the Jira issue?
(Does this apply to documentation PRs?)
### How should this be tested?
Do documentation changes like this need to be tested?
If so, is the github preview sufficient for these changes? How is Zeppelin's markdown interpreter different than Github's?
If Github's MD preview isn't sufficient, is it possible to build the documentation locally?
### Screenshots (if appropriate)
### Questions:
* Since this is my first PR on the project, I limited the scope of my changes. Is there any desire to change the content of these pages in any way? Do we have documentation conventions?
You can merge this pull request into a Git repository by running:
$ git pull https://github.com/rfilmyer/zeppelin master
Alternatively you can review and apply these changes as the patch at:
https://github.com/apache/zeppelin/pull/1416.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 #1416
----
commit f2c126bdb9bfc51bb59b7b02e7cbcece92cf32de
Author: Roger Filmyer <ro...@gmail.com>
Date: 2016-09-08T18:45:54Z
Rewrite of "Quick Start"
I rewrote the "Quick Start"/installation page for syntax and grammar, trying to keep the to the original content as much as possible.
----
---
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 #1416: Rewrite of "Quick Start" page.
Posted by asfgit <gi...@git.apache.org>.
Github user asfgit closed the pull request at:
https://github.com/apache/zeppelin/pull/1416
---
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 #1416: Rewrite of "Quick Start" page.
Posted by AhyoungRyu <gi...@git.apache.org>.
Github user AhyoungRyu commented on the issue:
https://github.com/apache/zeppelin/pull/1416
Hi @rfilmyer, thanks for your first contribution to Zeppelin! I've just looked through the changes, definitely better. So LGTM I think \U0001f44d
Since this change is just for syntax/grammar fixing, github preview will be enough I guess. But If you want to check another docs pages, [Contributing to Documentation](http://zeppelin.apache.org/contribution/documentation.html) will guide you. This page will give you the answer about most of your questions that you might be wondered(e.g. Do we have documentation conventions?)
Ah, I can answer to you about this question directly in here.
> is it possible to build the documentation locally?
Yes it is. Please see "Dev Mode" section in the guide page I linked.
Please feel free to ask if you have any other questions. Zeppelin community will be happy to help you :D
---
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 #1416: Rewrite of "Quick Start" page.
Posted by AhyoungRyu <gi...@git.apache.org>.
Github user AhyoungRyu commented on the issue:
https://github.com/apache/zeppelin/pull/1416
@rfilmyer Actually it's up to you. If the changes that you want to contribute are also related to "Fixing syntax/grammar error", you can just push them here. Then the PR title needs to be updated accordingly. Maybe "Fix syntax/grammar errors in some documentations" ?
---
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 #1416: Rewrite of "Quick Start" page.
Posted by Leemoonsoo <gi...@git.apache.org>.
Github user Leemoonsoo commented on the issue:
https://github.com/apache/zeppelin/pull/1416
Thanks @rfilmyer for the great contribution!
Like @AhyoungRyu explained, you can either add more commits here or create new PR depending on further contribution you want to make.
LGTM
---
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 #1416: Rewrite of "Quick Start" page.
Posted by rfilmyer <gi...@git.apache.org>.
Github user rfilmyer commented on the issue:
https://github.com/apache/zeppelin/pull/1416
Thanks for the feedback! If I want to make more contributions, should I do it in this PR, or should I make a new one.
---
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 #1416: Rewrite of "Quick Start" page.
Posted by rfilmyer <gi...@git.apache.org>.
Github user rfilmyer commented on the issue:
https://github.com/apache/zeppelin/pull/1416
Alright. I'm probably going to make some more changes on this PR. (Probably 2 or 3 more pages).
---
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 #1416: Rewrite of "Quick Start" page.
Posted by AhyoungRyu <gi...@git.apache.org>.
Github user AhyoungRyu commented on the issue:
https://github.com/apache/zeppelin/pull/1416
@rfilmyer Ah if you want to make another changes, how about creating a [Jira issue](https://issues.apache.org/jira/browse/ZEPPELIN/?selectedTab=com.atlassian.jira.jira-projects-plugin:issues-panel) for that?
>What is the Jira issue?
(Does this apply to documentation PRs?)
Yes it does. Every Zeppelin-related issues can be reported in Jira. It's not a mandatory for now, but it's good to have one even if it's a minor issue. Also you can create another patch not in your `master` branch but sth like `ZEPPELIN-(Jira issue number)` branch.
---
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 #1416: Rewrite of "Quick Start" page.
Posted by rfilmyer <gi...@git.apache.org>.
Github user rfilmyer commented on the issue:
https://github.com/apache/zeppelin/pull/1416
I've been busy and sort of fallen into the trap that I was trying to avoid
by leaving this PR dead. This weekend I'm going to try to finish another
page, close this PR, and make other changes on a fresh one.
On Fri, Sep 23, 2016, 5:10 AM Ahyoung Ryu <no...@github.com> wrote:
> @rfilmyer <https://github.com/rfilmyer> Do you need any help? :D
>
> \u2014
> You are receiving this because you were mentioned.
> Reply to this email directly, view it on GitHub
> <https://github.com/apache/zeppelin/pull/1416#issuecomment-249175520>, or mute
> the thread
> <https://github.com/notifications/unsubscribe-auth/AFo6dc5K8XrywrO4-cfrCRlKFBkivfaTks5qs8HGgaJpZM4J4VHE>
> .
>
---
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 #1416: Rewrite of "Quick Start" page.
Posted by AhyoungRyu <gi...@git.apache.org>.
Github user AhyoungRyu commented on the issue:
https://github.com/apache/zeppelin/pull/1416
@rfilmyer Yeah thanks for sharing your plain :) Then merging this one into master if there are no more discussions.
---
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 #1416: Rewrite of "Quick Start" page.
Posted by AhyoungRyu <gi...@git.apache.org>.
Github user AhyoungRyu commented on the issue:
https://github.com/apache/zeppelin/pull/1416
@rfilmyer Do you need any help? :D
---
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.
---