accumulo-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From mwa...@apache.org
Subject [accumulo-website] branch tour-website updated: ACCUMULO-4734 Created basic tour structure on website (#32)
Date Thu, 02 Nov 2017 21:05:35 GMT
This is an automated email from the ASF dual-hosted git repository.

mwalch pushed a commit to branch tour-website
in repository https://gitbox.apache.org/repos/asf/accumulo-website.git


The following commit(s) were added to refs/heads/tour-website by this push:
     new 722c9d5  ACCUMULO-4734 Created basic tour structure on website (#32)
722c9d5 is described below

commit 722c9d52aed82143a62345f3d084fb1b00b1ded5
Author: Mike Walch <mwalch@apache.org>
AuthorDate: Thu Nov 2 17:05:31 2017 -0400

    ACCUMULO-4734 Created basic tour structure on website (#32)
    
    * Content still needs to be created
---
 _config.yml                |  7 ++++++
 _data/tour.yml             |  6 +++++
 _includes/nav.html         |  1 +
 _layouts/tour.html         | 55 ++++++++++++++++++++++++++++++++++++++++++++++
 index.html                 |  6 +----
 tour/basic-read-write.md   |  5 +++++
 tour/batch-scanner.md      |  3 +++
 tour/conditional-writer.md |  3 +++
 tour/getting-started.md    |  5 +++++
 tour/index.md              | 29 ++++++++++++++++++++++++
 tour/using-iterators.md    |  3 +++
 11 files changed, 118 insertions(+), 5 deletions(-)

diff --git a/_config.yml b/_config.yml
index bcad220..3ad02d8 100644
--- a/_config.yml
+++ b/_config.yml
@@ -51,6 +51,13 @@ defaults:
       permalink: "/:categories/:title/"
   -
     scope:
+      path: "tour"
+      type: "pages"
+    values:
+      layout: "tour"
+      permalink: "/tour/:basename/"
+  -
+    scope:
       path: ""
       type: "docs-2-0"
     values:
diff --git a/_data/tour.yml b/_data/tour.yml
new file mode 100644
index 0000000..d84b5bb
--- /dev/null
+++ b/_data/tour.yml
@@ -0,0 +1,6 @@
+docs:
+ - getting-started
+ - basic-read-write
+ - batch-scanner
+ - conditional-writer
+ - using-iterators
diff --git a/_includes/nav.html b/_includes/nav.html
index 295d2e6..7413858 100644
--- a/_includes/nav.html
+++ b/_includes/nav.html
@@ -13,6 +13,7 @@
     <div class="collapse navbar-collapse" id="navbar-items">
       <ul class="nav navbar-nav">
         <li class="nav-link"><a href="{{ site.baseurl }}/downloads">Download</a></li>
+        <li class="nav-link"><a href="{{ site.baseurl }}/tour">Tour</a></li>
         <li class="dropdown">
           <a class="dropdown-toggle" data-toggle="dropdown" href="#">Releases<span
class="caret"></span></a>
           <ul class="dropdown-menu">
diff --git a/_layouts/tour.html b/_layouts/tour.html
new file mode 100644
index 0000000..eee83cb
--- /dev/null
+++ b/_layouts/tour.html
@@ -0,0 +1,55 @@
+---
+layout: default
+---
+{% assign tour_pages = site.data.tour.docs %}
+{% for p in tour_pages %}
+  {% assign doc_url = p | prepend: '/tour/' | append: '/' %}
+  {% if doc_url == page.url %}
+    {% assign tour_num = forloop.index %}
+    {% if forloop.first %}
+      {% assign previous = -1 %}
+    {% else %}
+      {% assign previous = forloop.index0 | minus: 1 %}
+      {% assign previous_page = tour_pages[previous] | prepend:"/tour/" | append:"/" %}
+    {% endif %}
+    {% if forloop.last %}
+      {% assign next = 0 %}
+    {% else %}
+      {% assign next = forloop.index0 | plus: 1 %}
+      {% assign next_page = tour_pages[next] | prepend:"/tour/" | append:"/" %}
+    {% endif %}
+  {% endif %}
+{% endfor %}
+
+<div id="tour-header">
+  <h2><a href="/tour/">Accumulo Tour</a>: {{ page.title }}</h2>
+  <p class="text-muted">Tour page {{ tour_num }} of {{ tour_pages.size }}</p>
+</div>
+<div id="tour-content">
+  {{ content }}
+</div>
+
+<script>
+document.body.onkeyup = function(e){
+{% if previous >= 0 %}
+if (e.keyCode == '37') { window.location = '{{previous_page}}'; }
+{% endif %}
+
+{% if next > 0 %}
+if (e.keyCode == '39') { window.location = '{{next_page}}'; }
+{% endif %}
+};
+</script>
+
+<div class="text-center">
+  <h2>
+    {% if previous >= 0 %}
+    <a href="{{ previous_page }}">&lt;</a>
+    {% endif %}
+
+    {{ tour_num }} / {{ tour_pages.size }}
+    {% if next > 0 %}
+    <a href="{{ next_page }}">&gt;</a>
+    {% endif %}
+  </h2>
+</div>
diff --git a/index.html b/index.html
index 2777df1..6713e2e 100644
--- a/index.html
+++ b/index.html
@@ -10,6 +10,7 @@ legal_notice: Apache Accumulo, Apache Hadoop, and the Accumulo project logo
are
       <a class="btn btn-success" href="downloads/" role="button"><i class="fa fa-download
fa-lg"></i> Download</a>
     </div>
     <p id="home-description">Apache Accumulo is a key/value store based on the design
of Google's <a href="https://research.google.com/archive/bigtable.html">BigTable</a>.
Accumulo stores its data in <a href="https://hadoop.apache.org">Apache Hadoop</a>'s
HDFS and uses <a href="https://zookeeper.apache.org">Apache Zookeeper</a> for
consensus. While many users interact directly with Accumulo, several <a href="/related-projects">open
source projects</a> use Accumulo as their underlying store.</p>
+    <p id="home-description">To learn more about Accumulo, take the <a href="/tour">Accumulo
tour</a>, read the <a href="/{{ site.latest_minor_release }}/accumulo_user_manual.html">user
manual</a> and run the Accumulo <a href="https://github.com/apache/accumulo-examples">example
code</a>. Also, join our <a href="/mailing_list">mailing list</a> and see
how you can <a href="/get_involved">get involved</a>.
 
     <h3>Major Features</h3>
 
@@ -33,11 +34,6 @@ legal_notice: Apache Accumulo, Apache Hadoop, and the Accumulo project
logo are
         <p>Accumulo has a stable <a href="/latest/apidocs">client API</a>
that follows <a href="https://semver.org">semantic versioning</a>. Each Accumulo
release goes through <a href="/features/#testing">extensive testing</a>.</p>
       </div>
     </div>
-    <div class="row">
-      <div class="col-md-12">  
-        <p id="home-description">To learn more about Accumulo, read the <a href="/{{
site.latest_minor_release }}/accumulo_user_manual.html">user manual</a> and run the
Accumulo <a href="https://github.com/apache/accumulo-examples">example code</a>.
Also, join our <a href="/mailing_list">mailing list</a> and see how you can <a
href="/get_involved">get involved</a>.
-      </div>
-    </div>
   </div>
   <div class="col-md-4" id="sidebar">
     <div class="row">
diff --git a/tour/basic-read-write.md b/tour/basic-read-write.md
new file mode 100644
index 0000000..6eb1c5c
--- /dev/null
+++ b/tour/basic-read-write.md
@@ -0,0 +1,5 @@
+---
+title: Basic Reading & Writing
+---
+
+Talk about reading and writing.
diff --git a/tour/batch-scanner.md b/tour/batch-scanner.md
new file mode 100644
index 0000000..2eb8eb1
--- /dev/null
+++ b/tour/batch-scanner.md
@@ -0,0 +1,3 @@
+---
+title: Batch Scanner
+---
diff --git a/tour/conditional-writer.md b/tour/conditional-writer.md
new file mode 100644
index 0000000..83d468c
--- /dev/null
+++ b/tour/conditional-writer.md
@@ -0,0 +1,3 @@
+---
+title: Conditional Writer
+---
diff --git a/tour/getting-started.md b/tour/getting-started.md
new file mode 100644
index 0000000..0b076c1
--- /dev/null
+++ b/tour/getting-started.md
@@ -0,0 +1,5 @@
+---
+title: Getting Started
+---
+
+Talk about how to get started.
diff --git a/tour/index.md b/tour/index.md
new file mode 100644
index 0000000..9217637
--- /dev/null
+++ b/tour/index.md
@@ -0,0 +1,29 @@
+---
+title: Accumulo Tour
+layout: page
+permalink: /tour/
+skiph1fortitle: true
+---
+
+{% assign tour_pages = site.data.tour.docs %}
+{% assign first_url = tour_pages[0] | prepend: '/tour/' | append: '/' %}
+{% assign first_page = site.pages | where:'url',first_url | first %}
+
+Welcome to the Accumulo tour! The tour offers a hands on introduction to Accumulo, broken
down into
+independent steps and an exercise. The exercise gives you a chance to apply what you have
learned.
+The tour starts with a [{{ first_page.title }}]({{ first_url }}) page that will help you
set up
+the exercise on your machine.
+
+We recommend following the tour in order. However, all pages are listed below for review.
 When on a
+tour page, the left and right keys on the keyboard can be used to navigate. If you have any
questions
+or suggestions while going through the tour, please send an email to our [mailing list][mlist]
+or [create an issue][issue].
+
+{% for p in tour_pages %}
+  {% assign doc_url = p | prepend: '/tour/' | append: '/' %}
+  {% assign link_to_page = site.pages | where:'url',doc_url | first %}
+  1. [{{ link_to_page.title }}]({{ doc_url }})
+{% endfor %}
+
+[mlist]: /mailing_list/
+[issue]: https://issues.apache.org/jira/projects/ACCUMULO
diff --git a/tour/using-iterators.md b/tour/using-iterators.md
new file mode 100644
index 0000000..7ae8ceb
--- /dev/null
+++ b/tour/using-iterators.md
@@ -0,0 +1,3 @@
+---
+title: Using Iterators
+---

-- 
To stop receiving notification emails like this one, please contact
['"commits@accumulo.apache.org" <commits@accumulo.apache.org>'].

Mime
View raw message