You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@edgent.apache.org by ca...@apache.org on 2016/05/20 01:24:28 UTC
[55/56] [abbrv] incubator-quarks-website git commit: using
pre-defined properties(site.docsurl) instead of hardcoding
using pre-defined properties(site.docsurl) instead of hardcoding
Project: http://git-wip-us.apache.org/repos/asf/incubator-quarks-website/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-quarks-website/commit/39f1f56d
Tree: http://git-wip-us.apache.org/repos/asf/incubator-quarks-website/tree/39f1f56d
Diff: http://git-wip-us.apache.org/repos/asf/incubator-quarks-website/diff/39f1f56d
Branch: refs/heads/master
Commit: 39f1f56d61b6f1cd7adf1825fe5f8c65b1aae224
Parents: 6bc85b7
Author: cazen.lee <ca...@samsung.com>
Authored: Wed May 18 16:54:04 2016 +0900
Committer: cazen.lee <ca...@samsung.com>
Committed: Wed May 18 16:54:04 2016 +0900
----------------------------------------------------------------------
site/_config.yml | 4 ++--
site/_includes/header.html | 2 +-
site/docs/console.md | 2 +-
site/docs/quarks-getting-started.md | 4 ++--
site/docs/quickstart.md | 4 ++--
site/docs/samples.md | 2 +-
site/recipes/recipe_adaptable_filter_range.md | 2 +-
site/recipes/recipe_adaptable_polling_source.md | 2 +-
site/recipes/recipe_combining_streams_processing_results.md | 4 ++--
site/recipes/recipe_external_filter_range.md | 2 +-
site/recipes/recipe_value_out_of_range.md | 4 ++--
11 files changed, 16 insertions(+), 16 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-quarks-website/blob/39f1f56d/site/_config.yml
----------------------------------------------------------------------
diff --git a/site/_config.yml b/site/_config.yml
index 78c887c..298347c 100755
--- a/site/_config.yml
+++ b/site/_config.yml
@@ -123,6 +123,6 @@ port: 4000
host: 127.0.0.1
#Base URLs
-docsurl: http://quarks-edge.github.io/quarks.documentation/
sourceurl: https://github.com/apache/incubator-quarks
-projurl: http://quarks-edge.github.io/quarks
+projurl: http://quarks.incubator.apache.org
+docsurl: http://quarks.incubator.apache.org/javadoc
http://git-wip-us.apache.org/repos/asf/incubator-quarks-website/blob/39f1f56d/site/_includes/header.html
----------------------------------------------------------------------
diff --git a/site/_includes/header.html b/site/_includes/header.html
index 1d3dac8..8a86e49 100755
--- a/site/_includes/header.html
+++ b/site/_includes/header.html
@@ -98,7 +98,7 @@ limitations under the License.
<a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">Documentation</a>
<ul class="dropdown-menu">
<li><a href="docs/home">Documentation Home</a></li>
- <li><a href="javadoc/lastest/index.html">Javadoc</a></li>
+ <li><a href="{{ site.docsurl }}/lastest/index.html">Javadoc</a></li>
</ul>
</li>
<li class="dropdown">
http://git-wip-us.apache.org/repos/asf/incubator-quarks-website/blob/39f1f56d/site/docs/console.md
----------------------------------------------------------------------
diff --git a/site/docs/console.md b/site/docs/console.md
index fade4f8..97177b8 100644
--- a/site/docs/console.md
+++ b/site/docs/console.md
@@ -402,7 +402,7 @@ If you scroll the browser window down, you can see a Metrics section. This secti
## Counters
-In the `ConsoleWaterDetector` application we used a `DevelopmentProvider`. Therefore, counters were added to most streams (edges) with the following exceptions (from the [Javadoc](http://quarks.incubator.apache.org/javadoc/lastest/quarks/metrics/Metrics.html#counter-quarks.topology.TStream-) for `quarks.metrics.Metrics`):
+In the `ConsoleWaterDetector` application we used a `DevelopmentProvider`. Therefore, counters were added to most streams (edges) with the following exceptions (from the [Javadoc]({{ site.docsurl }}/lastest/quarks/metrics/Metrics.html#counter-quarks.topology.TStream-) for `quarks.metrics.Metrics`):
*Oplets are only inserted upstream from a FanOut oplet.*
http://git-wip-us.apache.org/repos/asf/incubator-quarks-website/blob/39f1f56d/site/docs/quarks-getting-started.md
----------------------------------------------------------------------
diff --git a/site/docs/quarks-getting-started.md b/site/docs/quarks-getting-started.md
index e6fe671..64f58e6 100644
--- a/site/docs/quarks-getting-started.md
+++ b/site/docs/quarks-getting-started.md
@@ -109,7 +109,7 @@ To understand how the application processes the stream, let's review each line.
### Specifying a provider
-Your first step when you write a Quarks application is to create a [`DirectProvider`](http://quarks.incubator.apache.org/javadoc/lastest/index.html?quarks/providers/direct/DirectProvider.html):
+Your first step when you write a Quarks application is to create a [`DirectProvider`]({{ site.docsurl }}/lastest/index.html?quarks/providers/direct/DirectProvider.html):
```java
DirectProvider dp = new DirectProvider();
@@ -119,7 +119,7 @@ A `Provider` is an object that contains information on how and where your Quarks
### Creating a topology
-Additionally a Provider is used to create a [`Topology`](http://quarks.incubator.apache.org/javadoc/lastest/index.html?quarks/topology/Topology.html) instance:
+Additionally a Provider is used to create a [`Topology`]({{ site.docsurl }}/lastest/index.html?quarks/topology/Topology.html) instance:
```java
Topology topology = dp.newTopology();
http://git-wip-us.apache.org/repos/asf/incubator-quarks-website/blob/39f1f56d/site/docs/quickstart.md
----------------------------------------------------------------------
diff --git a/site/docs/quickstart.md b/site/docs/quickstart.md
index 91f3f37..e8f049c 100644
--- a/site/docs/quickstart.md
+++ b/site/docs/quickstart.md
@@ -7,9 +7,9 @@ title: Quickstart IBM Watson IoT Platform sample
IoT devices running quarks applications typically connect to back-end analytic systems through a message hub. Message hubs are used to isolate the back-end system from having to handle connections from thousands to millions of devices.
An example of such a message hub designed for the Internet of Things is [IBM Watson IoT Platform](https://internetofthings.ibmcloud.com/). This cloud service runs on IBM's Bluemix cloud platform
-and Quarks provides a [connector](http://quarks.incubator.apache.org/javadoc/lastest/index.html?quarks/connectors/iotf/IotfDevice.html).
+and Quarks provides a [connector]({{ site.docsurl }}/lastest/index.html?quarks/connectors/iotf/IotfDevice.html).
-You can test out the service without any registration by using its Quickstart service and the Quarks sample application: [code](https://github.com/apache/incubator-quarks/blob/master/samples/connectors/src/main/java/quarks/samples/connectors/iotf/IotfQuickstart.java), [JavaDocs](http://quarks.incubator.apache.org/javadoc/lastest/index.html?quarks/samples/connectors/iotf/IotfQuickstart.html).
+You can test out the service without any registration by using its Quickstart service and the Quarks sample application: [code](https://github.com/apache/incubator-quarks/blob/master/samples/connectors/src/main/java/quarks/samples/connectors/iotf/IotfQuickstart.java), [JavaDocs]({{ site.docsurl }}/lastest/index.html?quarks/samples/connectors/iotf/IotfQuickstart.html).
You can execute the class directly from Eclipse, or using the script: [`quarks/java8/scripts/connectors/iotf/runiotfquickstart.sh`](https://github.com/quarks-edge/quarks/blob/master/scripts/connectors/iotf/runiotfquickstart.sh)
http://git-wip-us.apache.org/repos/asf/incubator-quarks-website/blob/39f1f56d/site/docs/samples.md
----------------------------------------------------------------------
diff --git a/site/docs/samples.md b/site/docs/samples.md
index b0646ef..01466a3 100644
--- a/site/docs/samples.md
+++ b/site/docs/samples.md
@@ -40,4 +40,4 @@ In addition to the sample application in the [Getting started guide](quarks-gett
- Samples that demonstrate how to use IBM Watson IoT Platform as the IoT scale message hub between Quarks and back-end analytic systems:
* [Sample using the no-registration Quickstart service](quickstart)
-Additional samples are documented in the [Quarks Overview](http://quarks.incubator.apache.org/javadoc/lastest/overview-summary.html#overview.description) section of the Javadoc.
+Additional samples are documented in the [Quarks Overview]({{ site.docsurl }}/lastest/overview-summary.html#overview.description) section of the Javadoc.
http://git-wip-us.apache.org/repos/asf/incubator-quarks-website/blob/39f1f56d/site/recipes/recipe_adaptable_filter_range.md
----------------------------------------------------------------------
diff --git a/site/recipes/recipe_adaptable_filter_range.md b/site/recipes/recipe_adaptable_filter_range.md
index 1e2eda9..e4ad943 100644
--- a/site/recipes/recipe_adaptable_filter_range.md
+++ b/site/recipes/recipe_adaptable_filter_range.md
@@ -2,7 +2,7 @@
title: Changing a filter's range
---
-The [Detecting a sensor value out of range](recipe_value_out_of_range.html) recipe introduced the basics of filtering as well as the use of a [Range](http://quarks.incubator.apache.org/javadoc/lastest/quarks/analytics/sensors/Range.html).
+The [Detecting a sensor value out of range](recipe_value_out_of_range.html) recipe introduced the basics of filtering as well as the use of a [Range]({{ site.docsurl }}/lastest//lastest/quarks/analytics/sensors/Range.html).
Oftentimes, a user wants a filter's behavior to be adaptable rather than static. A filter's range can be made changeable via commands from some external source or just changed as a result of some other local analytics.
http://git-wip-us.apache.org/repos/asf/incubator-quarks-website/blob/39f1f56d/site/recipes/recipe_adaptable_polling_source.md
----------------------------------------------------------------------
diff --git a/site/recipes/recipe_adaptable_polling_source.md b/site/recipes/recipe_adaptable_polling_source.md
index 863e027..987de05 100644
--- a/site/recipes/recipe_adaptable_polling_source.md
+++ b/site/recipes/recipe_adaptable_polling_source.md
@@ -8,7 +8,7 @@ Oftentimes, a user wants the poll frequency to be adaptable rather than static.
A Quarks `IotProvider` and `IoTDevice` with its command streams would be a natural way to control the application. In this recipe we will just simulate a "set poll period" command stream.
-The `Topology.poll()` [documentation](http://quarks.incubator.apache.org/javadoc/lastest/quarks/topology/Topology.html#poll-quarks.function.Supplier-long-java.util.concurrent.TimeUnit-) describes how the poll period may be changed at runtime.
+The `Topology.poll()` [documentation]({{ site.docsurl }}/lastest//lastest/quarks/topology/Topology.html#poll-quarks.function.Supplier-long-java.util.concurrent.TimeUnit-) describes how the poll period may be changed at runtime.
The mechanism is based on a more general Quarks runtime `quarks.execution.services.ControlService` service. The runtime registers "control beans" for entities that are controllable. These controls can be retrieved at runtime via the service.
http://git-wip-us.apache.org/repos/asf/incubator-quarks-website/blob/39f1f56d/site/recipes/recipe_combining_streams_processing_results.md
----------------------------------------------------------------------
diff --git a/site/recipes/recipe_combining_streams_processing_results.md b/site/recipes/recipe_combining_streams_processing_results.md
index f61168c..b79878d 100644
--- a/site/recipes/recipe_combining_streams_processing_results.md
+++ b/site/recipes/recipe_combining_streams_processing_results.md
@@ -99,7 +99,7 @@ TStream<Map<String, Integer>> readings = top
## Splitting the readings
-We are now ready to split the `readings` stream by the blood pressure category. Let's look more closely at the method declaration of `split` below. For more details about `split`, refer to the [Javadoc](http://quarks.incubator.apache.org/javadoc/lastest/quarks/topology/TStream.html#split-int-quarks.function.ToIntFunction-).
+We are now ready to split the `readings` stream by the blood pressure category. Let's look more closely at the method declaration of `split` below. For more details about `split`, refer to the [Javadoc]({{ site.docsurl }}/lastest/quarks/topology/TStream.html#split-int-quarks.function.ToIntFunction-).
```java
java.util.List<TStream<T>> split(int n, ToIntFunction<T> splitter)
@@ -208,7 +208,7 @@ TStream<String> hypertensiveAlerts = hypertensive
## Combining the alert streams
-At this point, we have five streams of alerts. Suppose the doctors are interested in seeing a combination of the *Normal* alerts and *Prehypertension* alerts. Or, suppose that they would like to see all of the alerts from all categories together. Here, `union` comes in handy. For more details about `union`, refer to the [Javadoc](http://quarks.incubator.apache.org/javadoc/lastest/quarks/topology/TStream.html#union-quarks.topology.TStream-).
+At this point, we have five streams of alerts. Suppose the doctors are interested in seeing a combination of the *Normal* alerts and *Prehypertension* alerts. Or, suppose that they would like to see all of the alerts from all categories together. Here, `union` comes in handy. For more details about `union`, refer to the [Javadoc]({{ site.docsurl }}/lastest/quarks/topology/TStream.html#union-quarks.topology.TStream-).
There are two ways to define a union. You can either union a `TStream` with another `TStream`, or with a set of streams (`Set<TStream<T>>`). In both cases, a single `TStream` is returned containing the tuples that flow on the input stream(s).
http://git-wip-us.apache.org/repos/asf/incubator-quarks-website/blob/39f1f56d/site/recipes/recipe_external_filter_range.md
----------------------------------------------------------------------
diff --git a/site/recipes/recipe_external_filter_range.md b/site/recipes/recipe_external_filter_range.md
index 2a2f387..96aa89d 100644
--- a/site/recipes/recipe_external_filter_range.md
+++ b/site/recipes/recipe_external_filter_range.md
@@ -2,7 +2,7 @@
title: Using an external configuration file for filter ranges
---
-The [Detecting a sensor value out of range](recipe_value_out_of_range.html) recipe introduced the basics of filtering as well as the use of a [Range](http://quarks.incubator.apache.org/javadoc/lastest/quarks/analytics/sensors/Range.html).
+The [Detecting a sensor value out of range](recipe_value_out_of_range.html) recipe introduced the basics of filtering as well as the use of a [Range]({{ site.docsurl }}/lastest/quarks/analytics/sensors/Range.html).
Oftentimes, a user wants to initialize a range specification from an external configuration file so the application code is more easily configured and reusable.
http://git-wip-us.apache.org/repos/asf/incubator-quarks-website/blob/39f1f56d/site/recipes/recipe_value_out_of_range.md
----------------------------------------------------------------------
diff --git a/site/recipes/recipe_value_out_of_range.md b/site/recipes/recipe_value_out_of_range.md
index 8f19e98..6ad42d3 100644
--- a/site/recipes/recipe_value_out_of_range.md
+++ b/site/recipes/recipe_value_out_of_range.md
@@ -56,7 +56,7 @@ TStream<Double> temp = top.poll(tempSensor, 1, TimeUnit.SECONDS);
## Simple filtering
-If the corn grower is interested in determining when the temperature is strictly out of the optimal range of 77�F and 91�F, a simple filter can be used. The `filter` method can be applied to `TStream` objects, where a filter predicate determines which tuples to keep for further processing. For its method declaration, refer to the [Javadoc](http://quarks.incubator.apache.org/javadoc/lastest/quarks/topology/TStream.html#filter-quarks.function.Predicate-).
+If the corn grower is interested in determining when the temperature is strictly out of the optimal range of 77�F and 91�F, a simple filter can be used. The `filter` method can be applied to `TStream` objects, where a filter predicate determines which tuples to keep for further processing. For its method declaration, refer to the [Javadoc]({{ site.docsurl }}/lastest/quarks/topology/TStream.html#filter-quarks.function.Predicate-).
In this case, we want to keep temperatures below the lower range value *or* above the upper range value. This is expressed in the filter predicate, which follows Java's syntax for [lambda expressions](https://docs.oracle.com/javase/tutorial/java/javaOO/lambdaexpressions.html#syntax). Then, we terminate the stream (using `sink`) by printing out the warning to standard out. Note that `\u00b0` is the Unicode encoding for the degree (�) symbol.
@@ -77,7 +77,7 @@ The `deadband` filter is a part of the `quarks.analytics` package focused on han
deadband(TStream<T> stream, Function<T,V> value, Predicate<V> inBand)
```
-The first parameter is the stream to the filtered, which is `temp` in our scenario. The second parameter is the value to examine. Here, we use the `identity()` method to return a tuple on the stream. The last parameter is the predicate that defines the optimal range, that is, between 77�F and 91�F. it is important to note that this differs from the `TStream` version of `filter` in which one must explicitly specify the values that are out of range. The code snippet below demonstrates how the method call is pieced together. The `deadbandFiltered` stream contains temperature readings that follow the rules as described in the [Javadoc](http://quarks.incubator.apache.org/javadoc/lastest/quarks/analytics/sensors/Filters.html#deadband-quarks.topology.TStream-quarks.function.Function-quarks.function.Predicate-):
+The first parameter is the stream to the filtered, which is `temp` in our scenario. The second parameter is the value to examine. Here, we use the `identity()` method to return a tuple on the stream. The last parameter is the predicate that defines the optimal range, that is, between 77�F and 91�F. it is important to note that this differs from the `TStream` version of `filter` in which one must explicitly specify the values that are out of range. The code snippet below demonstrates how the method call is pieced together. The `deadbandFiltered` stream contains temperature readings that follow the rules as described in the [Javadoc]({{ site.docsurl }}/lastest/quarks/analytics/sensors/Filters.html#deadband-quarks.topology.TStream-quarks.function.Function-quarks.function.Predicate-):
* the value is outside of the optimal range (deadband)
* the first value inside the optimal range after a period being outside it