from 6e91e0f703d66075e3533fa19431f62ec68082c2
Project: http://git-wip-us.apache.org/repos/asf/incubator-apex-site/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-apex-site/commit/04ffbb71 Tree: http://git-wip-us.apache.org/repos/asf/incubator-apex-site/tree/04ffbb71 Diff: http://git-wip-us.apache.org/repos/asf/incubator-apex-site/diff/04ffbb71 Branch: refs/heads/asf-site Commit: 04ffbb71b094a3caf263d00ec9fd178cff7e600f Parents: bb0eb98 Author: Thomas Weise <[email protected]> Authored: Tue May 24 10:18:30 2016 -0700 Committer: Thomas Weise <[email protected]> Committed: Tue May 24 10:18:30 2016 -0700 ---------------------------------------------------------------------- content/content/announcements.html | 141 + content/content/community.html | 139 + content/content/contributing.html | 203 + content/content/css/main.css | 7074 ++++++++++++++++++ content/content/docs.html | 146 + content/content/downloads.html | 300 + .../fonts/glyphicons-halflings-regular.eot | Bin 0 -> 20127 bytes .../fonts/glyphicons-halflings-regular.svg | 288 + .../fonts/glyphicons-halflings-regular.ttf | Bin 0 -> 45404 bytes .../fonts/glyphicons-halflings-regular.woff | Bin 0 -> 23424 bytes .../fonts/glyphicons-halflings-regular.woff2 | Bin 0 -> 18028 bytes .../content/github-mirror-pull-requests.html | 9 + content/content/images/apex-logo.svg | 23 + content/content/images/asf_logo.svg | 210 + content/content/images/egg-logo2-noborder.png | Bin 0 -> 7911 bytes content/content/index.html | 131 + content/content/js/bootstrap.min.js | 7 + content/content/maturity.html | 180 + content/content/people.html | 331 + content/content/release.html | 228 + content/content/roadmap.html | 497 ++ content/content/verification.html | 176 + content/downloads.html | 20 +- 23 files changed, 10093 insertions(+), 10 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-apex-site/blob/04ffbb71/content/content/announcements.html ---------------------------------------------------------------------- diff --git a/content/content/announcements.html b/content/content/announcements.html new file mode 100644 index 0000000..a56488d --- /dev/null +++ b/content/content/announcements.html @@ -0,0 +1,141 @@ +<html lang="en"><head> + + <meta charset="utf-8"> + <meta http-equiv="X-UA-Compatible" content="IE=edge"> + <meta name="viewport" content="width=device-width, initial-scale=1"> + <!-- The above 3 meta tags *must* come first in the head; any other head content must come *after* these tags --> + <meta name="description" content="Apex is an enterprise grade native YARN big data-in-motion platform that unifies stream processing as well as batch processing."> + <meta name="author" content="Apache Software Foundation"> + <link rel="icon" href="favicon.ico"> + + <title>Apache Apex</title> + + <!-- Main Stylesheet --> + <link href="css/main.css" rel="stylesheet"> + + </head> + + <body> + <nav class="navbar navbar-default navbar-static-top" id="main-nav"> + <div class="container"> + + <div class="navbar-header"> + <button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#bs-example-navbar-collapse-1" aria-expanded="false"> + <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" href="/"> + <img src="images/apex-logo.svg" class="logo" alt="Apache Apex Logo"> + Apache Apex<span class="trademark">™</span> + </a> + </div> + + <div class="collapse navbar-collapse" id="bs-example-navbar-collapse-1"> + <ul class="nav navbar-right navbar-nav"> + <li class="nav-item"> + <a class="nav-link " href="/">Home</a> + </li> + <li class="nav-item"> + <a class="nav-link " href="/announcements.html">Announcements</a> + </li> + <li class="nav-item"> + <a class="nav-link " href="/community.html">Community</a> + </li> + <li class="nav-item"> + <a class="nav-link " href="/docs.html">Docs</a> + </li> + <li class="nav-item"> + <a href="#" data-toggle="dropdown" class="dropdown-toggle nav-link">Source<b class="caret"></b></a> + <ul class="dropdown-menu"> + <li><a href="https://git-wip-us.apache.org/repos/asf?p=incubator-apex-core.git";>Apex Core (ASF)</a></li> + <li><a href="https://github.com/apache/incubator-apex-core";>Apex Core (Github Mirror)</a></li> + <li><a href="https://git-wip-us.apache.org/repos/asf?p=incubator-apex-malhar.git";>Apex Malhar (ASF)</a></li> + <li><a href="https://github.com/apache/incubator-apex-malhar";>Apex Malhar (Github Mirror)</a></li> + </ul> + </li> + <li class="nav-item"> + <a href="#" data-toggle="dropdown" class="dropdown-toggle nav-link">Apache<b class="caret"></b></a> + <ul class="dropdown-menu"> + <li><a href="http://incubator.apache.org/projects/apex.html";>Status Page</a></li> + <li><a href="http://www.apache.org/foundation/how-it-works.html";>Apache Foundation</a></li> + <li><a href="http://www.apache.org/licenses/";>Apache License</a></li> + <li><a href="http://www.apache.org/foundation/sponsorship.html";>Sponsorship</a></li> + <li><a href="http://www.apache.org/foundation/thanks.html";>Thanks</a></li> + </ul> + </li> + <li class="nav-item"> + <a class="nav-link btn btn-success" href="/downloads.html">Download</a> + </li> + </ul> + + </div> + </nav> + +<div class="container"> + <div class="col-md-8"> + + <h1 id="announcements">Announcements</h1> +<h2 id="apache-apex-announced-as-top-level-project">Apache Apex announced as Top-Level Project</h2> +<p>Apr 25, 2016. The Apache Software Foundation (ASF) announced today that Apache Apex has graduated from the Apache Incubator to become a Top-Level Project (TLP), signifying that the project's community and products have been well-governed under the ASF's meritocratic process and principles. </p> +<p><a href="https://blogs.apache.org/foundation/entry/the_apache_software_foundation_announces90";>https://blogs.apache.org/foundation/entry/the_apache_software_foundation_announces90</a></p> +<h2 id="apex-core-release-3-2-1-incubating">Apex Core release 3.2.1-incubating</h2> +<p>Apr 21, 2016. The Apache Apex community is pleased to announce release <a href="/downloads.html">3.2.1-incubating</a> of the Core.</p> +<p>Changes: <a href="https://github.com/apache/incubator-apex-core/blob/v3.2.1-incubating/CHANGELOG.md";>https://github.com/apache/incubator-apex-core/blob/v3.2.1-incubating/CHANGELOG.md</a></p> +<h2 id="malhar-library-release-3-3-1-incubating">Malhar Library release 3.3.1-incubating</h2> +<p>Mar 2, 2016. The Apache Apex community is pleased to announce release <a href="/downloads.html">3.3.1-incubating</a> of the Malhar Library.</p> +<p>Changes: <a href="https://github.com/apache/incubator-apex-malhar/blob/v3.3.1-incubating/CHANGELOG.md";>https://github.com/apache/incubator-apex-malhar/blob/v3.3.1-incubating/CHANGELOG.md</a></p> +<h2 id="apex-core-release-3-3-0-incubating">Apex Core release 3.3.0-incubating</h2> +<p>Feb 8, 2016. The Apache Apex community is pleased to announce release <a href="/downloads.html">3.3.0-incubating</a> of the Core.</p> +<p>Changes: <a href="https://github.com/apache/incubator-apex-core/blob/v3.3.0-incubating/CHANGELOG.md";>https://github.com/apache/incubator-apex-core/blob/v3.3.0-incubating/CHANGELOG.md</a></p> +<h2 id="users-mailing-list-created">Users Mailing List Created</h2> +<p>Dec 17, 2015. The Apache Apex community is pleased to announce a new mailing list <a href="http://mail-archives.apache.org/mod_mbox/incubator-apex-users/";>[email protected]</a> for people who want to build apps and/or solutions using Apex. <a href="mailto:[email protected]?subject=send%20this%20email%20to%20subscribe";>Subscribe</a> by mailing <a href="mailto:[email protected]?subject=send%20this%20email%20to%20subscribe";>[email protected]</a>.</p> + + </div> + <div class="col-md-4"> + + <h2 id="upcoming-meetups">Upcoming Meetups</h2> +<p><div id="1458176353510"></div></p> +<script src="//ajax.googleapis.com/ajax/libs/jquery/1.7.1/jquery.min.js"></script> +<script>jQuery.noConflict();</script> +<script> + jQuery(function() { + var scripts = ["var%20%24parameters%20%3D%20%7B%22topic%22%3A%22apache-apex%22%2C%22width%22%3A%22250%22%2C%22height%22%3A%221000%22%7D%3B%0Avar%20%24queries%20%3D%20%7B%20events%3A%20function%28%29%20%7B%20return%20%22https%3A//api.meetup.com/2/open_events%3Fand_text%3DFalse%26offset%3D0%26format%3Djson%26limited_events%3DFalse%26sig%3D3b7decaeff772cd10cb65730b81a845f8533cc8b%26topic%3Dapache-apex%26callback%3D%3F%26page%3D1000%26radius%3D25.0%26sig_id%3D87819142%26desc%3DFalse%26status%3Dupcoming%26_%3D1458176351397%26user_agent%3Dmeetup.widget%3Amug_stats%22%3B%20%7D%20%7D%3B%0A","%0Amup_widget.with_jquery%28function%28%24%2Cctx%29%7Bvar%20group%3D%27%27%2Cmonths%3D%5B%27Jan%27%2C%27Feb%27%2C%27Mar%27%2C%27Apr%27%2C%27May%27%2C%27Jun%27%2C%27Jul%27%2C%27Aug%27%2C%27Sep%27%2C%27Oct%27%2C%27Nov%27%2C%27Dec%27%5D%2CaddLink%3Dfunction%28content%2Clink%29%7Breturn%27%3Ca%20target%3D%22_blank%22%20href%3D%22%27+link+%27%22%3E%27+content+%27%3C/a%3E%27%3B%7D%2CaddLeadingZero%3Dfunct ion%28num%29%7Breturn%28num%3C10%29%3F%28%270%27+num%29%3Anum%3B%7D%2CgetFormattedDate%3Dfunction%28millis%29%7Bvar%20date%3Dnew%20Date%28millis%29%3Breturn%20months%5Bdate.getMonth%28%29%5D+%27%20%27+addLeadingZero%28date.getDate%28%29%29+%27%2C%20%27+date.getFullYear%28%29.toString%28%29%3B%7D%3B%24.getJSON%28%24queries.events%28%29%2Cfunction%28data%29%7Bif%28data.status%26%26data.status.match%28/%5E200/%29%3D%3Dnull%29%7Bconsole.log%28%22Error%20loading%20Meetups%20events%3A%20%22%2Cdata.status+%22%3A%20%22+data.details%29%3B%7Delse%7Bif%28data.results.length%3E0%29%7Bvar%20venueNameSortOrder%3D%5B%27Live%20Webcast%27%2C%27Webinar%27%2C%27Webcast%27%5D%3Bdata.results.sort%28function%28a%2Cb%29%7Bif%28a.time%3Eb.time%29%7Breturn%201%3B%7Dif%28a.time%3Cb.time%29%7Breturn-1%3B%7Dif%28a.time%3D%3D%3Db.time%29%7Bif%28a.venue%26%26a.venue.name%26%26b.venue%26%26b.venue.name%29%7Breturn%20venueNameSortOrder.indexOf%28a.venue.name%29-venueNameSortOrder.indexOf%28b.venue.name%29%3B%7Dret urn%200%3B%7Dreturn%200%3B%7D%29%3Bvar%20uniqueEventsByKey%3D%7B%7D%3Bfor%28var%20i%3D0%3Bi%3Cdata.results.length%3Bi++%29%7Bvar%20event%3Ddata.results%5Bi%5D%3Bconsole.log%28event%29%3Bvar%20venue%3Devent.venue%3Bvar%20city%3D%28venue%26%26venue.city%29%3Fvenue.city%3A%27TBD%27%3Bvar%20state_country%3D%28venue%29%3Fvenue.state%7C%7Cvenue.country%3A%27%27%3Bvar%20location%3D%28state_country%29%3Fcity+%22%2C%20%22+state_country.toUpperCase%28%29%3Acity%3Bevent.location%3Dlocation%3Bvar%20eventKey%3Devent.time%3Fevent.time%3Aevent.name%3Bif%28uniqueEventsByKey%5BeventKey%5D%29%7Bconsole.log%28%22DUPLICATE%20EVENT%20%28skipped%29%3A%20%22%2Cevent.event_url%2C%22%20matches%20previous%20event%20%22%2CuniqueEventsByKey%5BeventKey%5D.event_url%2C%22%20with%20date%3A%22%2CgetFormattedDate%28event.time%29%2C%22%20and%20name%20%22%2Cevent.name%29%3B%7Delse%7BuniqueEventsByKey%5BeventKey%5D%3Devent%3B%24%28%27.next-events%27%2Cctx%29.append%28%27%3Cp%3E%27+addLink%28getFormattedDate%28event.ti me%29+%22%20-%20%22+event.location%2Cevent.event_url%29+%22%20-%20%22+event.name+%22%3C/p%3E%22%29%3B%7D%7D%7D%7D%7D%29%3B%7D%29%3B"]; + jQuery("#1458176353510").append(unescape("%3Clink%20rel%3D%22stylesheet%22%20type%3D%22text/css%22%20href%3D%22https%3A//a248.e.akamai.net/secure.meetupstatic.com/style/widget.css%22/%3E%0A%0A%3C/head%3E%3Cdiv%20class%3D%22next-events%22%3E%3C/div%3E")); + var mup_widget = { + with_jquery: function(block) { + block(jQuery, document.getElementById("1458176353510")); + } + }; + for (i in scripts) { eval(unescape(scripts[i])) } + }); +</script> + +<p><a href="http://www.meetup.com/Hadoop-User-Group-Munich/events/230313355/";>July 19, 2016 - München, Germany</a> - Apache Apex: Stream Processing Architecture and Applications</p> +<p><a href="http://apache-apex.meetup.com/";>Propose future meetups in one of the Apache Apex groups!</a></p> + + </div> +</div> + + <hr> + <div class="container"> + <footer id="main-footer"> + <p> + Copyright © <span id="copyright-year">2015</span> <a href="http://apache.org";>The Apache Software Foundation</a>, + Licensed under the Apache License, Version 2.0<br> + Apache and the Apache feather logo are trademarks of The Apache Software Foundation.<br> + <a class="footer-link-img" href="http://apache.org";><img src="/images/asf_logo.svg" alt="The Apache Software Foundation"></a> + </p> + </footer> + </div> <!-- /container --> + + <!-- Placed at the end of the document so the pages load faster --> + <script src="https://ajax.googleapis.com/ajax/libs/jquery/1.11.3/jquery.min.js";></script> + <script src="/js/bootstrap.min.js"></script> + <script> + $('#copyright-year').text((new Date()).getFullYear()); + </script> + +</body> +</html> http://git-wip-us.apache.org/repos/asf/incubator-apex-site/blob/04ffbb71/content/content/community.html ---------------------------------------------------------------------- diff --git a/content/content/community.html b/content/content/community.html new file mode 100644 index 0000000..4aa4935 --- /dev/null +++ b/content/content/community.html @@ -0,0 +1,139 @@ +<html lang="en"><head> + + <meta charset="utf-8"> + <meta http-equiv="X-UA-Compatible" content="IE=edge"> + <meta name="viewport" content="width=device-width, initial-scale=1"> + <!-- The above 3 meta tags *must* come first in the head; any other head content must come *after* these tags --> + <meta name="description" content="Apex is an enterprise grade native YARN big data-in-motion platform that unifies stream processing as well as batch processing."> + <meta name="author" content="Apache Software Foundation"> + <link rel="icon" href="favicon.ico"> + + <title>Apache Apex</title> + + <!-- Main Stylesheet --> + <link href="css/main.css" rel="stylesheet"> + + </head> + + <body> + <nav class="navbar navbar-default navbar-static-top" id="main-nav"> + <div class="container"> + + <div class="navbar-header"> + <button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#bs-example-navbar-collapse-1" aria-expanded="false"> + <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" href="/"> + <img src="images/apex-logo.svg" class="logo" alt="Apache Apex Logo"> + Apache Apex<span class="trademark">™</span> + </a> + </div> + + <div class="collapse navbar-collapse" id="bs-example-navbar-collapse-1"> + <ul class="nav navbar-right navbar-nav"> + <li class="nav-item"> + <a class="nav-link " href="/">Home</a> + </li> + <li class="nav-item"> + <a class="nav-link " href="/announcements.html">Announcements</a> + </li> + <li class="nav-item"> + <a class="nav-link " href="/community.html">Community</a> + </li> + <li class="nav-item"> + <a class="nav-link " href="/docs.html">Docs</a> + </li> + <li class="nav-item"> + <a href="#" data-toggle="dropdown" class="dropdown-toggle nav-link">Source<b class="caret"></b></a> + <ul class="dropdown-menu"> + <li><a href="https://git-wip-us.apache.org/repos/asf?p=incubator-apex-core.git";>Apex Core (ASF)</a></li> + <li><a href="https://github.com/apache/incubator-apex-core";>Apex Core (Github Mirror)</a></li> + <li><a href="https://git-wip-us.apache.org/repos/asf?p=incubator-apex-malhar.git";>Apex Malhar (ASF)</a></li> + <li><a href="https://github.com/apache/incubator-apex-malhar";>Apex Malhar (Github Mirror)</a></li> + </ul> + </li> + <li class="nav-item"> + <a href="#" data-toggle="dropdown" class="dropdown-toggle nav-link">Apache<b class="caret"></b></a> + <ul class="dropdown-menu"> + <li><a href="http://incubator.apache.org/projects/apex.html";>Status Page</a></li> + <li><a href="http://www.apache.org/foundation/how-it-works.html";>Apache Foundation</a></li> + <li><a href="http://www.apache.org/licenses/";>Apache License</a></li> + <li><a href="http://www.apache.org/foundation/sponsorship.html";>Sponsorship</a></li> + <li><a href="http://www.apache.org/foundation/thanks.html";>Thanks</a></li> + </ul> + </li> + <li class="nav-item"> + <a class="nav-link btn btn-success" href="/downloads.html">Download</a> + </li> + </ul> + + </div> + </nav> + +<div class="container"> + + <h1 id="community">Community</h1> +<h2 id="mailing-lists">Mailing Lists</h2> +<p>The following mailing lists are available for Apex.</p> +<ul> +<li><a href="http://mail-archives.apache.org/mod_mbox/apex-users/";>[email protected]</a> is a discussion forum for people who want to build applications and/or solutions using Apex. <a href="mailto:[email protected]?subject=send%20this%20email%20to%20subscribe";>subscribe</a>, <a href="mailto:[email protected]?subject=send%20this%20email%20to%20unsubscribe";>unsubscribe</a>, <a href="https://lists.apache.org/[email protected]";>ponymail</a>, <a href="https://s.apache.org/apex-users";>nabble</a>, <a href="http://mail-archives.apache.org/mod_mbox/apex-users/";>archives</a></li> +<li><a href="http://mail-archives.apache.org/mod_mbox/apex-dev/";>[email protected]</a> is for people who want to contribute code to Apex. Traffic on the list is generally high and includes JIRA notifications and code review comment. <a href="mailto:[email protected]?subject=send%20this%20email%20to%20subscribe";>subscribe</a>, <a href="mailto:[email protected]?subject=send%20this%20email%20to%20unsubscribe";>unsubscribe</a>, <a href="https://lists.apache.org/[email protected]";>ponymail</a>, <a href="https://s.apache.org/apex-dev";>nabble</a>, <a href="http://mail-archives.apache.org/mod_mbox/apex-dev/";>archives</a></li> +<li><a href="http://mail-archives.apache.org/mod_mbox/apex-commits/";>[email protected]</a> is for commit messages and patches to Apex. <a href="mailto:[email protected]?subject=send%20this%20email%20to%20subscribe";>subscribe</a>, <a href="mailto:[email protected]?subject=send%20this%20email%20to%20unsubscribe";>unsubscribe</a>, <a href="https://lists.apache.org/[email protected]";>ponymail</a>, <a href="https://s.apache.org/apex-commits";>nabble</a>, <a href="http://mail-archives.apache.org/mod_mbox/apex-commits/";>archives</a></li> +<li><a href="mailto:[email protected]";>[email protected]</a> is for reporting security related issues with Apex. It is a private list to discuss security related issues. Please post potential security vulnerabilities to this list so that they can be investigated and fixed before the vulnerabilities are published to the public. You can post to the list without subscribing to it.</li> +</ul> +<h2 id="people">People</h2> +<p><a href="/people.html">List of committers</a></p> +<h2 id="contributing">Contributing</h2> +<p><strong>To learn more about how we use Github to accept contributions to the project, <a href="/contributing.html">check out the contributing guidelines</a>.</strong></p> +<p>The Apex Project is made up of two repositories:</p> +<ul> +<li><a href="https://github.com/apache/incubator-apex-core";>Apex Core</a> - The core of the Apex platform.</li> +<li><a href="https://github.com/apache/incubator-apex-malhar";>Apex Malhar</a> - Community-driven set of open-source "operators" and utilities for use in your Apex applications.</li> +</ul> +<h2 id="release-process">Release Process</h2> +<p>To learn more about the release process for Apex, <a href="/release.html">check out the release guidelines</a>.</p> +<p>To learn more about the release candidate verification for Apex, <a href="/verification.html">check out the verification guidelines</a>.</p> +<h2 id="issue-tracking">Issue Tracking</h2> +<ul> +<li><a href="https://issues.apache.org/jira/browse/APEXCORE/";>Apex Core JIRA</a></li> +<li><a href="https://issues.apache.org/jira/browse/APEXMALHAR/";>Apex Malhar JIRA</a></li> +</ul> +<h2 id="security-process">Security Process</h2> +<p>To report security vulnerabilities send an email to <a href="mailto:[email protected]";>[email protected]</a>.</p> +<p>The process for handling security vulnerabilities is the one recommended by Apache, it is described <a href="http://www.apache.org/security/committers.html";>here</a>.</p> +<h2 id="project-maturity-model">Project Maturity Model</h2> +<p>To see self assessment of the project, <a href="/maturity.html">check out project maturity model</a></p> +<h3 id="roadmap">Roadmap</h3> +<ul> +<li><a href="roadmap.html">Apex Roadmap</a> comprises key features planned for the future releases</li> +</ul> +<h2 id="meetup-groups">Meetup Groups</h2> +<p>Full list of Apache Apex meetup groups is available at <a href="http://apache-apex.meetup.com/";>Apache Apex Meetup Groups</a></p> +<p>To see upcoming meetup events, please visit <a href="/announcements.html">announcements page</a>.</p> + +</div> + + <hr> + <div class="container"> + <footer id="main-footer"> + <p> + Copyright © <span id="copyright-year">2015</span> <a href="http://apache.org";>The Apache Software Foundation</a>, + Licensed under the Apache License, Version 2.0<br> + Apache and the Apache feather logo are trademarks of The Apache Software Foundation.<br> + <a class="footer-link-img" href="http://apache.org";><img src="/images/asf_logo.svg" alt="The Apache Software Foundation"></a> + </p> + </footer> + </div> <!-- /container --> + + <!-- Placed at the end of the document so the pages load faster --> + <script src="https://ajax.googleapis.com/ajax/libs/jquery/1.11.3/jquery.min.js";></script> + <script src="/js/bootstrap.min.js"></script> + <script> + $('#copyright-year').text((new Date()).getFullYear()); + </script> + +</body> +</html> http://git-wip-us.apache.org/repos/asf/incubator-apex-site/blob/04ffbb71/content/content/contributing.html ---------------------------------------------------------------------- diff --git a/content/content/contributing.html b/content/content/contributing.html new file mode 100644 index 0000000..5fe7a3d --- /dev/null +++ b/content/content/contributing.html @@ -0,0 +1,203 @@ +<html lang="en"><head> + + <meta charset="utf-8"> + <meta http-equiv="X-UA-Compatible" content="IE=edge"> + <meta name="viewport" content="width=device-width, initial-scale=1"> + <!-- The above 3 meta tags *must* come first in the head; any other head content must come *after* these tags --> + <meta name="description" content="Apex is an enterprise grade native YARN big data-in-motion platform that unifies stream processing as well as batch processing."> + <meta name="author" content="Apache Software Foundation"> + <link rel="icon" href="favicon.ico"> + + <title>Apache Apex</title> + + <!-- Main Stylesheet --> + <link href="css/main.css" rel="stylesheet"> + + </head> + + <body> + <nav class="navbar navbar-default navbar-static-top" id="main-nav"> + <div class="container"> + + <div class="navbar-header"> + <button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#bs-example-navbar-collapse-1" aria-expanded="false"> + <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" href="/"> + <img src="images/apex-logo.svg" class="logo" alt="Apache Apex Logo"> + Apache Apex<span class="trademark">™</span> + </a> + </div> + + <div class="collapse navbar-collapse" id="bs-example-navbar-collapse-1"> + <ul class="nav navbar-right navbar-nav"> + <li class="nav-item"> + <a class="nav-link " href="/">Home</a> + </li> + <li class="nav-item"> + <a class="nav-link " href="/announcements.html">Announcements</a> + </li> + <li class="nav-item"> + <a class="nav-link " href="/community.html">Community</a> + </li> + <li class="nav-item"> + <a class="nav-link " href="/docs.html">Docs</a> + </li> + <li class="nav-item"> + <a href="#" data-toggle="dropdown" class="dropdown-toggle nav-link">Source<b class="caret"></b></a> + <ul class="dropdown-menu"> + <li><a href="https://git-wip-us.apache.org/repos/asf?p=incubator-apex-core.git";>Apex Core (ASF)</a></li> + <li><a href="https://github.com/apache/incubator-apex-core";>Apex Core (Github Mirror)</a></li> + <li><a href="https://git-wip-us.apache.org/repos/asf?p=incubator-apex-malhar.git";>Apex Malhar (ASF)</a></li> + <li><a href="https://github.com/apache/incubator-apex-malhar";>Apex Malhar (Github Mirror)</a></li> + </ul> + </li> + <li class="nav-item"> + <a href="#" data-toggle="dropdown" class="dropdown-toggle nav-link">Apache<b class="caret"></b></a> + <ul class="dropdown-menu"> + <li><a href="http://incubator.apache.org/projects/apex.html";>Status Page</a></li> + <li><a href="http://www.apache.org/foundation/how-it-works.html";>Apache Foundation</a></li> + <li><a href="http://www.apache.org/licenses/";>Apache License</a></li> + <li><a href="http://www.apache.org/foundation/sponsorship.html";>Sponsorship</a></li> + <li><a href="http://www.apache.org/foundation/thanks.html";>Thanks</a></li> + </ul> + </li> + <li class="nav-item"> + <a class="nav-link btn btn-success" href="/downloads.html">Download</a> + </li> + </ul> + + </div> + </nav> + +<div class="container"> + + <h1 id="contributing-guidelines">Contributing Guidelines</h1> +<p>This project welcomes new contributors and invites everyone to participate. Our aim is to build an open community. There are many different ways to get involved:</p> +<ul> +<li>Adding new features, enhancements, tests or fixing bugs</li> +<li>Pull request reviews</li> +<li>Release management and verification</li> +<li>Participation on email list</li> +<li>Web site improvements</li> +<li>Documentation</li> +<li>Organize meetups and other events</li> +<li>Publishing papers and blogs</li> +<li>Present at conferences or spread the word in other ways</li> +</ul> +<p>People that help with the project in any of the above categories or other ways are contributors. See the <a href="http://www.apache.org/foundation/how-it-works.html#roles";>roles</a> as defined by the ASF.</p> +<h2 id="becoming-a-committer">Becoming a committer</h2> +<p>Community members that make sustained, welcome contributions to the project may be invited to become a committer. Committers are voted in by the PPMC. A committer has a signed Contributor License Agreement (<a href="http://www.apache.org/licenses/icla.txt";>CLA</a>) on file and an apache.org address.</p> +<p>We expect committers to subscribe to the <a href="community.html#mailing-lists">project mailing lists</a>. </p> +<p>A committer will be considered âemeritus/inactiveâ by not contributing in any form to the project for over 1 year. An emeritus committer may request reinstatement of commit access from the PPMC. Such reinstatement is subject to lazy consensus of active PPMC members.</p> +<p>The Podling Project Management Committee (<a href="http://incubator.apache.org/guides/ppmc.html";>PPMC</a>) is responsible for the oversight of the project and it also decides who to add as a PPMC member. Existing committers may be invited to become a PPMC member after consistent contribution and activity over a period of time and participation in directional and community building discussions.</p> +<h2 id="code-style">Code Style</h2> +<p>Apache Apex follows coding style that is closest to K & R style and uses <a href="http://checkstyle.sourceforge.net/";>Checkstyle</a> tool to enforce these standards. Travis CI will fail for any pull request that introduces any style violations.</p> +<p>The checkstyle configuration that Apache Apex projects use is present here : <a href="https://github.com/apache/incubator-apex-core/blob/master/apex_checks.xml";>https://github.com/apache/incubator-apex-core/blob/master/apex_checks.xml</a></p> +<p>To make it easier for the users to set up their development environment, settings for the following common IDEs are provided in the Apache Apex Core repository with instructions.</p> +<ul> +<li><a href="https://github.com/apache/incubator-apex-core/tree/master/misc/ide-templates/intellij";>IntelliJ</a></li> +<li><a href="https://github.com/apache/incubator-apex-core/tree/master/misc/ide-templates/eclipse";>Eclipse</a></li> +<li><a href="https://github.com/apache/incubator-apex-core/tree/master/misc/ide-templates/netbeans";>NetBeans</a></li> +</ul> +<h2 id="opening-pull-requests-contributors-">Opening Pull Requests (contributors)</h2> +<p>The apex-core and apex-malhar repositories both have mirror repositories on github which are used to review pull requests and provide a second remote endpoint for the codebase.</p> +<ol> +<li>Create a JIRA (<a href="https://issues.apache.org/jira/browse/APEXCORE/";>-core</a>,<a href="https://issues.apache.org/jira/browse/APEXMALHAR/";>-malhar</a>) for the work you plan to do (or assign yourself to an existing JIRA ticket)</li> +<li>Fork the ASF github mirror (one time step): +<a href="https://github.com/apache/incubator-apex-core/";>https://github.com/apache/incubator-apex-core/</a> </li> +<li>Clone the <strong>fork</strong> on your local workspace (one time step):<br><code>git clone https://github.com/{github_username}/incubator-apex-core.git</code></li> +<li>Add <a href="https://github.com/apache/incubator-apex-core";>incubator apex core</a> as a remote repository (one time step):<br><code>git remote add upstream https://github.com/apache/incubator-apex-core</code></li> +<li>Create a new branch from the <a href="https://github.com/apache/incubator-apex-core/tree/master";>master</a> branch. <strong>Name your branch with the JIRA number in it, e.g. <code>APEXCORE-123.my-feature</code>.</strong><br><code>git checkout -b APEXCORE-123.my-feature -t upstream/master</code><br>Creating a local branch that tracks a remote makes pull easier (no need to specify the remote branch while pulling). A branch can be made to track a remote branch anytime, not necessarily at its creation by:<br><code>git branch -u upstream/master</code></li> +<li>When adding new files, please include the Apache v2.0 license header.<ul> +<li>From the top level directory, run <code>mvn license:check -Dlicense.skip=false</code> to check correct header formatting.</li> +<li>Run <code>mvn license:format -Dlicense.skip=false</code> to automatically add the header when missing.</li> +</ul> +</li> +<li>Once your feature is complete, submit the pull request on github against <code>master</code>.</li> +<li>If you want specific people to review your pull request, use the <code>@</code> notation in Github comments to mention that user, and request that he/she reviews your changes.</li> +<li>Check the status of the pull request and ensure the Travis CI build is successful. If not, inspect the linked build log for details.<ul> +<li>If build fails due to license headers, follow instructions above.</li> +<li>If build fails due to code style violations, run <code>mvn checkstyle:check -Dcheckstyle.console=true</code> and correct those issues that were introduced with your changes. </li> +</ul> +</li> +<li>Add changes after the PR was opened to the same branch, Travis CI will detect changes and build automatically. To force the CI run, close and re-open the PR.</li> +<li><p>After all review is complete, combine all new commits into one squashed commit except when there are multiple contributors, and include the Jira number in the commit message. There are several ways to squash commits, but <a href="https://git-scm.com/book/en/v2/Git-Tools-Rewriting-History#Squashing-Commits";>here is one explanation from git-scm.com</a> and a simple example is illustrated below:</p> +<p>If tracking upstream/master then run <code>git rebase -i</code>. Else run <code>git rebase -i upstream/master</code>.<br>This command opens the text editor which lists the multiple commits:</p> +<pre><code>pick 67cd79b change1 +pick 6f98905 change2 + +# Rebase e13748b..3463fbf onto e13748b (2 command(s)) +# +# Commands: +# p, pick = use commit +# r, reword = use commit, but edit the commit message +# e, edit = use commit, but stop for amending +# s, squash = use commit, but meld into previous commit +# f, fixup = like "squash", but discard this commit's log message +# x, exec = run command (the rest of the line) using shell +# +# These lines can be re-ordered; they are executed from top to bottom. +</code></pre><p>Squash 'change2' to 'change1' and save.</p> +<pre><code>pick 67cd79b change1 +squash 6f98905 change2 +</code></pre></li> +<li>If there are multiple contributors in a pull request preserve individual attributions. Try to squash the commits to the minimum number of commits required to preserve attribution and the contribution to still be functionally correct.</li> +<li>Till the review is complete it may happen that working feature branch may diverge from <code>master</code> substantially. Therefore, it is recommended to frequently merge <code>master</code> to the branch being worked on by:<ul> +<li>when the branch tracks upstream/master<br><code>git pull</code></li> +<li>when the branch doesn't track upstream<br><code>git pull upstream master</code></li> +</ul> +</li> +<li>If a pull from <code>master</code> results in a conflict then resolve it and commit the merge. This results in additional merge commits in the pull request. Following steps help to ensure that the final pull request contains just one commit:<ul> +<li>Rename the original branch:<br><code>git branch -m APEXCORE-123.my-feature.squash</code></li> +<li>Create a new branch (with the original name) from upstream/master that has latest changes:<br><code>git checkout -b APEXCORE-123.my-feature -t upstream/master</code></li> +<li>Squash merge the old branch which was renamed. When the new branch has the latest changes then this squash will result only in the changes that were made for the feature:<br><code>git merge --squash APEXCORE-123.my-feature.squash</code></li> +<li>Commit the squash and force push it to the old feature remote branch so that the pull request is automatically updated:<br><code>git commit -m "APEXCORE-123 #comment added my-feature"</code><br><code>git push origin +APEXCORE-123.my-feature</code></li> +<li>Delete the extra squash branch:<br><code>git branch -D APEXCORE-123.my-feature.squash</code></li> +</ul> +</li> +</ol> +<p>Thanks for contributing!</p> +<h2 id="merging-a-pull-request-committers-">Merging a Pull Request (committers)</h2> +<ol> +<li>Ensure that the basic requirements for a pull request are met. This includes:<ul> +<li>Commit messages need to reference JIRA (pull requests will be linked to ticket)</li> +<li>Travis CI pull request build needs to pass</li> +<li>Ensure tests are added/modified for new features or fixes</li> +<li>Ensure appropriate JavaDoc comments have been added</li> +</ul> +</li> +<li>To set up access to the ASF source repository, <a href="https://git-wip-us.apache.org/#committers-getting-started";>follow these steps</a>. The ASF master repository is: <code>https://git-wip-us.apache.org/repos/asf/incubator-apex-core.git</code></li> +<li>Use the git command line to pull in the changes from the pull requests. You can refer to the corresponding email that will be automatically sent to the <code>[email protected]</code> mailing list to see the exact commands to merge the given pull request.</li> +<li>Once done with verification, push the changes to the ASF repository's <code>master</code> branch. Within a few +seconds, the changes will propagate back to the github mirror and the pull requests be closed and marked merged automatically.</li> +<li>The <code>Fix version</code> field on the corresponding JIRA ticket needs to be set and the ticket resolved after pushing the changes.</li> +</ol> +<p><strong>Note: since none of us has write access to the mirror, only the author of a pull request can close it if it was not merged.</strong></p> + +</div> + + <hr> + <div class="container"> + <footer id="main-footer"> + <p> + Copyright © <span id="copyright-year">2015</span> <a href="http://apache.org";>The Apache Software Foundation</a>, + Licensed under the Apache License, Version 2.0<br> + Apache and the Apache feather logo are trademarks of The Apache Software Foundation.<br> + <a class="footer-link-img" href="http://apache.org";><img src="/images/asf_logo.svg" alt="The Apache Software Foundation"></a> + </p> + </footer> + </div> <!-- /container --> + + <!-- Placed at the end of the document so the pages load faster --> + <script src="https://ajax.googleapis.com/ajax/libs/jquery/1.11.3/jquery.min.js";></script> + <script src="/js/bootstrap.min.js"></script> + <script> + $('#copyright-year').text((new Date()).getFullYear()); + </script> + +</body> +</html>
