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.

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

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

Closed
wants to merge 23 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
23 commits
Select commit Hold shift + click to select a range
06238fb
Modify the Community page
corneadoug Aug 22, 2016
cb87608
Add forgotten license headers
corneadoug Aug 22, 2016
acc68b5
Add contribution Guidelines to the website
corneadoug Aug 22, 2016
5f7e2bd
Add a side menu template
corneadoug Aug 22, 2016
c933c19
Add zeppelin-web contribution page
corneadoug Aug 22, 2016
306ae06
Add zeppelin-web GPG menu
corneadoug Aug 22, 2016
666f3ec
Add first Zeppelin-web best practices page
corneadoug Aug 23, 2016
81493ab
Change Side Menu style
corneadoug Aug 23, 2016
94d653b
Fix typos
corneadoug Aug 24, 2016
e7209ea
Add docs contribution guide
AhyoungRyu Aug 24, 2016
8f69f28
Add GUI integration tests CLI
corneadoug Aug 24, 2016
318c4c1
Add section for 'For committers only'
AhyoungRyu Aug 24, 2016
9882670
Allows contribution page without side Menu
corneadoug Aug 24, 2016
e0b4c8d
change name of good practice file
corneadoug Aug 24, 2016
a4c924b
Remove 'menu' property
AhyoungRyu Aug 24, 2016
e34fc64
fix typo in front-end doc
corneadoug Aug 24, 2016
2d62d20
Merge pull request #6 from AhyoungRyu/add/ContributeCategory-ahyoung
corneadoug Aug 24, 2016
934afd9
Change Zeppelin to Apache Zeppelin in general.md
corneadoug Aug 30, 2016
79d15a3
Add Contribution Guidelines to SubMenu
corneadoug Aug 30, 2016
a469d52
Extend pages_list to support multi group
corneadoug Aug 30, 2016
d31cf3f
Improve CSS for the content
corneadoug Aug 31, 2016
9169c68
Improve wording and spacing in contribution docs
corneadoug Aug 31, 2016
1a45b92
Improve margin for small devices
corneadoug Aug 31, 2016
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 22 additions & 20 deletions _includes/JB/pages_list
Original file line number Diff line number Diff line change
Expand Up @@ -5,18 +5,18 @@ Usage:
2) include JB/pages_list
example:
<ul>
{% assign pages_list = site.pages %}
{% include JB/pages_list %}
</ul>
Grouping: (optional):
assign the 'group' variable to constrain the list to only pages/posts
in the given group. Note you must define the group manually in the page/post
meta-data to use this feature.
Grouping is mainly helpful for non-post pages.
If you want to group posts, it's easier/better to tag them, then pass the tagged posts array.
i.e. site.tags.cool_tag (this returns an array of posts tagged: cool_tag)
{% assign pages_list = site.pages %}
{% include JB/pages_list %}
</ul>

Grouping: (optional):
assign the 'group' variable to constrain the list to only pages/posts
in the given group. Note you must define the group manually in the page/post
meta-data to use this feature.
Grouping is mainly helpful for non-post pages.
If you want to group posts, it's easier/better to tag them, then pass the tagged posts array.
i.e. site.tags.cool_tag (this returns an array of posts tagged: cool_tag)

This helper can be seen in use at: ../_layouts/default.html
-->{% endcomment %}

Expand All @@ -25,15 +25,17 @@ Usage:
{% else %}
{% for node in pages_list %}
{% if node.title != null %}
{% if group == null or group == node.group %}
{% if page.url == node.url %}
<li class="active"><a href="{{ BASE_PATH }}{{node.url}}" class="active">{{node.title}}</a></li>
{% else %}
<li><a href="{{ BASE_PATH }}{{node.url}}">{{node.title}}</a></li>
{% endif %}
{% endif %}
{% for cat in node.group %}
{% if cat == group %}
{% if page.url == node.url %}
<li class="active"><a href="{{ BASE_PATH }}{{node.url}}" class="active">{{node.title}}</a></li>
{% else %}
<li><a href="{{ BASE_PATH }}{{node.url}}">{{node.title}}</a></li>
{% endif %}
{% endif %}
{% endfor %}
{% endif %}
{% endfor %}
{% endif %}
{% assign pages_list = nil %}
{% assign group = nil %}
{% assign group = nil %}
41 changes: 41 additions & 0 deletions _includes/sub-views/community/contribute.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
<!--
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->

## How to contribute

There are multiple ways you can contribute to the project.
And help is always welcome!

### Issue Tracker

Apache Zeppelin uses JIRA as an [Issue Tracker](https://issues.apache.org/jira/browse/ZEPPELIN).
Don't hesitate to report new bugs and improvements ideas.

#### Contribute to the source code

We like to get code contributions through Pull Requests on our [Github Mirror](https://github.com/apache/zeppelin).

But before starting, please read our [Contribution guidelines](/contribution/contributions.html), it will give
you important information about our review process, and pointers on how to make a good code contribution.

You can visit our [Issue Tracker](https://issues.apache.org/jira/browse/ZEPPELIN) to find issues to resolve,
and if your are a newcomer and don't know where to get started, we have set some [beginner issues](https://issues.apache.org/jira/browse/ZEPPELIN-1245?jql=project%20%3D%20ZEPPELIN%20AND%20status%20%3D%20Open%20AND%20labels%20%3D%20beginner).

#### Other contributions

Not much of a coder? There are other ways to help out:

* Documentation and website improvements are always welcome
* Helping each other by answering questions on the Mailing List
* Participating in reviewing contributions.
27 changes: 27 additions & 0 deletions _includes/sub-views/community/mailinglist.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
<!--
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->

## Mailing list

Get help using Apache Zeppelin or contribute to the project on our mailing lists:

* __Users :__ [subscribe](mailto:users-subscribe@zeppelin.apache.org?subject=send this email to subscribe), [unsubscribe](mailto:users-unsubscribe@zeppelin.apache.org?subject=send this email to unsubscribe), [archives](http://mail-archives.apache.org/mod_mbox/zeppelin-users/)
<br/>
for usage questions, help, and announcements.
* __Dev :__ [subscribe](mailto:dev-subscribe@zeppelin.apache.org?subject=send this email to subscribe), [unsubscribe](mailto:dev-unsubscribe@zeppelin.apache.org?subject=send this email to unsubscribe), [archives](http://mail-archives.apache.org/mod_mbox/zeppelin-dev/)
<br/>
for people wanting to contribute to the project.
* __Commits :__ [subscribe](mailto:commits-subscribe@zeppelin.apache.org?subject=send this email to subscribe), [unsubscribe](mailto:commits-unsubscribe@zeppelin.apache.org?subject=send this email to unsubscribe), [archives](http://mail-archives.apache.org/mod_mbox/zeppelin-commits/)
<br/>
for commit messages and patches.
16 changes: 16 additions & 0 deletions _includes/themes/zeppelin/sideMenu.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
<div class="row">
{% if page.menu %}
<div class="sideMenu col-sm-3">
{% assign pages_list = site.pages %}
{% assign group = page.menu %}
{% include JB/pages_list %}
</div>
<div class="col-sm-9">
{{ content }}
</div>
{% else %}
<div class="col-sm-12">
{{ content }}
</div>
{% endif %}
</div>
5 changes: 5 additions & 0 deletions _layouts/sideMenu.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
layout: default
---
{% include JB/setup %}
{% include themes/zeppelin/sideMenu.html %}
23 changes: 23 additions & 0 deletions _plugins/markdown_tag.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
=begin
Jekyll tag to include Markdown text from _includes directory preprocessing with Liquid.
Usage:
{% markdown <filename> %}
Dependency:
- kramdown
=end
module Jekyll
class MarkdownTag < Liquid::Tag
def initialize(tag_name, text, tokens)
super
@text = text.strip
end
require "kramdown"
def render(context)
tmpl = File.read File.join Dir.pwd, "_includes", @text
site = context.registers[:site]
tmpl = (Liquid::Template.parse tmpl).render site.site_payload
html = Kramdown::Document.new(tmpl).to_html
end
end
end
Liquid::Template.register_tag('markdown', Jekyll::MarkdownTag)
114 changes: 74 additions & 40 deletions assets/themes/zeppelin/css/style.css
Original file line number Diff line number Diff line change
Expand Up @@ -142,19 +142,6 @@ body {
background: #3071a9;
}

@media (max-width: 768px) {
.navbar-collapse.in {
box-shadow: 0 2px 5px 0 rgba(0, 0, 0, 0.4);
}

.bigFingerButton {
margin-top: 12px;
display: block;
margin-right: auto;
margin-left: auto;
}
}

.bigFingerButton {
margin-right: 10px;
}
Expand All @@ -173,6 +160,31 @@ body {
outline-width: 0;
}

/* SideMenu */

.sideMenu li {
list-style: none;
border: 1px solid #c2c2c2;
border-bottom: none;
padding: 5px 10px;
}

.sideMenu li a {
text-decoration: none;
color: #3071a9;
}

.sideMenu li:first-of-type {
border-top-left-radius: 3px;
border-top-right-radius: 3px;
}

.sideMenu li:last-of-type {
border-bottom: 1px solid #c2c2c2;
border-bottom-left-radius: 3px;
border-bottom-right-radius: 3px;
}

/* CUSTOMIZE THE CAROUSEL
-------------------------------------------------- */

Expand Down Expand Up @@ -208,15 +220,6 @@ body {
margin-bottom: 0;
}

@media screen and (min-width: 768px) {
.carousel-indicators {
margin-bottom: -60px;
}
.carousel-caption {
padding-bottom: 60px;
}
}

/* screenshot img inside of doc */
.screenshot {
width: 800px;
Expand All @@ -235,29 +238,14 @@ body {
/* Custom container */
.content {
word-wrap: break-word;
max-width: 1024px;
padding: 2rem 2rem;
margin: 0 auto;
}
.content :first-child {
margin-top: 0;
}

@media screen and (min-width: 64em) {
.content {
max-width: 64em;
padding: 2rem 6rem;
margin: 0 auto;
}
}
@media screen and (min-width: 42em) and (max-width: 64em) {
.content {
padding: 2rem 4rem;
}
}
@media screen and (max-width: 42em) {
.content {
padding: 2rem 1rem;
}
}

/* <a> */
.content a {
color: #4183C4;
Expand Down Expand Up @@ -588,3 +576,49 @@ and (max-width: 1024px) {
padding: 3px 10px 10px 10px;
font-size: 13px;
}

/*
** Media Queries CSS
*/



@media (max-width: 991px) {
.navbar-inverse .navbar-brand {
font-size: 28px;
}

.content {
padding: 2rem 4rem;
}
}

@media (max-width: 768px) {
.navbar-collapse.in {
box-shadow: 0 2px 5px 0 rgba(0, 0, 0, 0.4);
}

.bigFingerButton {
margin-top: 12px;
display: block;
margin-right: auto;
margin-left: auto;
}

.sideMenu {
margin-bottom: 15px;
}

.content {
padding: 2rem 2rem;
}
}

@media screen and (min-width: 768px) {
.carousel-indicators {
margin-bottom: -60px;
}
.carousel-caption {
padding-bottom: 60px;
}
}
20 changes: 8 additions & 12 deletions community.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,15 +19,11 @@ limitations under the License.
-->
{% include JB/setup %}


### Mailing list

Get help using Apache Zeppelin or contribute to the project on our mailing lists:

* [users@zeppelin.apache.org](http://mail-archives.apache.org/mod_mbox/zeppelin-users/) is for usage questions, help, and announcements. [subscribe](mailto:users-subscribe@zeppelin.apache.org?subject=send this email to subscribe), [unsubscribe](mailto:users-unsubscribe@zeppelin.apache.org?subject=send this email to unsubscribe), [archives](http://mail-archives.apache.org/mod_mbox/zeppelin-users/)
* [dev@zeppelin.apache.org](http://mail-archives.apache.org/mod_mbox/zeppelin-dev/) is for people who want to contribute code to Zeppelin. [subscribe](mailto:dev-subscribe@zeppelin.apache.org?subject=send this email to subscribe), [unsubscribe](mailto:dev-unsubscribe@zeppelin.apache.org?subject=send this email to unsubscribe), [archives](http://mail-archives.apache.org/mod_mbox/zeppelin-dev/)
* [commits@zeppelin.apache.org](http://mail-archives.apache.org/mod_mbox/zeppelin-commits/) is for commit messages and patches to Zeppelin. [subscribe](mailto:commits-subscribe@zeppelin.apache.org?subject=send this email to subscribe), [unsubscribe](mailto:commits-unsubscribe@zeppelin.apache.org?subject=send this email to unsubscribe), [archives](http://mail-archives.apache.org/mod_mbox/zeppelin-commits/)

### Issue tracker

[https://issues.apache.org/jira/browse/ZEPPELIN](https://issues.apache.org/jira/browse/ZEPPELIN)
<div class="row">
<div class="col-md-6">
{% markdown sub-views/community/contribute.md %}
</div>
<div class="col-md-6">
{% markdown sub-views/community/mailinglist.md %}
</div>
</div>
Loading