fluo-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From ktur...@apache.org
Subject [2/5] incubator-fluo-website git commit: Updated design of Fluo tour
Date Mon, 10 Oct 2016 19:13:28 GMT
Updated design of Fluo tour

* Created template for Fluo tour pages that enables paging
* Updated current tour pages to use template
* Created tour index
* Referenced tour from homepage and documentation


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

Branch: refs/heads/gh-pages
Commit: b8786f3170564680eff870fab82ec71fe13dc233
Parents: 9b36d6f
Author: Mike Walch <mwalch@gmail.com>
Authored: Wed Jul 27 12:34:40 2016 -0400
Committer: Keith Turner <kturner@apache.org>
Committed: Wed Sep 28 18:10:34 2016 -0400

----------------------------------------------------------------------
 _config.yml                  |  9 ++++++++
 _layouts/tour.html           | 25 ++++++++++++++++++++++
 docs/index.md                |  3 ++-
 index.html                   |  2 +-
 tour/architecture.md         |  7 +++++++
 tour/basic-read-write.md     | 44 +++++++++++++++++++++++++++++++++++++++
 tour/data-model.md           | 28 +++++++++++++++++++++++++
 tour/index.md                | 13 ++++++++++++
 tour/pg1-data-model.md       | 25 ----------------------
 tour/pg2-architechture.md    |  4 ----
 tour/pg3-writing-code.md     |  9 --------
 tour/pg4-basic-read-write.md | 41 ------------------------------------
 tour/writing-code.md         | 12 +++++++++++
 13 files changed, 141 insertions(+), 81 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-fluo-website/blob/b8786f31/_config.yml
----------------------------------------------------------------------
diff --git a/_config.yml b/_config.yml
index 4028241..148eca9 100644
--- a/_config.yml
+++ b/_config.yml
@@ -35,6 +35,12 @@ defaults:
       layout: "release-summary"
       category: "release-summaries"
       permalink: "/:categories/:title/"
+  - 
+    scope:
+      path: "tour"
+      type: "pages"
+    values:
+      layout: "tour"
 
 # Number of posts displayed on the home page.
 num_home_posts: 5
@@ -48,6 +54,9 @@ latest_fluo_release_date: "January 12, 2016"
 latest_recipes_release: "1.0.0-beta-2"
 latest_recipes_release_date: "March 29, 2016"
 
+# Fluo tour settings
+tour_pages: 4
+
 whitelist: [jekyll-redirect-from]
 gems: [jekyll-redirect-from]
 

http://git-wip-us.apache.org/repos/asf/incubator-fluo-website/blob/b8786f31/_layouts/tour.html
----------------------------------------------------------------------
diff --git a/_layouts/tour.html b/_layouts/tour.html
new file mode 100644
index 0000000..061e0fe
--- /dev/null
+++ b/_layouts/tour.html
@@ -0,0 +1,25 @@
+---
+layout: default
+---
+<div id="tour-header">
+  <h2><a href="/tour/">Fluo Tour</a>: {{ page.title }}</h2>
+  <p class="text-muted">Tour page {{ page.tour_num }} of {{ site.tour_pages }}</p>
+</div>
+<div id="tour-content">
+  {{ content }}
+</div>
+
+<div>
+  {% assign prev = page.tour_num | minus: 1 %}
+  {% assign next = page.tour_num | plus: 1 %}
+  <h2> 
+    {% if prev > 0 %}
+    <a href="/tour/{{ prev }}/">&lt;</a> 
+    {% endif %}
+
+    {{ page.tour_num }} / {{ site.tour_pages }} 
+    {% if next <= site.tour_pages %}
+    <a href="/tour/{{ next }}/">&gt;</a> 
+    {% endif %}
+  </h2>
+</div>

http://git-wip-us.apache.org/repos/asf/incubator-fluo-website/blob/b8786f31/docs/index.md
----------------------------------------------------------------------
diff --git a/docs/index.md b/docs/index.md
index 3017ef1..5d2de88 100644
--- a/docs/index.md
+++ b/docs/index.md
@@ -3,6 +3,8 @@ layout: page
 title: Documentation
 ---
 
+For a general overview of Fluo, take the [Fluo tour](/tour/).
+
 [Apache Fluo] and [Apache Fluo Recipes] have seperate documentation as they are different
repositories with their own release cycle.
 
 ## Apache Fluo
@@ -19,4 +21,3 @@ Documentation about releases made before Apache Fluo entered incubation
at Apach
 
 [Apache Fluo]: https://github.com/apache/fluo
 [Apache Fluo Recipes]: https://github.com/apache/fluo-recipes
-

http://git-wip-us.apache.org/repos/asf/incubator-fluo-website/blob/b8786f31/index.html
----------------------------------------------------------------------
diff --git a/index.html b/index.html
index 9688cb4..f8e8ae4 100644
--- a/index.html
+++ b/index.html
@@ -10,7 +10,7 @@ html_title_override: true
       </div>
       <h2 style="padding-top: 0px">Overview</h2>
       <p>Apache Fluo (incubating) is an open source implementation of <a href="https://research.google.com/pubs/pub36726.html"
target="_blank">Percolator</a> 
-         (which populates Google's search index) for <a href="https://accumulo.apache.org/"
target="_blank">Apache Accumulo</a>. Fluo makes it possible to update the results
of a large-scale computation, index, or analytic as new data is discovered.</p>
+         (which populates Google's search index) for <a href="https://accumulo.apache.org/"
target="_blank">Apache Accumulo</a>. Fluo makes it possible to update the results
of a large-scale computation, index, or analytic as new data is discovered. For more information,
take the <a href="{{ site.baseurl }}/tour/">Fluo tour</a>.</p>
     </div>
     <div class="col-sm-4">
       <div class="row">

http://git-wip-us.apache.org/repos/asf/incubator-fluo-website/blob/b8786f31/tour/architecture.md
----------------------------------------------------------------------
diff --git a/tour/architecture.md b/tour/architecture.md
new file mode 100644
index 0000000..bba8446
--- /dev/null
+++ b/tour/architecture.md
@@ -0,0 +1,7 @@
+---
+title: Architecture
+tour_num: 2
+permalink: /tour/2/
+---
+
+TODO picture

http://git-wip-us.apache.org/repos/asf/incubator-fluo-website/blob/b8786f31/tour/basic-read-write.md
----------------------------------------------------------------------
diff --git a/tour/basic-read-write.md b/tour/basic-read-write.md
new file mode 100644
index 0000000..a58f13b
--- /dev/null
+++ b/tour/basic-read-write.md
@@ -0,0 +1,44 @@
+---
+title: Read and Write Data
+tour_num: 4
+permalink: /tour/4/
+---
+
+The following example shows basic code for writing data using Fluo and then
+reading it back out.  To run this code modify `src/main/java/ft/Main.java` in
+[Fluo Tour git repository][1] and run it following the instructions on the
+repository.
+
+
+```java
+  private static void excercise(MiniFluo mini, FluoClient client) {
+    String row = "kerbalnaut0001";
+    Column fName = new Column("name", "first");
+    Column lName = new Column("name", "last");
+
+    try (Transaction tx = client.newTransaction()) {
+      tx.set(row, fName, "Jebediah");
+      tx.set(row, lName, "Kerman");
+      tx.commit();
+    }
+
+    try (Snapshot snaphot = client.newSnapshot()) {
+      System.out.println("First name : " + snaphot.gets(row, fName));
+      System.out.println("Last name  : " + snaphot.gets(row, lName));
+    }
+  }
+```
+
+In the example above a Transaction is created in a try with resources block.  A
+Transaction can read and write data.  It can only read data that was committed
+before it started.  Data set on a transaction will only be written when
+`commit()` is called.
+  
+A Snapshot is created to read the data previously written by the Transaction.
+Snapshots only allow reading data that was commited before the snapshot was
+created.  The code calls `gets()` which is a convience method that returns a
+Java string.  Internally Fluo only deals with bytes and its `get()` method
+returns bytes.   The Fluo methods that take and return Strings assume UTF-8
+encoding when converting to bytes.
+
+[1]:https://github.com/keith-turner/fluo-tour

http://git-wip-us.apache.org/repos/asf/incubator-fluo-website/blob/b8786f31/tour/data-model.md
----------------------------------------------------------------------
diff --git a/tour/data-model.md b/tour/data-model.md
new file mode 100644
index 0000000..f0d1f6a
--- /dev/null
+++ b/tour/data-model.md
@@ -0,0 +1,28 @@
+---
+title: Data Model
+tour_num: 1
+permalink: /tour/1/
+---
+
+Fluo uses Accumulo's data model which is based on the BigTable data model.
+This data model supports a large online sorted map that spans multiple nodes in
+a cluster.   The keys in this map have four components : row, column family,
+column qualifier, and column visibility.
+
+ * **Row** : This portion of the key is used to partition data across nodes in
+   a cluster.  All data in a row is guaranteed to be stored on single node in
+   the cluster.  Different rows may be stored on different nodes.  Fluo
+   supports cross row transactions, which mean cross node transactions.
+ * **Column family** :  This portion of the key is used to partition data
+   within each node on the cluster.  The data model has locality groups which
+   store column families in physically separate partitions on each node.  If
+   locality groups are configured, then it allows scanning a subset of rows column
+   families much more quickly. 
+ * **Column Qualifier** : This portion of the key is used to define arbitrary
+   columns with a column family.
+ * **Column Visibility** : In Accumulo this portion of the key is used to
+   control access to data.
+
+This data model is schema-less, there is no need to predefine columns.  One
+thing thats defined in the Accumulo data modes thats not available in Fluo is
+timestamps.  When using Fluo the timestamp portion of the key is not available.

http://git-wip-us.apache.org/repos/asf/incubator-fluo-website/blob/b8786f31/tour/index.md
----------------------------------------------------------------------
diff --git a/tour/index.md b/tour/index.md
new file mode 100644
index 0000000..dbd1a26
--- /dev/null
+++ b/tour/index.md
@@ -0,0 +1,13 @@
+---
+layout: page
+title: Fluo Tour
+---
+
+Welcome to the Fluo tour! The tour starts by introducing Fluo's [Data Model](/tour/1/).
+
+We recommend following the tour in order. However, all pages are listed below for review.
+
+1. [Data Model](/tour/1/)
+2. [Architecture](/tour/2/)
+3. [Writing Code](/tour/3/)
+4. [Basic Read Write](/tour/4/)

http://git-wip-us.apache.org/repos/asf/incubator-fluo-website/blob/b8786f31/tour/pg1-data-model.md
----------------------------------------------------------------------
diff --git a/tour/pg1-data-model.md b/tour/pg1-data-model.md
deleted file mode 100644
index 0785caf..0000000
--- a/tour/pg1-data-model.md
+++ /dev/null
@@ -1,25 +0,0 @@
-Fluo Data Model
----------------
-
-Fluo uses Accumulo's data model which is based on the BigTable data model.
-This data model supports a large online sorted map that spans multiple nodes in
-a cluster.   The keys in this map have four components : row, column family,
-column qualifier, and column visibility.
-
- * **Row** : This portion of the key is used to partition data across nodes in
-   a cluster.  All data in a row is guaranteed to be stored on single node in
-   the cluster.  Different rows may be stored on different nodes.  Fluo
-   supports cross row transactions, which mean cross node transactions.
- * **Column family** :  This portion of the key is used to partition data
-   within each node on the cluster.  The data model has locality groups which
-   store column families in physically separate partitions on each node.  If
-   locality groups are configured, then it allows scanning a subset of rows column
-   families much more quickly. 
- * **Column Qualifier** : This portion of the key is used to define arbitrary
-   columns with a column family.
- * **Column Visibility** : In Accumulo this portion of the key is used to
-   control access to data.
-
-This data model is schema-less, there is no need to predefine columns.  One
-thing thats defined in the Accumulo data modes thats not available in Fluo is
-timestamps.  When using Fluo the timestamp portion of the key is not available.

http://git-wip-us.apache.org/repos/asf/incubator-fluo-website/blob/b8786f31/tour/pg2-architechture.md
----------------------------------------------------------------------
diff --git a/tour/pg2-architechture.md b/tour/pg2-architechture.md
deleted file mode 100644
index dac8e9d..0000000
--- a/tour/pg2-architechture.md
+++ /dev/null
@@ -1,4 +0,0 @@
-Fluo Architechture
-------------------
-
-TODO picture

http://git-wip-us.apache.org/repos/asf/incubator-fluo-website/blob/b8786f31/tour/pg3-writing-code.md
----------------------------------------------------------------------
diff --git a/tour/pg3-writing-code.md b/tour/pg3-writing-code.md
deleted file mode 100644
index f0b8ddb..0000000
--- a/tour/pg3-writing-code.md
+++ /dev/null
@@ -1,9 +0,0 @@
-Writing and Running Fluo Code
------------------------------
-
-Following the Fluo tour will require writing code that uses Fluo's API.  In
-order to enable you to get quickly started writing Fluo code we have provided a
-git repository with a basic skeleton. Before continuing with the tour, please
-read about the [Fluo Tour git repository][1] and set it up locally.
-
-[1]:https://github.com/keith-turner/fluo-tour

http://git-wip-us.apache.org/repos/asf/incubator-fluo-website/blob/b8786f31/tour/pg4-basic-read-write.md
----------------------------------------------------------------------
diff --git a/tour/pg4-basic-read-write.md b/tour/pg4-basic-read-write.md
deleted file mode 100644
index 84ca914..0000000
--- a/tour/pg4-basic-read-write.md
+++ /dev/null
@@ -1,41 +0,0 @@
-Read and Write Data
--------------------
-
-The following example shows basic code for writing data using Fluo and then
-reading it back out.  To run this code modify `src/main/java/ft/Main.java` in
-[Fluo Tour git repository][1] and run it following the instructions on the
-repository.
-
-
-```java
-  private static void excercise(MiniFluo mini, FluoClient client) {
-    String row = "kerbalnaut0001";
-    Column fName = new Column("name", "first");
-    Column lName = new Column("name", "last");
-
-    try (Transaction tx = client.newTransaction()) {
-      tx.set(row, fName, "Jebediah");
-      tx.set(row, lName, "Kerman");
-      tx.commit();
-    }
-
-    try (Snapshot snaphot = client.newSnapshot()) {
-      System.out.println("First name : " + snaphot.gets(row, fName));
-      System.out.println("Last name  : " + snaphot.gets(row, lName));
-    }
-  }
-```
-
-In the example above a Transaction is created in a try with resources block.  A
-Transaction can read and write data.  It can only read data that was committed
-before it started.  Data set on a transaction will only be written when
-`commit()` is called.
-  
-A Snapshot is created to read the data previously written by the Transaction.
-Snapshots only allow reading data that was commited before the snapshot was
-created.  The code calls `gets()` which is a convience method that returns a
-Java string.  Internally Fluo only deals with bytes and its `get()` method
-returns bytes.   The Fluo methods that take and return Strings assume UTF-8
-encoding when converting to bytes.
-
-[1]:https://github.com/keith-turner/fluo-tour

http://git-wip-us.apache.org/repos/asf/incubator-fluo-website/blob/b8786f31/tour/writing-code.md
----------------------------------------------------------------------
diff --git a/tour/writing-code.md b/tour/writing-code.md
new file mode 100644
index 0000000..5a4691a
--- /dev/null
+++ b/tour/writing-code.md
@@ -0,0 +1,12 @@
+---
+title: Writing and Running Fluo code
+tour_num: 3
+permalink: /tour/3/
+---
+
+Following the Fluo tour will require writing code that uses Fluo's API.  In
+order to enable you to get quickly started writing Fluo code we have provided a
+git repository with a basic skeleton. Before continuing with the tour, please
+read about the [Fluo Tour git repository][1] and set it up locally.
+
+[1]:https://github.com/keith-turner/fluo-tour


Mime
View raw message