[ZEPPELIN-1346] Add contribution guidelines to the website

### 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
apache · Sep 6, 2016 · 9647ba4 · 9647ba4
1 parent 9c9e6bc
commit 9647ba4
Show file tree

Hide file tree

Showing 12 changed files with 862 additions and 72 deletions.
diff --git a/_includes/JB/pages_list b/_includes/JB/pages_list
@@ -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 %}
 
@@ -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 %}
diff --git a/_includes/sub-views/community/contribute.md b/_includes/sub-views/community/contribute.md
@@ -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.
diff --git a/_includes/sub-views/community/mailinglist.md b/_includes/sub-views/community/mailinglist.md
@@ -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.
diff --git a/_includes/themes/zeppelin/sideMenu.html b/_includes/themes/zeppelin/sideMenu.html
@@ -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>
diff --git a/_layouts/sideMenu.html b/_layouts/sideMenu.html
@@ -0,0 +1,5 @@
+---
+layout: default
+---
+{% include JB/setup %}
+{% include themes/zeppelin/sideMenu.html %}
diff --git a/_plugins/markdown_tag.rb b/_plugins/markdown_tag.rb
@@ -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)
diff --git a/assets/themes/zeppelin/css/style.css b/assets/themes/zeppelin/css/style.css
@@ -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;
 }
@@ -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
 -------------------------------------------------- */
 
@@ -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;
@@ -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;
@@ -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;
+  }
+}
diff --git a/community.md b/community.md
@@ -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>