Repository: incubator-apex-site Updated Branches: refs/heads/asf-site b3a4dc66b -> b52d31ba7
from dc5e12f80bf9c534853446f547a0b23d7465fe7b 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/b52d31ba Tree: http://git-wip-us.apache.org/repos/asf/incubator-apex-site/tree/b52d31ba Diff: http://git-wip-us.apache.org/repos/asf/incubator-apex-site/diff/b52d31ba Branch: refs/heads/asf-site Commit: b52d31ba7cf70159837641d082758202abfed81e Parents: b3a4dc6 Author: Andy Perlitch <[email protected]> Authored: Thu Oct 15 14:56:05 2015 -0700 Committer: Andy Perlitch <[email protected]> Committed: Thu Oct 15 14:56:05 2015 -0700 ---------------------------------------------------------------------- content/community.html | 2 +- content/contributing.html | 119 ++++++++++++++++++++++++++ content/github-mirror-pull-requests.html | 113 ++---------------------- 3 files changed, 127 insertions(+), 107 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-apex-site/blob/b52d31ba/content/community.html ---------------------------------------------------------------------- diff --git a/content/community.html b/content/community.html index 3dbac48..5b97a5c 100644 --- a/content/community.html +++ b/content/community.html @@ -70,7 +70,7 @@ <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> - <p>To learn more about how we use Github to accept contributions to the project, <a href="/github-mirror-pull-requests.html">check out this doc</a>.</p> + <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> <h2 id="issue-tracking">Issue Tracking</h2> <ul> <li><a href="https://malhar.atlassian.net/projects/APEX/issues";>Apex Core JIRA</a></li> http://git-wip-us.apache.org/repos/asf/incubator-apex-site/blob/b52d31ba/content/contributing.html ---------------------------------------------------------------------- diff --git a/content/contributing.html b/content/contributing.html new file mode 100644 index 0000000..20d914a --- /dev/null +++ b/content/contributing.html @@ -0,0 +1,119 @@ +<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 (Incubating)</title> + + <!-- Main Stylesheet --> + <link href="css/main.css" rel="stylesheet"> + + </head> + + <body> + <nav class="navbar navbar-static-top" id="main-nav"> + <div class="container"> + <a class="navbar-brand" href="/"> + <img src="images/apex-logo.svg" class="logo" alt="Apache Apex Logo"> + Apache Apex + <small>(incubating)</small> + </a> + <ul class="nav nav-pills navbar-right"> + <li class="nav-item"> + <a class="nav-link" href="/">Home</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> + </ul> + </div> + </nav> +<div class="container"> + + <h1 id="contributing-guidelines">Contributing Guidelines</h1> + <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> + <h2 id="opening-a-pull-request-contributors-">Opening a Pull Request (contributors)</h2> + <p>This project welcomes new contributors. If you would like to help by adding new features, enhancements or fixing bugs, here is how to do it.</p> + <ol> + <li>Create a <a href="https://malhar.atlassian.net/";>JIRA</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>Create a new branch from the <a href="https://github.com/apache/incubator-apex-core/tree/devel-3";>devel-3</a> branch. <strong>Name your branch with the JIRA number in it, e.g. <code>APEX-123.my-feature</code>.</strong></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>devel-3</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>After all review is complete, combine all new commits into one squashed commit, 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>.</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>devel-3</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 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-feather.png" alt="The Apache Software Foundation"></a> + <a class="footer-link-img" href="http://incubator.apache.org/";><img src="/images/incubator-egg.png" alt="Apache Incubator"></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/b52d31ba/content/github-mirror-pull-requests.html ---------------------------------------------------------------------- diff --git a/content/github-mirror-pull-requests.html b/content/github-mirror-pull-requests.html index c430f48..4dfbd35 100644 --- a/content/github-mirror-pull-requests.html +++ b/content/github-mirror-pull-requests.html @@ -1,108 +1,9 @@ -<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 (Incubating)</title> - - <!-- Main Stylesheet --> - <link href="css/main.css" rel="stylesheet"> - +<html> + <head> + <title>Redirecting...</title> + <meta http-equiv="refresh" content="5;URL=/contributing.html"> </head> - - <body> - <nav class="navbar navbar-static-top" id="main-nav"> - <div class="container"> - <a class="navbar-brand" href="/"> - <img src="images/apex-logo.svg" class="logo" alt="Apache Apex Logo"> - Apache Apex - <small>(incubating)</small> - </a> - <ul class="nav nav-pills navbar-right"> - <li class="nav-item"> - <a class="nav-link" href="/">Home</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> - </ul> - </div> - </nav> -<div class="container"> - - <h1 id="submitting-and-merging-pull-requests-via-the-github-mirror">Submitting and Merging Pull Requests via the Github Mirror</h1> - <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> - <h2 id="opening-a-pull-request">Opening a Pull Request</h2> - <p>Fork the ASF github mirror:</p> - <p><a href="https://github.com/apache/incubator-apex-core/";>https://github.com/apache/incubator-apex-core/</a></p> - <p>You can then update your local repository to add the new fork as remote. No - need for another clone or to recreate your workspace.</p> - <p>Once your feature is complete, submit the pull request. Some additional notes:</p> - <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>Fix version needs to be set after pushing changes</li> - </ul> - <h2 id="merging-a-pull-request-must-be-a-committer-">Merging a Pull Request (must be a committer)</h2> - <p>The ASF master repository is: <code>https://git-wip-us.apache.org/repos/asf/incubator-apex-core.git</code></p> - <p>Access: <a href="https://git-wip-us.apache.org/#committers-getting-started";>https://git-wip-us.apache.org/#committers-getting-started</a></p> - <p>Use the command line to pull in the changes from the pull requests. Since - the github mirror is readonly, you will not be shown the convenient command - line instructions :-( Good opportunity to remember the git commands!</p> - <p>Once done with verification, push the changes to the master. Within a few - seconds, the changes will propagate back to the github mirror and the pull - requests be closed and marked merged.</p> - <p><strong>Note: since none of us has write access to the mirror, only the author of a - pull request can close it.</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-feather.png" alt="The Apache Software Foundation"></a> - <a class="footer-link-img" href="http://incubator.apache.org/";><img src="/images/incubator-egg.png" alt="Apache Incubator"></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> + <body bgcolor="#ffffff"> + <center>The contributing guidelines have moved to <a href="/contributing.html">/contributing.html</a>. You will be redirected in 5 seconds. Please bookmark the new location.</center> + </body> </html>
