fluo-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From mwa...@apache.org
Subject [1/2] incubator-fluo git commit: Minor documentation updates for 1.0.0 release
Date Fri, 15 Jul 2016 11:24:15 GMT
Repository: incubator-fluo
Updated Branches:
  refs/heads/master 377571f59 -> add0fd4b0

Minor documentation updates for 1.0.0 release

* Updated download link to point project website rather than GitHub
* Java links to point to OpenJDK
* Removed whitespace

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

Branch: refs/heads/master
Commit: 37cb000af19c6d42c1808260c1b7e2ed10506112
Parents: 2f32661
Author: Mike Walch <mwalch@gmail.com>
Authored: Thu Jul 14 16:46:39 2016 -0400
Committer: Mike Walch <mwalch@gmail.com>
Committed: Fri Jul 15 07:16:25 2016 -0400

 docs/applications.md    |  5 ++---
 docs/contributing.md    |  4 ++--
 docs/grafana.md         |  2 +-
 docs/metrics.md         | 10 +++++-----
 docs/prod-fluo-setup.md |  4 ++--
 5 files changed, 12 insertions(+), 13 deletions(-)

diff --git a/docs/applications.md b/docs/applications.md
index 17609be..7da4d94 100644
--- a/docs/applications.md
+++ b/docs/applications.md
@@ -4,7 +4,7 @@ Creating Fluo applications
 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,
+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:
@@ -93,7 +93,7 @@ To create an observer, follow these steps:
 1. Create a class that extends [AbstractObserver].
 2. Build a jar containing this class and include this jar in the `lib/` directory of your
Fluo application.
-3. Configure your Fluo instance to use this observer by modifying the Observer section of
+3. Configure your Fluo instance to use this observer by modifying the Observer section of
 4. Restart your Fluo instance so that your Fluo workers load the new observer.
 Application Configuration
@@ -114,7 +114,6 @@ provide enough information to debug the root cause of the problem.  To
 debug Fluo applications, low-level logging of transactions can be turned on by
 setting the following loggers to TRACE:
 | Logger               | Level | Information                                            
 | `fluo.tx`            | TRACE | Provides detailed information about what transactions read
and wrote                               |

diff --git a/docs/contributing.md b/docs/contributing.md
index 7fb7c0f..17af2e6 100644
--- a/docs/contributing.md
+++ b/docs/contributing.md
@@ -4,7 +4,7 @@ Contributing to Fluo
 Building Fluo
-If you have [Git], [Maven], and [Java](version 7+) installed, run these commands
+If you have [Git], [Maven], and [Java][java] (version 8+) installed, run these commands
 to build Fluo:
     git clone https://github.com/apache/incubator-fluo.git
@@ -22,6 +22,6 @@ a local Fluo instance (called MiniFluo) and run against it.
 * A [Stress test][Stress] application designed to run on a cluster.
 [Git]: http://git-scm.com/
-[Java]: https://www.oracle.com/java/index.html
+[java]: http://openjdk.java.net/
 [Maven]: http://maven.apache.org/
 [Stress]: https://github.com/fluo-io/fluo-stress

diff --git a/docs/grafana.md b/docs/grafana.md
index 3263e8b..5d10b96 100644
--- a/docs/grafana.md
+++ b/docs/grafana.md
@@ -2,7 +2,7 @@
 # Fluo metrics in Grafana/InfluxDB
 Fluo is instrumented using [dropwizard metrics][1] which allows Fluo to be configured
-to send metrics to multiple metrics tools (such as Graphite, Ganglia, etc).  
+to send metrics to multiple metrics tools (such as Graphite, Ganglia, etc).
 This document describes how to send Fluo metrics to [InfluxDB], a time series database, and
 them viewable in [Grafana], a visualization tool.  If you want general information on metrics,
see the 

diff --git a/docs/metrics.md b/docs/metrics.md
index b98e68f..eb2a1e4 100644
--- a/docs/metrics.md
+++ b/docs/metrics.md
@@ -11,8 +11,8 @@ different tools, below are some tools that have been used with Fluo.
    these tools for you and configure Fluo to send to them.
 2. JMX - Fluo can be configured to reports metrics via JMX which can be viewed
-   in jconsole or jvisualvm.  
+   in jconsole or jvisualvm.
 3. CSV - Fluo can be configured to output metrics as CSV to a specified directory.
 Configuring Reporters
@@ -20,13 +20,13 @@ Configuring Reporters
 Inorder to configure metrics reporters, look at the metrics section in an
 applications `fluo.properties` file.  This sections has a lot of commented out
-options for configuring reporters.  
+options for configuring reporters.
 The frequency is in seconds for all reporters.
 Metrics reported by Fluo
@@ -39,7 +39,7 @@ this id consist of a hostname and a base36 long that is unique across all
fluo p
 Some of the metrics reported have the class name as the suffix.  This classname
 is the observer or load task that executed the transactions.   This should
 allow things like transaction collisions to be tracked per class.  In the
-table below this is denoted with `<cn>`.  
+table below this is denoted with `<cn>`.
 |Metric                                 | Type           | Description                  

diff --git a/docs/prod-fluo-setup.md b/docs/prod-fluo-setup.md
index e2015ca..a697288 100644
--- a/docs/prod-fluo-setup.md
+++ b/docs/prod-fluo-setup.md
@@ -215,8 +215,8 @@ distribution on every node in your cluster.
 [Accumulo]: https://accumulo.apache.org/
 [Hadoop]: http://hadoop.apache.org/
 [Zookeeper]: http://zookeeper.apache.org/
-[Java]: https://www.oracle.com/java/index.html
-[release]: https://github.com/apache/incubator-fluo/releases
+[Java]: http://openjdk.java.net/
+[release]: https://fluo.apache.org/download/
 [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

View raw message