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 2015/12/09 21:31:27 UTC
incubator-datafu git commit: DATAFU-112 Update website instructions
with info on Maven download
Repository: incubator-datafu
Updated Branches:
refs/heads/master 13bae3661 -> f8d31403a
DATAFU-112 Update website instructions with info on Maven download
Project: http://git-wip-us.apache.org/repos/asf/incubator-datafu/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-datafu/commit/f8d31403
Tree: http://git-wip-us.apache.org/repos/asf/incubator-datafu/tree/f8d31403
Diff: http://git-wip-us.apache.org/repos/asf/incubator-datafu/diff/f8d31403
Branch: refs/heads/master
Commit: f8d31403af90be67df2cdc98326c273f746aea12
Parents: 13bae36
Author: Matthew Hayes <ma...@gmail.com>
Authored: Tue Dec 8 18:55:18 2015 -0800
Committer: Matthew Hayes <ma...@gmail.com>
Committed: Tue Dec 8 18:55:18 2015 -0800
----------------------------------------------------------------------
.../datafu/getting-started.html.markdown.erb | 2 +-
site/source/docs/quick-start.html.markdown.erb | 91 +++++++++++---------
2 files changed, 53 insertions(+), 40 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-datafu/blob/f8d31403/site/source/docs/datafu/getting-started.html.markdown.erb
----------------------------------------------------------------------
diff --git a/site/source/docs/datafu/getting-started.html.markdown.erb b/site/source/docs/datafu/getting-started.html.markdown.erb
index f3d16c8..af82244 100644
--- a/site/source/docs/datafu/getting-started.html.markdown.erb
+++ b/site/source/docs/datafu/getting-started.html.markdown.erb
@@ -98,7 +98,7 @@ We can clearly see that the median is 2 for this data set. First we'll start up
then register the DataFu JAR:
```pig
-register datafu-<%= current_page.data.version %>.jar
+register datafu-pig-incubating-<%= current_page.data.version %>.jar
```
To compute the median we'll use DataFu's `StreamingMedian`, which computes an estimate of the median but has the benefit
http://git-wip-us.apache.org/repos/asf/incubator-datafu/blob/f8d31403/site/source/docs/quick-start.html.markdown.erb
----------------------------------------------------------------------
diff --git a/site/source/docs/quick-start.html.markdown.erb b/site/source/docs/quick-start.html.markdown.erb
index 88354fe..d3cf233 100644
--- a/site/source/docs/quick-start.html.markdown.erb
+++ b/site/source/docs/quick-start.html.markdown.erb
@@ -21,39 +21,76 @@ license: >
# Quick Start
-Download the source release from one of the mirrors:
+Apache DataFu is available for download as a source release and as compiled artifacts stored in a Maven repository.
-* [http://www.apache.org/dyn/closer.cgi/incubator/datafu/apache-datafu-incubating-1.3.0/](http://www.apache.org/dyn/closer.cgi/incubator/datafu/apache-datafu-incubating-1.3.0/)
+## Downloading from the Maven Repository
+
+The latest release can be found in [Apache's Maven Repository for DataFu](https://repository.apache.org/content/groups/public/org/apache/datafu):
+
+* [datafu-pig-incubating-<%= current_page.data.version %>](https://repository.apache.org/content/groups/public/org/apache/datafu/datafu-pig-incubating/<%= current_page.data.version %>/)
+* [datafu-hourglass-incubating-<%= current_page.data.version %>](https://repository.apache.org/content/groups/public/org/apache/datafu/datafu-hourglass-incubating/<%= current_page.data.version %>/)
+
+You can also use a dependency management system to download the DataFu artifacts and all their dependencies.
+
+Gradle:
+
+```groovy
+compile "org.apache.datafu:datafu-pig-incubating:<%= current_page.data.version %>"
+compile "org.apache.datafu:datafu-hourglass-incubating:<%= current_page.data.version %>"
+```
+
+Ivy:
+
+```xml
+<dependency org="org.apache.datafu" name="datafu-pig-incubating" rev="<%= current_page.data.version %>"/>
+<dependency org="org.apache.datafu" name="datafu-hourglass-incubating" rev="<%= current_page.data.version %>"/>
+```
+
+Maven:
+
+```xml
+<dependency>
+ <groupId>org.apache.datafu</groupId>
+ <artifactId>datafu-pig-incubating</artifactId>
+ <version><%= current_page.data.version %></version>
+</dependency>
+<dependency>
+ <groupId>org.apache.datafu</groupId>
+ <artifactId>datafu-hourglass-incubating</artifactId>
+ <version><%= current_page.data.version %></version>
+</dependency>
+```
+
+See the following guides for next steps:
-Also make sure you have [Gradle](http://gradle.org/gradle-download/) installed. The instructions below assume the `gradle` command is in your path.
+* [Getting started with DataFu for Pig](/docs/datafu/getting-started.html)
+* [Getting started with DataFu Hourglass](/docs/hourglass/getting-started.html)
-Extract the source and bootstrap the `gradlew` script we'll use for building:
+## Building from Source
+
+You can also build DataFu from the source release. Download the source release from one of the mirrors:
+
+* [http://www.apache.org/dyn/closer.cgi/incubator/datafu/apache-datafu-incubating-1.3.0/](http://www.apache.org/dyn/closer.cgi/incubator/datafu/apache-datafu-incubating-1.3.0/)
+
+Make sure you have [Gradle](http://gradle.org/gradle-download/) installed. Extract the source and bootstrap the `gradlew` script that's used for building:
tar xvf apache-datafu-incubating-sources-<%= current_page.data.version %>.tgz
cd apache-datafu-incubating-sources-<%= current_page.data.version %>
gradle -b bootstrap.gradle
-## Build
-
To build the JARs from the source release, run:
./gradlew assemble
-### DataFu Pig
-
After building, the DataFu Pig artifacts can be found in `datafu-pig/build/libs`. This should contain:
* `datafu-pig-incubating-<%= current_page.data.version %>.jar`
* `datafu-pig-incubating-<%= current_page.data.version %>-javadoc.jar`
* `datafu-pig-incubating-<%= current_page.data.version %>-sources.jar`
-The `datafu-pig-incubating-<%= current_page.data.version %>.jar` file can now be used in Pig!
-
-See [DataFu Pig - Getting Started](/docs/datafu/getting-started.html) for next steps.
-
-### DataFu Hourglass
+The `datafu-pig-incubating-<%= current_page.data.version %>.jar` file can now be used in Pig.
-After building, the DataFu Hourglass artifacts can be found in `datafu-hourglass/build/libs`. This should contain:
+The DataFu Hourglass artifacts can be found in `datafu-hourglass/build/libs`. This should contain:
* `datafu-hourglass-incubating-<%= current_page.data.version %>.jar`
* `datafu-hourglass-incubating-<%= current_page.data.version %>-javadoc.jar`
@@ -65,28 +102,4 @@ DataFu Hourglass has several external library dependencies that are required in
Assuming your local maven repository is at `~/.m2`, you should see the DataFu Hourglass libraries under `~/.m2/repository/org/apache/datafu/datafu-hourglass-incubating/<%= current_page.data.version %>`.
-You should now be able to declare a dependency on DataFu Hourglass.
-
-Gradle:
-
-```groovy
-compile "org.apache.datafu:datafu-hourglass-incubating:<%= current_page.data.version %>"
-```
-
-Ivy:
-
-```xml
-<dependency org="org.apache.datafu" name="datafu-hourglass-incubating" rev="<%= current_page.data.version %>"/>
-```
-
-Maven:
-
-```xml
-<dependency>
- <groupId>org.apache.datafu</groupId>
- <artifactId>datafu-hourglass-incubating</artifactId>
- <version><%= current_page.data.version %></version>
-</dependency>
-```
-
-See [DataFu Hourglass - Getting Started](/docs/hourglass/getting-started.html) for next steps.
\ No newline at end of file
+You should now be able to declare a dependency on DataFu Hourglass as shown above.
\ No newline at end of file