You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@edgent.apache.org by wc...@apache.org on 2016/03/23 01:01:52 UTC
incubator-quarks-website git commit: from
94ae1369c1ea8260803ae7ff542e296f5095fe6e
Repository: incubator-quarks-website
Updated Branches:
refs/heads/asf-site db98c9e59 -> 93a69c3b1
from 94ae1369c1ea8260803ae7ff542e296f5095fe6e
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/93a69c3b
Tree: http://git-wip-us.apache.org/repos/asf/incubator-quarks-website/tree/93a69c3b
Diff: http://git-wip-us.apache.org/repos/asf/incubator-quarks-website/diff/93a69c3b
Branch: refs/heads/asf-site
Commit: 93a69c3b182a6ac55d36acb97ac7400d7aa724d2
Parents: db98c9e
Author: wcmarsha <wc...@us.ibm.com>
Authored: Tue Mar 22 17:01:19 2016 -0700
Committer: wcmarsha <wc...@us.ibm.com>
Committed: Tue Mar 22 17:01:19 2016 -0700
----------------------------------------------------------------------
content/algolia_search.json | 8 ++++----
content/docs/quarks_index.html | 10 +++++-----
content/docs/quickstart.html | 2 +-
content/recipes/recipe_hello_quarks.html | 2 +-
content/search.json | 2 +-
5 files changed, 12 insertions(+), 12 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-quarks-website/blob/93a69c3b/content/algolia_search.json
----------------------------------------------------------------------
diff --git a/content/algolia_search.json b/content/algolia_search.json
index a309827..af26bee 100644
--- a/content/algolia_search.json
+++ b/content/algolia_search.json
@@ -141,12 +141,12 @@
{
-"title": "Quarks Documentation",
+"title": "Apache Quarks Documentation",
"tags": "",
"keywords": "",
"url": "../docs/quarks_index",
"summary": "",
-"body": "## New DocumentationQuarks is evolving, and so is the documentation. If the existing documentation hasn't answered your questions, you can request new or updated documentation by opening an issue.Click on \"New Documentation\" to open an issue: New Documentation## Providing FeedbackTo provide feedback on our documentation:1. Navigate to the documentation page for which you are providing feedback.1. Click on the **Feedback** button in the top right corner.This will open an issue for the page that you are currently visiting. ## Contributing Documentation If you have ideas on how we can better document or explain some of the concepts, we would love to have your contribution! The quarks.documentation site uses Github's flavor of Markdown and Jekyll markdown for our documentation.Refer to this documentation on Github's flavor of Markdown: [Writing on Github](https://help.github.com/categories/writing-on-github)Refer to this documentation to get started: [Using Jekyll wit
h Pages](https://help.github.com/articles/using-jekyll-with-pages/) To contribute, clone this project locally, make your changes, and create a [pull request](https://github.com/quarks-edge/quarks/pulls).To learn more, visit [Get Involved](getinvolved)"
+"body": "## New DocumentationApache Quarks is evolving, and so is the documentation. If the existing documentation hasn't answered your questions, you can request new or updated documentation by opening an issue.Click on \"New Documentation\" to open an issue: New Documentation## Providing FeedbackTo provide feedback on our documentation:1. Navigate to the documentation page for which you are providing feedback.1. Click on the **Feedback** button in the top right corner.This will open an issue for the page that you are currently visiting. ## Contributing Documentation If you have ideas on how we can better document or explain some of the concepts, we would love to have your contribution! The quarks.documentation site uses Github's flavor of Markdown and Jekyll markdown for our documentation.Refer to this documentation on Github's flavor of Markdown: [Writing on Github](https://help.github.com/categories/writing-on-github)Refer to this documentation to get started: [Using Jek
yll with Pages](https://help.github.com/articles/using-jekyll-with-pages/) To contribute, clone this project locally, make your changes, and create a [pull request](https://github.com/quarks-edge/quarks/pulls).To learn more, visit [Get Involved](getinvolved)"
},
@@ -159,7 +159,7 @@
"keywords": "",
"url": "../docs/quickstart",
"summary": "",
-"body": "# Quarks to Quickstart Quickly!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 platformand Quarks provides a [connector](http://quarks-edge.github.io/quarks/docs/javadoc/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:[quarks.samples.connectors.iotf.IotfQuickstart](http://quarks-edge.github.io/quarks/docs/javadoc/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/runiotfq
uickstart.sh`When run it produces output like this, with a URL as the third line.Pointing any browser on any machine to that URL takes you to a view of the data coming from the sample application.This view is executing in Bluemix, thus the device events from this sample are being sent over the public internetto the Quickstart Bluemix service.Here's an example view:## Quarks CodeThe full source is at:https://github.com/quarks-edge/quarks/blob/master/samples/connectors/src/main/java/quarks/samples/connectors/iotf/IotfQuickstart.javaThe first step to is to create a `IotDevice` instance that represents the connection to IBM Watson IoT Platform Qucikstart service.```java // Declare a connection to IoTF Quickstart service String deviceId = \"qs\" + Long.toHexString(new Random().nextLong()); IotDevice device = IotfDevice.quickstart(topology, deviceId);```Now any stream can send device events to the Quickstart service by simply calling its `events()` method.Here we map
a stream of random numbers into JSON as the payload for a device event is typically JSON.```java TStream json = raw.map(v -> { JsonObject j = new JsonObject(); j.addProperty(\"temp\", v[0]); j.addProperty(\"humidity\", v[1]); j.addProperty(\"objectTemp\", v[2]); return j; });``` Now we have a stream of simulated sensor reading events as JSON tuples (`json`) we send them as events with event identifer (type) `sensors` using `device`. ```java device.events(json, \"sensors\", QoS.FIRE_AND_FORGET);```It's that simple to send a Quarks stream to IBM Watson IoT Platform as device events."
+"body": "# Quarks to Quickstart Quickly!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 platformand Quarks provides a [connector](http://quarks-edge.github.io/quarks/docs/javadoc/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:[quarks.samples.connectors.iotf.IotfQuickstart](http://quarks-edge.github.io/quarks/docs/javadoc/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/runiotfq
uickstart.sh`When run it produces output like this, with a URL as the third line.Pointing any browser on any machine to that URL takes you to a view of the data coming from the sample application.This view is executing in Bluemix, thus the device events from this sample are being sent over the public internetto the Quickstart Bluemix service.Here's an example view:## Quarks CodeThe full source is at:[IotfQuickstart.java](https://github.com/quarks-edge/quarks/blob/master/samples/connectors/src/main/java/quarks/samples/connectors/iotf/IotfQuickstart.java)The first step to is to create a `IotDevice` instance that represents the connection to IBM Watson IoT Platform Qucikstart service.```java // Declare a connection to IoTF Quickstart service String deviceId = \"qs\" + Long.toHexString(new Random().nextLong()); IotDevice device = IotfDevice.quickstart(topology, deviceId);```Now any stream can send device events to the Quickstart service by simply calling its `events
()` method.Here we map a stream of random numbers into JSON as the payload for a device event is typically JSON.```java TStream json = raw.map(v -> { JsonObject j = new JsonObject(); j.addProperty(\"temp\", v[0]); j.addProperty(\"humidity\", v[1]); j.addProperty(\"objectTemp\", v[2]); return j; });``` Now we have a stream of simulated sensor reading events as JSON tuples (`json`) we send them as events with event identifer (type) `sensors` using `device`. ```java device.events(json, \"sensors\", QoS.FIRE_AND_FORGET);```It's that simple to send a Quarks stream to IBM Watson IoT Platform as device events."
},
@@ -172,7 +172,7 @@
"keywords": "",
"url": "../recipes/recipe_hello_quarks",
"summary": "",
-"body": "Quarks' pure Java implementation is a powerful feature which allows it to be run on the majority of JVM-compatible systems. It also has the added benefit of enabling the developer to develop applications entirely within the Eclipse and Intellij ecosystems. For the purposes of this (and future) recipes, it will be assumed that the developer is using Eclipse. To begin the Hello World recipe, create a new project and import the necessary libraries as outlined in the [getting started guide](quarks-getting-started). Next, write the following template application:``` java public static void main(String[] args) { DirectProvider dp = new DirectProvider(); Topology top = dp.newTopology(); }```The *DirectProvider* is an object which allows the user to submit and run the final application. It also creates the *Topology* object, which gives the developer the ability to define a stream of strings.## Using Topology.stringsThe primary abstraction in Quarks is the `TStr
eam`. A *TStream* represents the flow of data in a Quarks application; for example, the periodic floating point readings from a temperature sensor. The data items which are sent through a `TStream` are Java objects -- in the \"Hello Quarks!\" example, we are sending a single java.lang.String. There are a number of ways to create a `TStream`, and `Topology.strings` is the simplest. The user specifies a number of strings which will be used as the stream's data items.``` java public static void main(String[] args) { DirectProvider dp = new DirectProvider(); Topology top = dp.newTopology(); TStream helloStream = top.strings(\"Hello Quarks!\"); }```The `helloStream` stream is created, and the \"Hello Quarks!\" string will be sent as its single data item.## Printing to Output`TStream.print` can be used to print the data items of a stream to standard output by invoking the `toString` method of each data item. In this case the data items are already strings, but i
n principle `TStream.print` can be called on any stream, regardless of the datatype carried by the stream.``` java public static void main(String[] args) { DirectProvider dp = new DirectProvider(); Topology top = dp.newTopology(); TStream helloStream = top.strings(\"Hello Quarks!\"); helloStream.print(); }```## Submitting the ApplicationThe only remaining step is to submit the application, which is performed by the `DirectProvider`. Submitting a Quarks application initializes the threads which execute the `Topology`, and begins processing its data sources.``` java public static void main(String[] args) { DirectProvider dp = new DirectProvider(); Topology top = dp.newTopology(); TStream helloStream = top.strings(\"Hello Quarks!\"); helloStream.print(); dp.submit(top); }```After running the application, the output is \"Hello Quarks!\":```Hello Quarks!```"
+"body": "Quarks' pure Java implementation is a powerful feature which allows it to be run on the majority of JVM-compatible systems. It also has the added benefit of enabling the developer to develop applications entirely within the Eclipse and Intellij ecosystems. For the purposes of this recipe, it will be assumed that the developer is using Eclipse. To begin the Hello World recipe, create a new project and import the necessary libraries as outlined in the [getting started guide](quarks-getting-started). Next, write the following template application:``` java public static void main(String[] args) { DirectProvider dp = new DirectProvider(); Topology top = dp.newTopology(); }```The *DirectProvider* is an object which allows the user to submit and run the final application. It also creates the *Topology* object, which gives the developer the ability to define a stream of strings.## Using Topology.stringsThe primary abstraction in Quarks is the `TStream`. A *TStre
am* represents the flow of data in a Quarks application; for example, the periodic floating point readings from a temperature sensor. The data items which are sent through a `TStream` are Java objects -- in the \"Hello Quarks!\" example, we are sending a single java.lang.String. There are a number of ways to create a `TStream`, and `Topology.strings` is the simplest. The user specifies a number of strings which will be used as the stream's data items.``` java public static void main(String[] args) { DirectProvider dp = new DirectProvider(); Topology top = dp.newTopology(); TStream helloStream = top.strings(\"Hello Quarks!\"); }```The `helloStream` stream is created, and the \"Hello Quarks!\" string will be sent as its single data item.## Printing to Output`TStream.print` can be used to print the data items of a stream to standard output by invoking the `toString` method of each data item. In this case the data items are already strings, but in principle `T
Stream.print` can be called on any stream, regardless of the datatype carried by the stream.``` java public static void main(String[] args) { DirectProvider dp = new DirectProvider(); Topology top = dp.newTopology(); TStream helloStream = top.strings(\"Hello Quarks!\"); helloStream.print(); }```## Submitting the ApplicationThe only remaining step is to submit the application, which is performed by the `DirectProvider`. Submitting a Quarks application initializes the threads which execute the `Topology`, and begins processing its data sources.``` java public static void main(String[] args) { DirectProvider dp = new DirectProvider(); Topology top = dp.newTopology(); TStream helloStream = top.strings(\"Hello Quarks!\"); helloStream.print(); dp.submit(top); }```After running the application, the output is \"Hello Quarks!\":```Hello Quarks!```"
},
http://git-wip-us.apache.org/repos/asf/incubator-quarks-website/blob/93a69c3b/content/docs/quarks_index.html
----------------------------------------------------------------------
diff --git a/content/docs/quarks_index.html b/content/docs/quarks_index.html
index c1e65b8..2c82a76 100644
--- a/content/docs/quarks_index.html
+++ b/content/docs/quarks_index.html
@@ -6,7 +6,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta name="description" content="">
<meta name="keywords" content=" ">
-<title>Quarks Documentation | Quarks Documentation</title>
+<title>Apache Quarks Documentation | Quarks Documentation</title>
<link rel="stylesheet" type="text/css" href="../css/syntax.css">
<link rel="stylesheet" type="text/css" href="../css/font-awesome.min.css">
<!--<link rel="stylesheet" type="text/css" href="../css/bootstrap.min.css">-->
@@ -157,7 +157,7 @@
<script>
function SendLinkByMail(href) {
var subject= "Quarks Documentation feedback";
-var body = "I have some feedback about the Quarks Documentation page: ";
+var body = "I have some feedback about the Apache Quarks Documentation page: ";
body += window.location.href;
body += "";
var uri = "mailto:?subject=";
@@ -184,7 +184,7 @@ window.location.href = uri;
searchInput: document.getElementById('search-input'),
resultsContainer: document.getElementById('results-container'),
dataSource: '../search.json',
- searchResultTemplate: '<li><a href="{url}" title="Quarks Documentation">{title}</a></li>',
+ searchResultTemplate: '<li><a href="{url}" title="Apache Quarks Documentation">{title}</a></li>',
noResultsText: 'No results found.',
limit: 10,
fuzzy: true,
@@ -453,7 +453,7 @@ $('#toc').on('click', 'a', function() {
<div class="col-md-9">
<div class="post-header">
- <h1 class="post-title-main">Quarks Documentation</h1>
+ <h1 class="post-title-main">Apache Quarks Documentation</h1>
</div>
<div class="post-content">
@@ -489,7 +489,7 @@ $('#toc').on('click', 'a', function() {
<h2 id="new-documentation">New Documentation</h2>
-<p>Quarks is evolving, and so is the documentation. If the existing documentation hasn't answered your questions, you can request new or updated documentation by opening an issue.</p>
+<p>Apache Quarks is evolving, and so is the documentation. If the existing documentation hasn't answered your questions, you can request new or updated documentation by opening an issue.</p>
<p>Click on "New Documentation" to open an issue:</p>
http://git-wip-us.apache.org/repos/asf/incubator-quarks-website/blob/93a69c3b/content/docs/quickstart.html
----------------------------------------------------------------------
diff --git a/content/docs/quickstart.html b/content/docs/quickstart.html
index 196cf58..5ef1f3a 100644
--- a/content/docs/quickstart.html
+++ b/content/docs/quickstart.html
@@ -516,7 +516,7 @@ to the Quickstart Bluemix service.</p>
<h2 id="quarks-code">Quarks Code</h2>
<p>The full source is at:
-https://github.com/quarks-edge/quarks/blob/master/samples/connectors/src/main/java/quarks/samples/connectors/iotf/IotfQuickstart.java</p>
+<a href="https://github.com/quarks-edge/quarks/blob/master/samples/connectors/src/main/java/quarks/samples/connectors/iotf/IotfQuickstart.java">IotfQuickstart.java</a></p>
<p>The first step to is to create a <code>IotDevice</code> instance that represents the connection to IBM Watson IoT Platform Qucikstart service.</p>
<div class="highlight"><pre><code class="language-java" data-lang="java"> <span class="c1">// Declare a connection to IoTF Quickstart service</span>
http://git-wip-us.apache.org/repos/asf/incubator-quarks-website/blob/93a69c3b/content/recipes/recipe_hello_quarks.html
----------------------------------------------------------------------
diff --git a/content/recipes/recipe_hello_quarks.html b/content/recipes/recipe_hello_quarks.html
index 39b69cf..28ca794 100644
--- a/content/recipes/recipe_hello_quarks.html
+++ b/content/recipes/recipe_hello_quarks.html
@@ -487,7 +487,7 @@ $('#toc').on('click', 'a', function() {
<a target="_blank" href="https://github.com/apache/incubator-quarks-website/blob/master/site/recipes/recipe_hello_quarks.md" class="btn btn-default githubEditButton" role="button"><i class="fa fa-github fa-lg"></i> Edit me</a>
- <p>Quarks' pure Java implementation is a powerful feature which allows it to be run on the majority of JVM-compatible systems. It also has the added benefit of enabling the developer to develop applications entirely within the Eclipse and Intellij ecosystems. For the purposes of this (and future) recipes, it will be assumed that the developer is using Eclipse. To begin the Hello World recipe, create a new project and import the necessary libraries as outlined in the <a href="quarks-getting-started">getting started guide</a>. Next, write the following template application:</p>
+ <p>Quarks' pure Java implementation is a powerful feature which allows it to be run on the majority of JVM-compatible systems. It also has the added benefit of enabling the developer to develop applications entirely within the Eclipse and Intellij ecosystems. For the purposes of this recipe, it will be assumed that the developer is using Eclipse. To begin the Hello World recipe, create a new project and import the necessary libraries as outlined in the <a href="quarks-getting-started">getting started guide</a>. Next, write the following template application:</p>
<div class="highlight"><pre><code class="language-java" data-lang="java"> <span class="kd">public</span> <span class="kd">static</span> <span class="kt">void</span> <span class="nf">main</span><span class="p">(</span><span class="n">String</span><span class="o">[]</span> <span class="n">args</span><span class="o">)</span> <span class="o">{</span>
<span class="n">DirectProvider</span> <span class="n">dp</span> <span class="o">=</span> <span class="k">new</span> <span class="n">DirectProvider</span><span class="o">();</span>
<span class="n">Topology</span> <span class="n">top</span> <span class="o">=</span> <span class="n">dp</span><span class="o">.</span><span class="na">newTopology</span><span class="o">();</span>
http://git-wip-us.apache.org/repos/asf/incubator-quarks-website/blob/93a69c3b/content/search.json
----------------------------------------------------------------------
diff --git a/content/search.json b/content/search.json
index a415c3b..73d26c8 100644
--- a/content/search.json
+++ b/content/search.json
@@ -121,7 +121,7 @@
{
-"title": "Quarks Documentation",
+"title": "Apache Quarks Documentation",
"tags": "",
"keywords": "",
"url": "../docs/quarks_index",