fluo-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From ktur...@apache.org
Subject [1/2] incubator-fluo git commit: fixes #750 removed direct links to external projects in documentation
Date Fri, 05 Aug 2016 21:49:38 GMT
Repository: incubator-fluo
Updated Branches:
  refs/heads/master f8d0af6e9 -> 535cba114


fixes #750 removed direct links to external projects in documentation


Project: http://git-wip-us.apache.org/repos/asf/incubator-fluo/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-fluo/commit/b4774f06
Tree: http://git-wip-us.apache.org/repos/asf/incubator-fluo/tree/b4774f06
Diff: http://git-wip-us.apache.org/repos/asf/incubator-fluo/diff/b4774f06

Branch: refs/heads/master
Commit: b4774f06f4a3b58a59a1e16d917ef5de7f7dc71c
Parents: f8d0af6
Author: Keith Turner <keith@deenlo.com>
Authored: Thu Aug 4 15:25:34 2016 -0400
Committer: Keith Turner <kturner@apache.org>
Committed: Fri Aug 5 14:16:05 2016 -0400

----------------------------------------------------------------------
 README.md            | 30 ++++++++----------------------
 docs/applications.md |  6 +-----
 docs/contributing.md |  4 +---
 docs/grafana.md      | 13 ++-----------
 docs/install.md      |  8 +++-----
 docs/metrics.md      |  4 +---
 6 files changed, 16 insertions(+), 49 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-fluo/blob/b4774f06/README.md
----------------------------------------------------------------------
diff --git a/README.md b/README.md
index c2980c2..819900a 100644
--- a/README.md
+++ b/README.md
@@ -11,21 +11,11 @@ of a large-scale computation, index, or analytic as new data is discovered.
Chec
 
 ## Getting Started
 
-There are several ways to run Fluo (listed in order of increasing difficulty):
-
-*  [quickstart] - Starts a MiniFluo instance that is configured to run a word count application
-*  [fluo-dev] - Automated tool that sets up Fluo and its dependencies on a single machine
-*  [Zetten] - Automated tool that launches an AWS cluster and sets up Fluo/Accumulo on it
-*  [Install instructions][install] - Manually set up Fluo on a cluster where Accumulo, Hadoop
&
-   Zookeeper are running
-
-Except for [quickstart], all above will set up a Fluo application that will be idle unless
you
-create client & observer code for your application. You can either [create your own
-application][apps] or configure Fluo to run an example application below:
-
-*  [phrasecount] - Computes phrase counts for unique documents
-*  [fluo-stress] - Computes the number of unique integers by building bitwise trie
-*  [webindex] - Creates a web index using Common Crawl data
+If you are completely new to Fluo, then check out the [Fluo Tour][tour]. To
+learn how to setup Fluo on a cluster, check out the [install
+instructions][install].  There are also external open source projects listed on
+the [related projects page][related] that may be useful for setting
+up Fluo.
 
 ## Applications
 
@@ -44,14 +34,10 @@ Below are helpful resources for Fluo application developers:
    or Ganglia
 
 [fluo]: https://fluo.apache.org/
+[related]: https://fluo.apache.org/related-projects/
+[tour]: https://fluo.apache.org/tour/
 [accumulo]: https://accumulo.apache.org
 [percolator]: https://research.google.com/pubs/pub36726.html
-[quickstart]: https://github.com/fluo-io/fluo-quickstart
-[fluo-dev]: https://github.com/fluo-io/fluo-dev
-[Zetten]: https://github.com/fluo-io/zetten
-[phrasecount]: https://github.com/fluo-io/phrasecount
-[fluo-stress]: https://github.com/fluo-io/fluo-stress
-[webindex]: https://github.com/fluo-io/webindex
 [install]: docs/install.md
 [apps]: docs/applications.md
 [api]: https://fluo.apache.org/apidocs/
@@ -67,4 +53,4 @@ Below are helpful resources for Fluo application developers:
 [ml]: https://maven-badges.herokuapp.com/maven-central/org.apache.fluo/fluo-api/
 [ji]: https://javadoc-emblem.rhcloud.com/doc/org.apache.fluo/fluo-api/badge.svg
 [jl]: http://www.javadoc.io/doc/org.apache.fluo/fluo-api
-[logo]: contrib/fluo-logo.png
\ No newline at end of file
+[logo]: contrib/fluo-logo.png

http://git-wip-us.apache.org/repos/asf/incubator-fluo/blob/b4774f06/docs/applications.md
----------------------------------------------------------------------
diff --git a/docs/applications.md b/docs/applications.md
index 31559e8..2a1ed51 100644
--- a/docs/applications.md
+++ b/docs/applications.md
@@ -3,9 +3,6 @@
 Once you have Fluo installed and running on your cluster, you can now run Fluo applications
which
 consist of clients and observers.
 
-If you are new to Fluo, consider first running the [phrasecount] application on your Fluo
instance.
-Otherwise, you can create your own Fluo client or observer by the following the steps below.
-
 For both clients and observers, you will need to include the following in your Maven pom:
 
 ```xml
@@ -157,11 +154,10 @@ When applications read and write arbitrary binary data, this does not
log so wel
 the trace logs human readable, non ASCII chars are escaped using hex. The convention used
it `\xDD`
 where D is a hex digit. Also the `\` character is escaped to make the output unambiguous.
 
-[phrasecount]: https://github.com/fluo-io/phrasecount
 [FluoFactory]: ../modules/api/src/main/java/org/apache/fluo/api/client/FluoFactory.java
 [FluoClient]: ../modules/api/src/main/java/org/apache/fluo/api/client/FluoClient.java
 [FluoConfiguration]: ../modules/api/src/main/java/org/apache/fluo/api/config/FluoConfiguration.java
 [AbstractObserver]: ../modules/api/src/main/java/org/apache/fluo/api/observer/AbstractObserver.java
 [fluo.properties]: ../modules/distribution/src/main/config/fluo.properties
 [API]: https://fluo.apache.org/apidocs/
-[metrics]: metrics.md
\ No newline at end of file
+[metrics]: metrics.md

http://git-wip-us.apache.org/repos/asf/incubator-fluo/blob/b4774f06/docs/contributing.md
----------------------------------------------------------------------
diff --git a/docs/contributing.md b/docs/contributing.md
index 3146338..5528ac4 100644
--- a/docs/contributing.md
+++ b/docs/contributing.md
@@ -16,7 +16,6 @@ Fluo has a test suite that consists of the following:
 *  Units tests which are run by `mvn package`
 *  Integration tests which are run using `mvn verify`. These tests start a local Fluo instance
    (called MiniFluo) and run against it.
-*  A [Stress test][Stress] application designed to run on a cluster.
 
 ## See Also
 
@@ -25,5 +24,4 @@ Fluo has a test suite that consists of the following:
 [Git]: http://git-scm.com/
 [java]: http://openjdk.java.net/
 [Maven]: http://maven.apache.org/
-[Stress]: https://github.com/fluo-io/fluo-stress
-[contribute]: https://fluo.apache.org/how-to-contribute/
\ No newline at end of file
+[contribute]: https://fluo.apache.org/how-to-contribute/

http://git-wip-us.apache.org/repos/asf/incubator-fluo/blob/b4774f06/docs/grafana.md
----------------------------------------------------------------------
diff --git a/docs/grafana.md b/docs/grafana.md
index b911567..b6ae42c 100644
--- a/docs/grafana.md
+++ b/docs/grafana.md
@@ -7,16 +7,9 @@ This document describes how to send Fluo metrics to [InfluxDB], a time series
da
 them viewable in [Grafana], a visualization tool. If you want general information on metrics,
see
 the [Fluo metrics][2] documentation.
 
-## Set up Grafana/InfluxDB using fluo-dev or Zetten
-
-The easiest way to view the metrics coming from Fluo is to use [fluo-dev] or [Zetten] which
can be
-configured to setup InfluxDB and Grafana as well have Fluo send data to them. Fluo-dev will
also set
-up a Fluo dashboard in Grafana.
-
 ## Set up Grafana/InfluxDB on your own
 
-If you are not using [fluo-dev] or [Zetten], you can follow the instructions below to setup
InfluxDB
-and Grafana on your own.
+Follow the instructions below to setup InfluxDB and Grafana.
 
 1.  Follow the standard installation instructions for [InfluxDB] and [Grafana]. As for versions,
     the instructions below were written using InfluxDB v0.9.4.2 and Grafana v2.5.0.
@@ -83,7 +76,5 @@ and Grafana on your own.
 
 [1]: https://dropwizard.github.io/metrics/3.1.0/
 [2]: metrics.md
-[fluo-dev]: https://github.com/fluo-io/fluo-dev
-[Zetten]: https://github.com/fluo-io/zetten
 [Grafana]: http://grafana.org/
-[InfluxDB]: https://influxdb.com/
\ No newline at end of file
+[InfluxDB]: https://influxdb.com/

http://git-wip-us.apache.org/repos/asf/incubator-fluo/blob/b4774f06/docs/install.md
----------------------------------------------------------------------
diff --git a/docs/install.md b/docs/install.md
index c10a454..f7eadac 100644
--- a/docs/install.md
+++ b/docs/install.md
@@ -1,8 +1,8 @@
 # Fluo Install Instructions
 
 Install instructions for running Fluo on machine or cluster where Accumulo, Hadoop, and Zookeeper
-are installed and running. If you want to avoid setting up these dependencies, consider using
-[fluo-dev] or [Zetten].
+are installed and running.  The Fluo distribution uses YARN to run workers (which run your
Observers)
+and the Oracle across a cluster.
 
 ## Requirements
 
@@ -194,8 +194,6 @@ Use the following commands to stop a local Fluo process:
 In a distributed environment, you will need to deploy and configure a Fluo distribution on
every
 node in your cluster.
 
-[fluo-dev]: https://github.com/fluo-io/fluo-dev
-[Zetten]: https://github.com/fluo-io/zetten
 [Accumulo]: https://accumulo.apache.org/
 [Hadoop]: http://hadoop.apache.org/
 [Zookeeper]: http://zookeeper.apache.org/
@@ -204,4 +202,4 @@ node in your cluster.
 [phrasecount]: https://github.com/fluo-io/phrasecount
 [fluo.properties]: ../modules/distribution/src/main/config/fluo.properties
 [fluo-env.sh]: ../modules/distribution/src/main/config/fluo-env.sh
-[lib/ahz/pom.xml]: ../modules/distribution/src/main/lib/ahz/pom.xml
\ No newline at end of file
+[lib/ahz/pom.xml]: ../modules/distribution/src/main/lib/ahz/pom.xml

http://git-wip-us.apache.org/repos/asf/incubator-fluo/blob/b4774f06/docs/metrics.md
----------------------------------------------------------------------
diff --git a/docs/metrics.md b/docs/metrics.md
index ff3cdc3..fd396bb 100644
--- a/docs/metrics.md
+++ b/docs/metrics.md
@@ -5,8 +5,7 @@ information about Fluo by configuring different reporters. While dropwizard
can
 report Fluo metrics to many different tools, below are some tools that have been used with
Fluo.
 
 1.  [Grafana/InfluxDB][3] - Fluo has [documentation][3] for sending metrics to InfluxDB and
viewing
-    them in Grafana. The [fluo-dev] tool can also set up these tools for you and configure
Fluo to
-    send to them.
+    them in Grafana.
 
 2.  JMX - Fluo can be configured to reports metrics via JMX which can be viewed in jconsole
or
     jvisualvm.
@@ -68,4 +67,3 @@ made to the oracle followed by a request for 3 timestamps, then the count
for
 [H]: https://dropwizard.github.io/metrics/3.1.0/getting-started/#histograms
 [G]: https://dropwizard.github.io/metrics/3.1.0/getting-started/#gauges
 [M]: https://dropwizard.github.io/metrics/3.1.0/getting-started/#meters
-[fluo-dev]: https://github.com/fluo-io/fluo-dev
\ No newline at end of file


Mime
View raw message