Skip to content

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

Closed
corneadoug wants to merge 17 commits intoapache:gh-pagesfrom
corneadoug:add/ContributeCategory
Closed

[ZEPPELIN-1346] Add contribution guidelines to the website#1354
corneadoug wants to merge 17 commits intoapache:gh-pagesfrom
corneadoug:add/ContributeCategory

Conversation

@corneadoug
Copy link
Copy Markdown
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


## 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
Copy Markdown
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
Copy Markdown
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


## How to contribute

There is multiple ways you can contribute to the project.
Copy link
Copy Markdown
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
Copy Markdown
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
Copy Markdown
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
Copy link
Copy Markdown
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
Copy Markdown
Contributor Author

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


#### Explanations

* The component function and the component's dependency injection is separated from the component definition
Copy link
Copy Markdown
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 :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants