Repository: bahir-website Updated Branches: refs/heads/asf-site 8352018eb -> 4e42f71b4
Publishing from 14d8a59478e730524db0c49c72fcd6bec3e0620e Project: http://git-wip-us.apache.org/repos/asf/bahir-website/repo Commit: http://git-wip-us.apache.org/repos/asf/bahir-website/commit/4e42f71b Tree: http://git-wip-us.apache.org/repos/asf/bahir-website/tree/4e42f71b Diff: http://git-wip-us.apache.org/repos/asf/bahir-website/diff/4e42f71b Branch: refs/heads/asf-site Commit: 4e42f71b46a2b297778f04d19a1a74d59f6e198f Parents: 8352018 Author: Luciano Resende <[email protected]> Authored: Mon Aug 1 20:35:44 2016 +0300 Committer: Luciano Resende <[email protected]> Committed: Mon Aug 1 20:35:44 2016 +0300 ---------------------------------------------------------------------- content/community/index.html | 4 +--- content/contributing-extensions/index.html | 12 +++++++----- content/contributing/index.html | 18 ++++++++++-------- content/feed.xml | 4 ++-- 4 files changed, 20 insertions(+), 18 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/bahir-website/blob/4e42f71b/content/community/index.html ---------------------------------------------------------------------- diff --git a/content/community/index.html b/content/community/index.html index f94e68f..037d11c 100644 --- a/content/community/index.html +++ b/content/community/index.html @@ -137,9 +137,7 @@ --> -<p><br /><br /><br /></p> - -<h2 id="apache-bahir-community">Apache Bahir Community</h2> +<h1 id="apache-bahir-community">Apache Bahir Community</h1> <p>Every volunteer project obtains its strength from the people involved in it. We invite you to participate as much or as little as you choose.</p> http://git-wip-us.apache.org/repos/asf/bahir-website/blob/4e42f71b/content/contributing-extensions/index.html ---------------------------------------------------------------------- diff --git a/content/contributing-extensions/index.html b/content/contributing-extensions/index.html index 280ab72..09fdb84 100644 --- a/content/contributing-extensions/index.html +++ b/content/contributing-extensions/index.html @@ -137,11 +137,13 @@ --> +<h1 id="contributing-new-extensions-to-apache-bahir">Contributing new Extensions to Apache Bahir</h1> + <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> +<h2 id="proposing-a-new-extension">Proposing a new extension</h2> <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> @@ -149,7 +151,7 @@ <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> +<h2 id="what-is-expected-of-a-new-extension">What is expected of a new extension</h2> <p>Extensions must provide:</p> @@ -165,19 +167,19 @@ <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> +<h2 id="extension-life-cycle">Extension life cycle</h2> <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> +<h3 id="retiring-extensions">Retiring extensions</h3> <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> +<h3 id="resurecting-a-retired-extension">Resurecting a retired extension</h3> <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> http://git-wip-us.apache.org/repos/asf/bahir-website/blob/4e42f71b/content/contributing/index.html ---------------------------------------------------------------------- diff --git a/content/contributing/index.html b/content/contributing/index.html index 45acdb6..504dc57 100644 --- a/content/contributing/index.html +++ b/content/contributing/index.html @@ -137,17 +137,19 @@ --> +<h1 id="contributing-to-apache-bahir-community">Contributing to Apache Bahir Community</h1> + <p>This guide documents the best way to make various types of contribution to Apache Bahir, including what is required before submitting a code change and how to properly merge them.</p> <p>Contributing to Bahir doesnât just mean writing code. Helping testing and reviewing pull requests and improving documentation are also welcome. In fact, proposing significant code changes usually requires first gaining experience and credibility within the community by helping in other ways. This is also a guide to becoming an effective contributor.</p> -<h1 id="contributing-by-helping-other-users">Contributing by Helping Other Users</h1> +<h2 id="contributing-by-helping-other-users">Contributing by Helping Other Users</h2> <p>A great way to contribute to Bahir is to help answer user questions on the <a href="https://www.mail-archive.com/[email protected]/";>[email protected]</a> mailing list. There are always many new users; taking a few minutes to help answer a question is a very valuable community service.</p> <p>Contributors should subscribe to this list and follow it in order to keep up to date on whatâs happening in Bahir. Answering questions is an excellent and visible way to help the community, which also demonstrates your expertise.</p> -<h1 id="contributing-by-testing-releases">Contributing by Testing Releases</h1> +<h2 id="contributing-by-testing-releases">Contributing by Testing Releases</h2> <p>Bahirâs release process is community-oriented, and members of the community can vote on new releases on the <a href="https://www.mail-archive.com/[email protected]/";>[email protected]</a> mailing list. Bahir users are invited to subscribe to this list to receive announcements of release vote, and test Bahir extensions on newer release and provide feedback on any performance or correctness issues found in the newer release.</p> @@ -155,7 +157,7 @@ --> -<h1 id="contributing-code-changes">Contributing code changes</h1> +<h2 id="contributing-code-changes">Contributing code changes</h2> <p>Please review the preceding section before proposing a code change. This section documents how to do so:</p> @@ -169,7 +171,7 @@ <li><a href="#Merging+Pull+Requests">Merging Pull Requests</a></li> </ol> -<h2 id="jira">JIRA</h2> +<h3 id="jira">JIRA</h3> <p>Bahir uses JIRA to track issues, including bugs and improvements, and uses Github pull requests to manage the review and merge of specific code changes. That is, JIRAs are used to describe what should be fixed or changed, and high-level approaches, and pull requests describe how to implement that change in the projectâs source code. For example, major design decisions are discussed in JIRA.</p> @@ -207,7 +209,7 @@ <li>If the change is a large change, consider inviting discussion on the issue at [email protected] first before proceeding to implement the change.</li> </ol> -<h2 id="before-creating-a-pull-request">Before creating a Pull Request</h2> +<h3 id="before-creating-a-pull-request">Before creating a Pull Request</h3> <p>Fork the Github repository at https://github.com/apache/bahir and clone your fork if you havenât already</p> @@ -250,7 +252,7 @@ Could not apply fa39187f3c3dfd2ab5faa38ac01cf3de7ce2e841... Change fake file <p>To fix the conflict, you can follow <a href="https://help.github.com/articles/resolving-a-merge-conflict-from-the-command-line";>the standard procedures for resolving merge conflicts from the command line</a>. When youâre finished, youâll need to call <strong>git rebase âcontinue</strong> in order for Git to continue processing the rest of the rebase.</p> -<h2 id="creating-a-pull-request">Creating a Pull Request</h2> +<h3 id="creating-a-pull-request">Creating a Pull Request</h3> <ol> <li>Create a new branch, push commits to the branch.</li> @@ -282,7 +284,7 @@ Generate Matrix with random values through local memory if there is sufficient memory. </code></pre> -<h2 id="code-review-criteria">Code Review Criteria</h2> +<h3 id="code-review-criteria">Code Review Criteria</h3> <p>Before considering how to contribute code, itâs useful to understand how code is reviewed, and why changes may be rejected. Simply put, changes that have many or large positives, and few negative effects or risks, are much more likely to be merged, and merged quickly. Risky and less valuable changes are very unlikely to be merged, and may be rejected outright rather than receive iterations of review.</p> <p><strong>Positives</strong></p> @@ -309,7 +311,7 @@ if there is sufficient memory. <li>Makes lots of modifications in one âbig bangâ change</li> </ul> -<h2 id="the-review-process">The Review Process</h2> +<h3 id="the-review-process">The Review Process</h3> <ul> <li>Other reviewers, including committers, may comment on the changes and suggest modifications. Changes can be added by simply pushing more commits to the same branch.</li> http://git-wip-us.apache.org/repos/asf/bahir-website/blob/4e42f71b/content/feed.xml ---------------------------------------------------------------------- diff --git a/content/feed.xml b/content/feed.xml index 5ddea88..a8849e4 100644 --- a/content/feed.xml +++ b/content/feed.xml @@ -6,8 +6,8 @@ </description> <link>http://bahir.apache.org/</link> <atom:link href="http://bahir.apache.org/feed.xml"; rel="self" type="application/rss+xml"/> - <pubDate>Mon, 01 Aug 2016 20:20:21 +0300</pubDate> - <lastBuildDate>Mon, 01 Aug 2016 20:20:21 +0300</lastBuildDate> + <pubDate>Mon, 01 Aug 2016 20:35:42 +0300</pubDate> + <lastBuildDate>Mon, 01 Aug 2016 20:35:42 +0300</lastBuildDate> <generator>Jekyll v3.0.0</generator> <item>
