Repository: bahir-website Updated Branches: refs/heads/asf-site f8e64ab5f -> 3ed86848c
Publishing from c5cd2f4fb626dbac23f16d5cd203894f3755062e Project: http://git-wip-us.apache.org/repos/asf/bahir-website/repo Commit: http://git-wip-us.apache.org/repos/asf/bahir-website/commit/3ed86848 Tree: http://git-wip-us.apache.org/repos/asf/bahir-website/tree/3ed86848 Diff: http://git-wip-us.apache.org/repos/asf/bahir-website/diff/3ed86848 Branch: refs/heads/asf-site Commit: 3ed86848cb0d3b30ff5379f96b0df25db08f96f1 Parents: f8e64ab Author: Luciano Resende <[email protected]> Authored: Tue May 31 16:28:56 2016 -0700 Committer: Luciano Resende <[email protected]> Committed: Tue May 31 16:28:56 2016 -0700 ---------------------------------------------------------------------- content/community-members/index.html | 5 +- content/community/index.html | 5 +- content/contributing-extensions/index.html | 222 ++++++++++++++++++++++++ content/contributing/index.html | 5 +- content/download/index.html | 5 +- content/feed.xml | 4 +- content/history/index.html | 5 +- content/index.html | 5 +- 8 files changed, 248 insertions(+), 8 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/bahir-website/blob/3ed86848/content/community-members/index.html ---------------------------------------------------------------------- diff --git a/content/community-members/index.html b/content/community-members/index.html index e5ec962..fa796f9 100644 --- a/content/community-members/index.html +++ b/content/community-members/index.html @@ -65,7 +65,10 @@ <li><a href="/community" target="_self">Get Involved</a></li> - <li><a href="/contributing" target="_self">Contributing to project</a></li> + <li><a href="/contributing" target="_self">Contributing</a></li> + + + <li><a href="/contributing-extensions" target="_self">Contributing Extensions</a></li> <li><a href="https://issues.apache.org/jira/browse/BAHIR"; target="_blank">Issue Tracker</a></li> http://git-wip-us.apache.org/repos/asf/bahir-website/blob/3ed86848/content/community/index.html ---------------------------------------------------------------------- diff --git a/content/community/index.html b/content/community/index.html index 7cd3a3c..b0f69a0 100644 --- a/content/community/index.html +++ b/content/community/index.html @@ -65,7 +65,10 @@ <li><a href="/community" target="_self">Get Involved</a></li> - <li><a href="/contributing" target="_self">Contributing to project</a></li> + <li><a href="/contributing" target="_self">Contributing</a></li> + + + <li><a href="/contributing-extensions" target="_self">Contributing Extensions</a></li> <li><a href="https://issues.apache.org/jira/browse/BAHIR"; target="_blank">Issue Tracker</a></li> http://git-wip-us.apache.org/repos/asf/bahir-website/blob/3ed86848/content/contributing-extensions/index.html ---------------------------------------------------------------------- diff --git a/content/contributing-extensions/index.html b/content/contributing-extensions/index.html new file mode 100644 index 0000000..b6b4fed --- /dev/null +++ b/content/contributing-extensions/index.html @@ -0,0 +1,222 @@ + +<!DOCTYPE html> +<html lang="en"> + <head> + <meta charset="utf-8"> + <title>Contributing a new extension</title> + <meta name="description" content="Contributing a new extension page"> + <meta name="author" content=""> + + <!-- Enable responsive viewport --> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + + <!-- Le HTML5 shim, for IE6-8 support of HTML elements --> + <!--[if lt IE 9]> + <script src="http://html5shim.googlecode.com/svn/trunk/html5.js";></script> + <![endif]--> + + <!-- Le styles --> + <link href="/assets/themes/apache-clean/bootstrap/css/bootstrap.css" rel="stylesheet"> + <link href="/assets/themes/apache-clean/css/style.css?body=1" rel="stylesheet" type="text/css"> + <link href="/assets/themes/apache-clean/css/syntax.css" rel="stylesheet" type="text/css" media="screen" /> + <!-- Le fav and touch icons --> + <!-- Update these with your own images + <link rel="shortcut icon" href="images/favicon.ico"> + <link rel="apple-touch-icon" href="images/apple-touch-icon.png"> + <link rel="apple-touch-icon" sizes="72x72" href="images/apple-touch-icon-72x72.png"> + <link rel="apple-touch-icon" sizes="114x114" href="images/apple-touch-icon-114x114.png"> + --> + + <!-- make tables sortable by adding class tag "sortable" to table elements --> + <script src="http://www.kryogenix.org/code/browser/sorttable/sorttable.js";></script> + + + </head> + + <body> + + + +<!-- Navigation --> +<div id="nav-bar"> + <nav id="nav-container" class="navbar navbar-inverse " role="navigation"> + <div class="container"> + <!-- Brand and toggle get grouped for better mobile display --> + + <div class="navbar-header page-scroll"> + <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#bs-example-navbar-collapse-1"> + <span class="sr-only">Toggle navigation</span> + <span class="icon-bar"></span> + <span class="icon-bar"></span> + <span class="icon-bar"></span> + </button> + <a class="navbar-brand page-scroll" href="/#home">Home</a> + </div> + <!-- Collect the nav links, forms, and other content for toggling --> + <nav class="navbar-collapse collapse" role="navigation"> + <ul class="nav navbar-nav"> + + <li id="community"> + + <a href="#" data-toggle="dropdown" class="dropdown-toggle">Community<b class="caret"></b></a> + <ul class="dropdown-menu dropdown-left"> + + + <li><a href="/community" target="_self">Get Involved</a></li> + + + <li><a href="/contributing" target="_self">Contributing</a></li> + + + <li><a href="/contributing-extensions" target="_self">Contributing Extensions</a></li> + + + <li><a href="https://issues.apache.org/jira/browse/BAHIR"; target="_blank">Issue Tracker</a></li> + + + <li><a href="https://github.com/apache/bahir"; target="_blank">Source Code</a></li> + + + <li><a href="/community-members" target="_self">Project Committers</a></li> + + </ul> + + </li> + + <li id="github"> + + + <a href="https://github.com/apache/bahir"; target="_blank">GitHub</a> + + </li> + + <li id="apache"> + + <a href="#" data-toggle="dropdown" class="dropdown-toggle">Apache<b class="caret"></b></a> + <ul class="dropdown-menu dropdown-left"> + + + <li><a href="http://www.apache.org/foundation/how-it-works.html"; target="_blank">Apache Software Foundation</a></li> + + + <li><a href="http://www.apache.org/licenses/"; target="_blank">Apache License</a></li> + + + <li><a href="http://www.apache.org/foundation/sponsorship"; target="_blank">Sponsorship</a></li> + + + <li><a href="http://www.apache.org/foundation/thanks.html"; target="_blank">Thanks</a></li> + + </ul> + + </li> + + </ul> + </nav><!--/.navbar-collapse --> + <!-- /.navbar-collapse --> + </div> + <!-- /.container --> + </nav> +</div> + + + + + + <div class="container"> + + +<!--<div class="hero-unit Contributing a new extension"> + <h1></h1> +</div> +--> + +<div class="row"> + <div class="col-md-12"> + <!-- + +--> + +<p>Apache Bahir provides extensions to distributed analytic platforms such as Apache Spark. In the context of Apache Spark, extensions can be Streaming connectors, SQL data sources, etc</p> + +<p>This document explains the process for proposing a new extension to Apache Bahir, and how the extension lifecycle are handled in the project.</p> + +<h1 id="proposing-a-new-extension">Proposing a new extension</h1> + +<p>In Apache Bahir we believe that forming a community around these extensions will actually make it better, and extend its life cycle, thus we require that new extensions be discussed on the project mailing list and receive at least 3 +1 from other committers.</p> + +<p>When set of committers provides a +1 vote to a new extension, they become the initial community around the extension, and will become responsible for helping on patch reviews, but especially, they will become the backup for maintaining the extension in case of build issues, reacting to api changes, or any other issues that might break the extension.</p> + +<p>Once a proposed extension gets the necessary votes, the author should follow the regular contribution process, creating a jira if one is not available yet, and provide a pull request.</p> + +<h1 id="what-is-expected-of-a-new-extension">What is expected of a new extension</h1> + +<p>Extensions must provide:</p> + +<ol> + <li><strong>The main extension code</strong>: this is the actually the extension core code</li> + <li><strong>Extensible test coverage</strong>: automated tests is a MUST to serve as examples on how to use the extension, but also to assert that it works and continue to works while it evolves</li> + <li><strong>Documentation</strong>: extensions MUST provide details on how users would integrated the extension in their applications</li> +</ol> + +<p>Extensions might also provide:</p> + +<ol> + <li><strong>Example</strong>: a simple application that can serve as a reference point on how to use the extension in an application. Users must be able to simply build and deploy the sample application into a cluster.</li> +</ol> + +<h1 id="extension-life-cycle">Extension life cycle</h1> + +<p>We understand that software, particularly open source one, evolves quite quickly, and thus we antecipate that some extensions might start to lag behind in its maintenance.</p> + +<p>The steps described below were crafted with the intention to alleviate the side-effects of one extension lagging behind and becoming broke for one reason or another.</p> + +<h2 id="retiring-extensions">Retiring extensions</h2> + +<p>When a particular extension breaks a build, it will be removed from the build (TBD the actual period here) to minimize the impact on the community.</p> + +<p>Extensions that stay out of the build for a period of time (TBD the actual period here) will be retired to an âcontribâ folder, and at that point will not be part of the official releases.</p> + +<h2 id="resurecting-a-retired-extension">Resurecting a retired extension</h2> + +<p>At any point, a community member can request to resurect a retired extension, and at this point, the process is the same as the initial extension proposal, where he would propose the extension to be brought to life again, and would need to receive at least 3 +1 from other committers.</p> + + </div> +</div> + + + + <hr> + + <!-- <p>© 2016 </p>--> + <footer class="site-footer"> + <div class="wrapper"> + <div class="footer-col-wrapper"> + + <div style="text-align:center;"> + + <div> + Copyright © 2016 <a href="http://www.apache.org";>The Apache Software Foundation</a>. + Licensed under the <a href="http://www.apache.org/licenses/LICENSE-2.0";>Apache License, Version + 2.0</a>. + <br> + + Apache and the Apache Feather logo are trademarks of The Apache Software Foundation. + + </div> + </div> + </div> + </div> +</footer> + + </div> + + + <script src="/assets/themes/apache-clean/jquery/jquery-2.1.1.min.js"></script> + + <script src="/assets/themes/apache-clean/bootstrap/js/bootstrap.min.js"></script> + + + </body> +</html> + http://git-wip-us.apache.org/repos/asf/bahir-website/blob/3ed86848/content/contributing/index.html ---------------------------------------------------------------------- diff --git a/content/contributing/index.html b/content/contributing/index.html index 7883f8b..e1d22d1 100644 --- a/content/contributing/index.html +++ b/content/contributing/index.html @@ -65,7 +65,10 @@ <li><a href="/community" target="_self">Get Involved</a></li> - <li><a href="/contributing" target="_self">Contributing to project</a></li> + <li><a href="/contributing" target="_self">Contributing</a></li> + + + <li><a href="/contributing-extensions" target="_self">Contributing Extensions</a></li> <li><a href="https://issues.apache.org/jira/browse/BAHIR"; target="_blank">Issue Tracker</a></li> http://git-wip-us.apache.org/repos/asf/bahir-website/blob/3ed86848/content/download/index.html ---------------------------------------------------------------------- diff --git a/content/download/index.html b/content/download/index.html index ccb81a6..7d9f273 100644 --- a/content/download/index.html +++ b/content/download/index.html @@ -65,7 +65,10 @@ <li><a href="/community" target="_self">Get Involved</a></li> - <li><a href="/contributing" target="_self">Contributing to project</a></li> + <li><a href="/contributing" target="_self">Contributing</a></li> + + + <li><a href="/contributing-extensions" target="_self">Contributing Extensions</a></li> <li><a href="https://issues.apache.org/jira/browse/BAHIR"; target="_blank">Issue Tracker</a></li> http://git-wip-us.apache.org/repos/asf/bahir-website/blob/3ed86848/content/feed.xml ---------------------------------------------------------------------- diff --git a/content/feed.xml b/content/feed.xml index d9ddde8..9a3ab3d 100644 --- a/content/feed.xml +++ b/content/feed.xml @@ -5,8 +5,8 @@ <description></description> <link>/</link> <atom:link href="/feed.xml" rel="self" type="application/rss+xml"/> - <pubDate>Tue, 31 May 2016 00:21:38 -0700</pubDate> - <lastBuildDate>Tue, 31 May 2016 00:21:38 -0700</lastBuildDate> + <pubDate>Tue, 31 May 2016 16:28:55 -0700</pubDate> + <lastBuildDate>Tue, 31 May 2016 16:28:55 -0700</lastBuildDate> <generator>Jekyll v3.0.0</generator> <item> http://git-wip-us.apache.org/repos/asf/bahir-website/blob/3ed86848/content/history/index.html ---------------------------------------------------------------------- diff --git a/content/history/index.html b/content/history/index.html index 4890970..69eca74 100644 --- a/content/history/index.html +++ b/content/history/index.html @@ -65,7 +65,10 @@ <li><a href="/community" target="_self">Get Involved</a></li> - <li><a href="/contributing" target="_self">Contributing to project</a></li> + <li><a href="/contributing" target="_self">Contributing</a></li> + + + <li><a href="/contributing-extensions" target="_self">Contributing Extensions</a></li> <li><a href="https://issues.apache.org/jira/browse/BAHIR"; target="_blank">Issue Tracker</a></li> http://git-wip-us.apache.org/repos/asf/bahir-website/blob/3ed86848/content/index.html ---------------------------------------------------------------------- diff --git a/content/index.html b/content/index.html index 7f357ee..e5052e8 100644 --- a/content/index.html +++ b/content/index.html @@ -75,7 +75,10 @@ <li><a href="/community" target="_self">Get Involved</a></li> - <li><a href="/contributing" target="_self">Contributing to project</a></li> + <li><a href="/contributing" target="_self">Contributing</a></li> + + + <li><a href="/contributing-extensions" target="_self">Contributing Extensions</a></li> <li><a href="https://issues.apache.org/jira/browse/BAHIR"; target="_blank">Issue Tracker</a></li>
