Skip to content
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.

Sign up for GitHub

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

Jump to bottom

[ZEPPELIN-1346] Add contribution guidelines to the website #1354

Closed
wants to merge 17 commits into from
Closed

[ZEPPELIN-1346] Add contribution guidelines to the website #1354

wants to merge 17 commits into from

Conversation

corneadoug
Copy link
Contributor

What is this PR for?

This PR is bringing Contribution guidelines to the website.
We also introduce a sidemenu on those pages allowing to create additional content.
As an example, for the Web Application Guidelines, we added a page about "Defining Components"

In a different PR, we will remove the contributing markdown, and change the links in the repository to the website.

What type of PR is it?

Documentation

What is the Jira issue?

https://issues.apache.org/jira/browse/ZEPPELIN-1346

How should this be tested?

Build the website locally and visit the community page

Screenshots (if appropriate)

screen shot 2016-08-23 at 3 50 41 pm

screen shot 2016-08-23 at 3 50 51 pm

screen shot 2016-08-23 at 3 50 33 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 Aug 24, 2016
View reviewed changes
contribution/general.md

## Becoming a Committer

The PPMC adds new committers from the active contributors, based on their contribution to Zeppelin. The qualifications for new committers include:
Copy link
Member

Choose a reason for hiding this comment

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

PPMC -> PMC

@bzz
Copy link
Member

bzz commented Aug 24, 2016

Overall looks great to me, thank you @corneadoug for taking care! Few minor comments above.
\cc @AhyoungRyu for review

AhyoungRyu
AhyoungRyu reviewed Aug 24, 2016
View reviewed changes
_includes/sub-views/community/contribute.md

## How to contribute

There is multiple ways you can contribute to the project.
Copy link
Contributor

Choose a reason for hiding this comment

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

There are~??

@AhyoungRyu
Copy link
Contributor

@corneadoug Great work! Definitely this way would be better than we put CONTRIBUTING.md under each component dir in Zeppelin github. I also left some minor comments.
One question. If this PR can cover the other contributing guide(not only web application), can we put docs/CONTRIBUTING.md as well? What do you think? I can create a PR to your repo for that if you're positive :D

@corneadoug
Copy link
Contributor Author

@AhyoungRyu That's the goal of having the side menu, to be able to have contribution guide focused on specific components (Back-end, front-end, interpreters, website, docs etc..)

I only wanted to cover the structure in this PR, that's why there is web application as example.
So you can either do a PR after this one is merged, or directly in this PR, your choice!

@AhyoungRyu AhyoungRyu mentioned this pull request Aug 24, 2016
Merged
@AhyoungRyu
Copy link
Contributor

@corneadoug Thank you for the explanation. Since it's a only one page, i've created a PR at your repo :)
(Just combined docs/README.md & docs/CONTRIBUTING.md contents)

@corneadoug
Copy link
Contributor Author

@bzz I added a section with the Selenium CLI command, can you double check it?

AhyoungRyu
AhyoungRyu reviewed Aug 24, 2016
View reviewed changes
contribution/zeppelinweb/goodPracticeGuide01.md

#### Explanations

* The component function and the component's dependency injection is separated from the component definition
Copy link
Contributor

Choose a reason for hiding this comment

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

@corneadoug Sorry again. I think is -> are separated is right :)

@corneadoug
Copy link
Contributor Author

All the changes have been addressed. LGTM?

@AhyoungRyu
Copy link
Contributor

LGTM 👍

@corneadoug corneadoug closed this Aug 24, 2016
@corneadoug corneadoug deleted the add/ContributeCategory branch August 24, 2016 08:26
@corneadoug corneadoug mentioned this pull request Aug 24, 2016
Closed
asfgit pushed a commit that referenced this pull request Sep 6, 2016
@corneadoug
[ZEPPELIN-1346] Add contribution guidelines to the website
9647ba4 
### What is this PR for?
Recreation of #1354
This PR is bringing Contribution guidelines to the website.
We also introduce a sidemenu on those pages allowing to create additional content.
As an example, for the Web Application Guidelines, we added a page about "Defining Components"

In a different PR, we will remove the contributing markdown, and change the links in the repository to the website.

The layout of the doc was slightly modified to allow a larger documentation at max size.
It was also modified to accommodate better on smaller screens.

### What type of PR is it?
Documentation

### What is the Jira issue?
https://issues.apache.org/jira/browse/ZEPPELIN-1346

### How should this be tested?
Build the website locally and visit the community page

### Screenshots (if appropriate)
![screen shot 2016-08-23 at 3 50 41 pm](https://cloud.githubusercontent.com/assets/710411/17882774/8da96b86-6949-11e6-8789-fed606b64fd8.png)

<img width="1346" alt="screen shot 2016-08-31 at 10 33 36 am" src="https://cloud.githubusercontent.com/assets/710411/18113150/7bb2a152-6f68-11e6-8678-667c2d4f07ef.png">

#### Layout update (Before / After)

Navbar Bug fix

<img width="908" alt="screen shot 2016-08-31 at 10 35 14 am" src="https://cloud.githubusercontent.com/assets/710411/18113174/a374ee84-6f68-11e6-8878-a8eb7b564bd7.png">

<img width="781" alt="screen shot 2016-08-31 at 10 31 18 am" src="https://cloud.githubusercontent.com/assets/710411/18113161/9a280b0e-6f68-11e6-8dc5-1656b5bc86b1.png">

Small Device Margin Improvement

<img width="402" alt="screen shot 2016-08-31 at 10 35 34 am" src="https://cloud.githubusercontent.com/assets/710411/18113176/a590f74e-6f68-11e6-8468-18274413be28.png">

<img width="398" alt="screen shot 2016-08-31 at 10 31 28 am" src="https://cloud.githubusercontent.com/assets/710411/18113168/9e904d5a-6f68-11e6-9a2e-2536cbf7a37f.png">

Content Width Change

<img width="953" alt="screen shot 2016-08-31 at 10 33 50 am" src="https://cloud.githubusercontent.com/assets/710411/18113180/a7fc954c-6f68-11e6-8d58-08afb54549c1.png">

<img width="1023" alt="screen shot 2016-08-31 at 10 32 12 am" src="https://cloud.githubusercontent.com/assets/710411/18113169/a0d71aee-6f68-11e6-8654-3f124bd2a71b.png">

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

Author: Damien CORNEAU <corneadoug@gmail.com>
Author: AhyoungRyu <fbdkdud93@hanmail.net>
Author: CORNEAU Damien <corneadoug@gmail.com>

Closes #1356 from corneadoug/add/ContributeCategory and squashes the following commits:

1a45b92 [Damien CORNEAU] Improve margin for small devices
9169c68 [Damien CORNEAU] Improve wording and spacing in contribution docs
d31cf3f [Damien CORNEAU] Improve CSS for the content
a469d52 [Damien CORNEAU] Extend pages_list to support multi group
79d15a3 [Damien CORNEAU] Add Contribution Guidelines to SubMenu
934afd9 [Damien CORNEAU] Change Zeppelin to Apache Zeppelin in general.md
2d62d20 [CORNEAU Damien] Merge pull request #6 from AhyoungRyu/add/ContributeCategory-ahyoung
e34fc64 [Damien CORNEAU] fix typo in front-end doc
a4c924b [AhyoungRyu] Remove 'menu' property
e0b4c8d [Damien CORNEAU] change name of good practice file
9882670 [Damien CORNEAU] Allows contribution page without side Menu
318c4c1 [AhyoungRyu] Add section for 'For committers only'
8f69f28 [Damien CORNEAU] Add GUI integration tests CLI
e7209ea [AhyoungRyu] Add docs contribution guide
94d653b [Damien CORNEAU] Fix typos
81493ab [Damien CORNEAU] Change Side Menu style
666f3ec [Damien CORNEAU] Add first Zeppelin-web best practices page
306ae06 [Damien CORNEAU] Add zeppelin-web GPG menu
c933c19 [Damien CORNEAU] Add zeppelin-web contribution page
5f7e2bd [Damien CORNEAU] Add a side menu template
acc68b5 [Damien CORNEAU] Add contribution Guidelines to the website
cb87608 [Damien CORNEAU] Add forgotten license headers
06238fb [Damien CORNEAU] Modify the Community page
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
3 participants
@corneadoug @bzz @AhyoungRyu