Repository: incubator-apex-site Updated Branches: refs/heads/master 9da328778 -> c55ae71de
add guide to using the github mirror 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/c55ae71d Tree: http://git-wip-us.apache.org/repos/asf/incubator-apex-site/tree/c55ae71d Diff: http://git-wip-us.apache.org/repos/asf/incubator-apex-site/diff/c55ae71d Branch: refs/heads/master Commit: c55ae71de47addde5a8713ed2b64aa31c58510ed Parents: 9da3287 Author: Andy Perlitch <[email protected]> Authored: Fri Sep 18 10:14:23 2015 -0700 Committer: Andy Perlitch <[email protected]> Committed: Fri Sep 18 10:14:23 2015 -0700 ---------------------------------------------------------------------- src/md/community.md | 2 ++ src/md/docs.md | 3 ++- src/md/github_prs.md | 35 +++++++++++++++++++++++++ src/pages/github-mirror-pull-requests.html | 9 +++++++ 4 files changed, 48 insertions(+), 1 deletion(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-apex-site/blob/c55ae71d/src/md/community.md ---------------------------------------------------------------------- diff --git a/src/md/community.md b/src/md/community.md index 2bf7c63..d3c23a7 100644 --- a/src/md/community.md +++ b/src/md/community.md @@ -15,6 +15,8 @@ The Apex Project is made up of two repositories: - [Apex Core](https://github.com/apache/incubator-apex-core) - The core of the Apex platform. - [Apex Malhar](https://github.com/apache/incubator-apex-malhar) - Community-driven set of open-source "operators" and utilities for use in your Apex applications. +To learn more about how we use Github to accept contributions to the project, [check out this doc](/github-mirror-pull-requests.html). + ## Issue Tracking [Apex JIRA](https://malhar.atlassian.net/projects/APEX/issues) \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-apex-site/blob/c55ae71d/src/md/docs.md ---------------------------------------------------------------------- diff --git a/src/md/docs.md b/src/md/docs.md index c6dff5e..5195e04 100644 --- a/src/md/docs.md +++ b/src/md/docs.md @@ -6,4 +6,5 @@ Here are a few resources to get started with Apex: - [Application Developer Guide](https://www.datatorrent.com/docs/guides/ApplicationDeveloperGuide.html) - [Application Packages Guide](https://www.datatorrent.com/docs/guides/ApplicationPackages.html) -- [Operator Developer Guide](https://www.datatorrent.com/docs/guides/OperatorDeveloperGuide.html) \ No newline at end of file +- [Operator Developer Guide](https://www.datatorrent.com/docs/guides/OperatorDeveloperGuide.html) +- [Merging Github Mirror Pull Requests](/github-mirror-pull-requests.html) \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-apex-site/blob/c55ae71d/src/md/github_prs.md ---------------------------------------------------------------------- diff --git a/src/md/github_prs.md b/src/md/github_prs.md new file mode 100644 index 0000000..a8a2ab2 --- /dev/null +++ b/src/md/github_prs.md @@ -0,0 +1,35 @@ +# Submitting and Merging Pull Requests via the Github Mirror + +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. + + + +## Opening a Pull Request + +Fork the ASF github mirror: + +https://github.com/apache/incubator-apex-core/ + +You can then update your local repository to add the new fork as remote. No +need for another clone or to recreate your workspace. + +Once your feature is complete, submit the pull request. Ensure that the +Apex JIRA numbers are part of the commit message (we have not migrated to +ASF JIRA yet). + +## Merging a Pull Request (must be a committer) + +The ASF master repository is: `https://git-wip-us.apache.org/repos/asf/incubator-apex-core.git` + +Access: [https://git-wip-us.apache.org/#committers-getting-started](https://git-wip-us.apache.org/#committers-getting-started) + +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! + +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. + +**Note: since none of us has write access to the mirror, only the author of a +pull request can close it.** \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-apex-site/blob/c55ae71d/src/pages/github-mirror-pull-requests.html ---------------------------------------------------------------------- diff --git a/src/pages/github-mirror-pull-requests.html b/src/pages/github-mirror-pull-requests.html new file mode 100644 index 0000000..55d2f2c --- /dev/null +++ b/src/pages/github-mirror-pull-requests.html @@ -0,0 +1,9 @@ +{{> header}} + +<div class="container"> + + {{> github_prs}} + +</div> + +{{> footer}} \ No newline at end of file
