You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@datafu.apache.org by mh...@apache.org on 2014/04/14 23:02:56 UTC
git commit: Update site with links to wiki on contributing
Repository: incubator-datafu
Updated Branches:
refs/heads/master 787260863 -> 00a0442d9
Update site with links to wiki on contributing
Project: http://git-wip-us.apache.org/repos/asf/incubator-datafu/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-datafu/commit/00a0442d
Tree: http://git-wip-us.apache.org/repos/asf/incubator-datafu/tree/00a0442d
Diff: http://git-wip-us.apache.org/repos/asf/incubator-datafu/diff/00a0442d
Branch: refs/heads/master
Commit: 00a0442d997529ef7b097f39efa85b6238cb4e8e
Parents: 7872608
Author: Matt Hayes <mh...@linkedin.com>
Authored: Mon Apr 14 13:59:52 2014 -0700
Committer: Matt Hayes <mh...@linkedin.com>
Committed: Mon Apr 14 13:59:52 2014 -0700
----------------------------------------------------------------------
site/source/docs/datafu/contributing.html.markdown | 17 ++++++++++++-----
.../docs/hourglass/contributing.html.markdown | 13 ++++++++++---
2 files changed, 22 insertions(+), 8 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-datafu/blob/00a0442d/site/source/docs/datafu/contributing.html.markdown
----------------------------------------------------------------------
diff --git a/site/source/docs/datafu/contributing.html.markdown b/site/source/docs/datafu/contributing.html.markdown
index e23ded4..f0e79de 100644
--- a/site/source/docs/datafu/contributing.html.markdown
+++ b/site/source/docs/datafu/contributing.html.markdown
@@ -5,15 +5,22 @@ section_name: Apache DataFu Pig
# Contributing
-We welcome contributions to the Apache DataFu Pig library! If you are interested please follow the guide below.
+We welcome contributions to the Apache DataFu Pig library! Please read the following guide on how to contribute to DataFu.
-## Get the Code
+https://cwiki.apache.org/confluence/display/DATAFU/Contributing+to+Apache+DataFu
+
+## Common Tasks
+
+Common tasks for working with the DataFu Pig code can be found below. For information on how to contribute patches, please
+follow the wiki link above.
+
+### Get the Code
To clone the repository run the following command:
git clone git://git.apache.org/incubator-datafu.git
-## Eclipse
+### Generate Eclipse Files
The following command generates the necessary files to load the project in Eclipse:
@@ -25,7 +32,7 @@ To clean up the eclipse files:
Note that you may run out of heap when executing tests in Eclipse. To fix this adjust your heap settings for the TestNG plugin. Go to Eclipse->Preferences. Select TestNG->Run/Debug. Add "-Xmx1G" to the JVM args.
-## Build the JAR
+### Build the JAR
The Apache DataFu Pig library can be built by running the command below.
@@ -33,7 +40,7 @@ The Apache DataFu Pig library can be built by running the command below.
The built JAR can be found under `datafu-pig/build/libs` by the name `datafu-pig-x.y.z.jar`, where x.y.z is the version.
-## Running Tests
+### Running Tests
All the tests can be run from within eclipse. However they can also be run from the command line. To run all the tests:
http://git-wip-us.apache.org/repos/asf/incubator-datafu/blob/00a0442d/site/source/docs/hourglass/contributing.html.markdown
----------------------------------------------------------------------
diff --git a/site/source/docs/hourglass/contributing.html.markdown b/site/source/docs/hourglass/contributing.html.markdown
index ecb6660..7ee7c95 100644
--- a/site/source/docs/hourglass/contributing.html.markdown
+++ b/site/source/docs/hourglass/contributing.html.markdown
@@ -5,14 +5,21 @@ section_name: Apache DataFu Hourglass
# Contributing
-We welcome contributions to the Apache DataFu Hourglass library! If you are interested please follow the guide below.
+We welcome contributions to the Apache DataFu Hourglass library! Please read the following guide on how to contribute to DataFu.
-## Build the JAR
+https://cwiki.apache.org/confluence/display/DATAFU/Contributing+to+Apache+DataFu
+
+## Common Tasks
+
+Common tasks for working with the DataFu Pig code can be found below. For information on how to contribute patches, please
+follow the wiki link above.
+
+### Build the JAR
cd contrib/hourglass
ant jar
-## Running Tests
+### Running Tests
All the tests can be run from within eclipse. However they can also be run from the command line. To run all the tests: