-
Notifications
You must be signed in to change notification settings - Fork 2.8k
Rewrite of "Quick Start" page. #1416
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
I rewrote the "Quick Start"/installation page for syntax and grammar, trying to keep the to the original content as much as possible.
|
Hi @rfilmyer, thanks for your first contribution to Zeppelin! I've just looked through the changes, definitely better. So LGTM I think 👍 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 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.
Yes it is. Please see "Dev Mode" section in the guide page I linked. |
|
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. |
|
@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" ? |
|
Thanks @rfilmyer for the great contribution! LGTM |
|
Alright. I'm probably going to make some more changes on this PR. (Probably 2 or 3 more pages). |
|
@rfilmyer Do you need any help? :D |
|
I've been busy and sort of fallen into the trap that I was trying to avoid On Fri, Sep 23, 2016, 5:10 AM Ahyoung Ryu [email protected] wrote:
|
|
@rfilmyer Yeah thanks for sharing your plain :) Then merging this one into master if there are no more discussions. |
|
@rfilmyer Ah if you want to make another changes, how about creating a Jira issue for that?
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 |
### What is this PR for? After #1416 merged, the bullet list in https://zeppelin.apache.org/docs/0.7.0-SNAPSHOT/install/install.html#installation isn't properly rendered now. It needs an extra newline. ### What type of PR is it? Hot Fix ### Screenshots (if appropriate) - Before <img width="834" alt="screen shot 2016-09-25 at 4 13 25 pm" src="https://cloud.githubusercontent.com/assets/10060731/18813621/5e10c2dc-833b-11e6-8410-bb1d37d8228b.png"> - After <img width="834" alt="screen shot 2016-09-25 at 4 13 36 pm" src="https://cloud.githubusercontent.com/assets/10060731/18813622/6705b744-833b-11e6-8fab-3a69d8585c7a.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 #1457 from AhyoungRyu/fix/install.md and squashes the following commits: 73c1a4f [AhyoungRyu] Add a newline for bullet list markdown rendering
### 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? Author: Roger Filmyer <[email protected]> Closes apache#1416 from rfilmyer/master and squashes the following commits: f2c126b [Roger Filmyer] Rewrite of "Quick Start"
### What is this PR for? After apache#1416 merged, the bullet list in https://zeppelin.apache.org/docs/0.7.0-SNAPSHOT/install/install.html#installation isn't properly rendered now. It needs an extra newline. ### What type of PR is it? Hot Fix ### Screenshots (if appropriate) - Before <img width="834" alt="screen shot 2016-09-25 at 4 13 25 pm" src="https://cloud.githubusercontent.com/assets/10060731/18813621/5e10c2dc-833b-11e6-8410-bb1d37d8228b.png"> - After <img width="834" alt="screen shot 2016-09-25 at 4 13 36 pm" src="https://cloud.githubusercontent.com/assets/10060731/18813622/6705b744-833b-11e6-8fab-3a69d8585c7a.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 apache#1457 from AhyoungRyu/fix/install.md and squashes the following commits: 73c1a4f [AhyoungRyu] Add a newline for bullet list markdown rendering
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: