You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@quickstep.apache.org by sp...@apache.org on 2016/12/13 16:12:25 UTC

[7/9] incubator-quickstep-site git commit: tweaking theme plus first post

tweaking theme plus first post


Project: http://git-wip-us.apache.org/repos/asf/incubator-quickstep-site/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-quickstep-site/commit/5958d028
Tree: http://git-wip-us.apache.org/repos/asf/incubator-quickstep-site/tree/5958d028
Diff: http://git-wip-us.apache.org/repos/asf/incubator-quickstep-site/diff/5958d028

Branch: refs/heads/asf-site
Commit: 5958d0280b2739225734213158f7167ff1734528
Parents: 3e7c96b
Author: Marc Spehlmann <ma...@gmail.com>
Authored: Sat Dec 10 23:14:23 2016 -0600
Committer: Marc Spehlmann <ma...@gmail.com>
Committed: Tue Dec 13 09:57:10 2016 -0600

----------------------------------------------------------------------
 .gitignore                                   |   4 ++
 _config.yml                                  |   6 +--
 _data/authors.yml                            |   4 ++
 _drafts/2016-12-10-example.markdown          |  28 ++++++++++
 _layouts/home.html                           |  29 ++++++++--
 _layouts/post.html                           |  18 +++++++
 _posts/.DS_Store                             | Bin 0 -> 6148 bytes
 _posts/2016-12-10-December-Progress.markdown |  27 ----------
 _posts/2016-12-10-FirstQuery.markdown        |  63 ++++++++++++++++++++++
 _sass/custom.scss                            |  20 +++++++
 _sass/minima.scss                            |   3 +-
 about.md                                     |   4 +-
 index.md                                     |  24 +++++----
 13 files changed, 182 insertions(+), 48 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-quickstep-site/blob/5958d028/.gitignore
----------------------------------------------------------------------
diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..03c1f51
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1,4 @@
+_site/
+.sass-cache/
+.jekyll-metadata
+.DS_STORE

http://git-wip-us.apache.org/repos/asf/incubator-quickstep-site/blob/5958d028/_config.yml
----------------------------------------------------------------------
diff --git a/_config.yml b/_config.yml
index 61270b8..92d137e 100644
--- a/_config.yml
+++ b/_config.yml
@@ -14,9 +14,9 @@
 title: Quickstep
 email: dev@quickstep.incubator.apache.org
 description: > # this means to ignore newlines until "baseurl:"
-  Quickstep is a next-generation data processing platform. It's an open-source
-  project under apache. Built from to ground up to take advantage of modern
-  hardware, Quickstep is designed for high-performance analytical queries.
+  Apache (incubating) Quickstep is a next-generation data processing platform. 
+  Built from to ground up to take advantage of modern hardware, Quickstep is 
+  designed for high-performance analytical queries.
 baseurl: "" # the subpath of your site, e.g. /blog
 url: "" # the base hostname & protocol for your site, e.g. http://example.com
 github_username:  apache

http://git-wip-us.apache.org/repos/asf/incubator-quickstep-site/blob/5958d028/_data/authors.yml
----------------------------------------------------------------------
diff --git a/_data/authors.yml b/_data/authors.yml
new file mode 100644
index 0000000..b78568a
--- /dev/null
+++ b/_data/authors.yml
@@ -0,0 +1,4 @@
+marc:
+  name: Marc Spehlmann
+  email: spehl.apache@gmail.com
+  web: http://i.imgur.com/AqLvXJh.gifv
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/incubator-quickstep-site/blob/5958d028/_drafts/2016-12-10-example.markdown
----------------------------------------------------------------------
diff --git a/_drafts/2016-12-10-example.markdown b/_drafts/2016-12-10-example.markdown
new file mode 100644
index 0000000..017ab5b
--- /dev/null
+++ b/_drafts/2016-12-10-example.markdown
@@ -0,0 +1,28 @@
+---
+layout: post
+title:  "Quickstep Progress"
+date:   2016-12-10 12:29:09 -0600
+categories: updates
+short: run jekyll with --drafts to view drafts
+---
+You\u2019ll find this post in your `_posts` directory. Go ahead and edit it and re-build the site to see your changes. You can rebuild the site in many different ways, but the most common way is to run `jekyll serve`, which launches a web server and auto-regenerates your site when a file is updated.
+
+To add new posts, simply add a file in the `_posts` directory that follows the convention `YYYY-MM-DD-name-of-post.ext` and includes the necessary front matter. Take a look at the source for this post to get an idea about how it works.
+
+Jekyll also offers powerful support for code snippets:
+
+{% highlight ruby %}
+def print_hi(name)
+  puts "Hi, #{name}"
+end
+print_hi('Tom')
+#=> prints 'Hi, Tom' to STDOUT.
+{% endhighlight %}
+
+______
+
+Check out the [Jekyll docs][jekyll-docs] for more info on how to get the most out of Jekyll. File all bugs/feature requests at [Jekyll\u2019s GitHub repo][jekyll-gh]. If you have questions, you can ask them on [Jekyll Talk][jekyll-talk].
+
+[jekyll-docs]: http://jekyllrb.com/docs/home
+[jekyll-gh]:   https://github.com/jekyll/jekyll
+[jekyll-talk]: https://talk.jekyllrb.com/

http://git-wip-us.apache.org/repos/asf/incubator-quickstep-site/blob/5958d028/_layouts/home.html
----------------------------------------------------------------------
diff --git a/_layouts/home.html b/_layouts/home.html
index 653b21d..ab3d759 100644
--- a/_layouts/home.html
+++ b/_layouts/home.html
@@ -6,23 +6,44 @@ layout: default
   
   {{ content }}
 
-  <h1 class="page-heading">Recent Blog Posts</h1>
+  <hr class="big-margin">
+
+  <h1 class="page-heading center">Recent Blog Posts</h1>
 
   <ul class="post-list">
     {% for post in site.posts %}
+      {% assign author = site.data.authors[post.author] %}
+      
       <li>
         <h2>
           <a class="post-link" href="{{ post.url | relative_url }}">{{ post.title | escape }}</a>
         </h2>
+
+        {% if author %}
+
+        <span class="post-meta">{{ post.date | date: "%b %-d, %Y" }} | {{ author.name }}</span>
+
+        {% else %}
+
         <span class="post-meta">{{ post.date | date: "%b %-d, %Y" }}</span>
+
+        {% endif %}
+
+        <div>
+          {{ post.short }}
+        </div>
       </li>
     {% endfor %}
   </ul>
 
   <!-- <p class="rss-subscribe">subscribe <a href="{{ "/feed.xml" | relative_url }}">via RSS</a></p> -->
 
-<hr>
-<h3>Disclaimer</h3>
-<small>Apache Quickstep is an effort undergoing incubation at The Apache Software Foundation (ASF), sponsored by the Apache Incubator. Incubation is required of all newly accepted projects until a further review indicates that the infrastructure, communications, and decision making process have stabilized in a manner consistent with other successful ASF projects. While incubation status is not necessarily a reflection of the completeness or stability of the code, it does indicate that the project has yet to be fully endorsed by the ASF.</small>
+  <hr class="big-margin">
 
+  <div class="disclaimer">
+  <h1>Disclaimer</h1>
+  <small>
+    Apache Quickstep is an effort undergoing incubation at The Apache Software Foundation (ASF), sponsored by the Apache Incubator. Incubation is required of all newly accepted projects until a further review indicates that the infrastructure, communications, and decision making process have stabilized in a manner consistent with other successful ASF projects. While incubation status is not necessarily a reflection of the completeness or stability of the code, it does indicate that the project has yet to be fully endorsed by the ASF.
+  </small>
+  </div>
 </div>

http://git-wip-us.apache.org/repos/asf/incubator-quickstep-site/blob/5958d028/_layouts/post.html
----------------------------------------------------------------------
diff --git a/_layouts/post.html b/_layouts/post.html
new file mode 100644
index 0000000..1d36c28
--- /dev/null
+++ b/_layouts/post.html
@@ -0,0 +1,18 @@
+---
+layout: default
+---
+<article class="post" itemscope itemtype="http://schema.org/BlogPosting">
+
+  <header class="post-header">
+    <h1 class="post-title" itemprop="name headline">{{ page.title | escape }}</h1>
+    <p class="post-meta"><time datetime="{{ page.date | date_to_xmlschema }}" itemprop="datePublished">{{ page.date | date: "%b %-d, %Y" }}</time>{% if page.author %} \u2022 <span itemprop="author" itemscope itemtype="http://schema.org/Person"><span itemprop="name">{{ page.author }}</span></span>{% endif %}</p>
+  </header>
+
+  <div class="post-content" itemprop="articleBody">
+    {{ content }}
+  </div>
+
+  {% if site.disqus.shortname %}
+    {% include disqus_comments.html %}
+  {% endif %}
+</article>

http://git-wip-us.apache.org/repos/asf/incubator-quickstep-site/blob/5958d028/_posts/.DS_Store
----------------------------------------------------------------------
diff --git a/_posts/.DS_Store b/_posts/.DS_Store
new file mode 100644
index 0000000..4afe657
Binary files /dev/null and b/_posts/.DS_Store differ

http://git-wip-us.apache.org/repos/asf/incubator-quickstep-site/blob/5958d028/_posts/2016-12-10-December-Progress.markdown
----------------------------------------------------------------------
diff --git a/_posts/2016-12-10-December-Progress.markdown b/_posts/2016-12-10-December-Progress.markdown
deleted file mode 100644
index 7023593..0000000
--- a/_posts/2016-12-10-December-Progress.markdown
+++ /dev/null
@@ -1,27 +0,0 @@
----
-layout: post
-title:  "Quickstep Progress"
-date:   2016-12-10 12:29:09 -0600
-categories: updates
----
-You\u2019ll find this post in your `_posts` directory. Go ahead and edit it and re-build the site to see your changes. You can rebuild the site in many different ways, but the most common way is to run `jekyll serve`, which launches a web server and auto-regenerates your site when a file is updated.
-
-To add new posts, simply add a file in the `_posts` directory that follows the convention `YYYY-MM-DD-name-of-post.ext` and includes the necessary front matter. Take a look at the source for this post to get an idea about how it works.
-
-Jekyll also offers powerful support for code snippets:
-
-{% highlight ruby %}
-def print_hi(name)
-  puts "Hi, #{name}"
-end
-print_hi('Tom')
-#=> prints 'Hi, Tom' to STDOUT.
-{% endhighlight %}
-
-______
-
-Check out the [Jekyll docs][jekyll-docs] for more info on how to get the most out of Jekyll. File all bugs/feature requests at [Jekyll\u2019s GitHub repo][jekyll-gh]. If you have questions, you can ask them on [Jekyll Talk][jekyll-talk].
-
-[jekyll-docs]: http://jekyllrb.com/docs/home
-[jekyll-gh]:   https://github.com/jekyll/jekyll
-[jekyll-talk]: https://talk.jekyllrb.com/

http://git-wip-us.apache.org/repos/asf/incubator-quickstep-site/blob/5958d028/_posts/2016-12-10-FirstQuery.markdown
----------------------------------------------------------------------
diff --git a/_posts/2016-12-10-FirstQuery.markdown b/_posts/2016-12-10-FirstQuery.markdown
new file mode 100644
index 0000000..5e68231
--- /dev/null
+++ b/_posts/2016-12-10-FirstQuery.markdown
@@ -0,0 +1,63 @@
+---
+layout: post
+title:  "Your First Query"
+date:   2016-12-10 12:29:09 -0600
+categories: guides
+author: Marc
+short: Building software from source can be tricky, especially if you've never used the project's build tools before. In this post, we'll step through how to get started with Quickstep.
+---
+For this tutorial, I'm going to assume you're running in a unix environment. If you're having trouble building on Windows, try asking the dev community (<de...@quickstep.incubating.apache.org>). 
+
+If you're going to build Quickstep, you'll first need to clone it from Github and initialize the submodules
+
+{% highlight bash %}
+git clone https://github.com/apache/incubator-quickstep.git .
+cd incubator-quickstep
+git submodule init
+git submodule update
+{% endhighlight %}
+
+Next, you'll need to generate Makefiles using CMake, a cross-platform build tool that's popular for building c++ projects. You'll need a version at least as new as **2.8.6**. (You can check with `cmake -v`). If you have a later version, try generating the Makefiles like
+
+{% highlight bash %}
+cd build
+cmake -DCMAKE_BUILD_TYPE=Debug ..
+{% endhighlight %}
+
+Note the weird flag `-DCMAKE_BUILD_TYPE=Debug`. This is telling cmake to use, you guessed it, a debug configuration for the build. This automatically includes flags in the generated Makefiles to include debug symbols and turn on optional checks and log statements in the code. There's tons more flags, but only a few which we commonly use. Mostly I just change the  `CMAKE_CXX_COMPILER` and `CMAKE_C_COMPILER`. These flags control the compiler and I prefer clang++ and clang.
+
+If cmake ran successfully you can now build quickstep. If it didn't run successfully, then don't worry, we're always finding small issues. Like, on one of my linux test machines, I always have to delete lines related to `gflag` in the `third_party/glog/CMakeLists.txt` file because of a misconfiguration on that machine. However, on my mac, cmake runs fine.
+
+If you're having trouble, one solution might be to install some dependencies. If you're running Ubuntu, this might help:
+
+{% highlight bash %}
+sudo apt-get install -y build-essential protobuf-compiler libprotobuf-dev flex bison libnuma-dev
+{% endhighlight %}
+
+If that still doesn't help, email the dev list. Seriously, we're nice.
+
+Assuming you've generated the Makefiles, you can now build quickstep and all of the unit tests. This will run faster if we just build quickstep.
+
+{% highlight bash %}
+# the -j option is how many workers to assign to the compilation
+make -j4 quickstep_cli_shell
+{% endhighlight %}
+
+Once quickstep builds, you should now be able to run your first query. You'll need to tell quickstep where to store its files.
+
+{% highlight bash %}
+./quickstep_cli_shell --initialize_db=true --storage_path=store
+{% endhighlight %}
+
+This will initialize a directory called `store` where quickstep will persist data. If this ran successfully, then you should be seeing the command line prompt. For more information on what flags are available, enter `./quickstep_cli_shell --help`.
+
+Now we can run our first query! Let's create a bunch of records and then aggregate over them.
+
+{% highlight sql %}
+CREATE TABLE my_numbers (i INT, j INT);
+INSERT INTO my_numbers SELECT k % 10, ((k % 1969) * 1337) / 3 FROM generate_series(0, 1000000) AS gs(k);
+SELECT i, AVG(j) FROM my_numbers GROUP BY i;
+{% endhighlight %}
+
+Of course, that query is meaningless but it should give you some idea of the sophistication of the SQL interface.
+

http://git-wip-us.apache.org/repos/asf/incubator-quickstep-site/blob/5958d028/_sass/custom.scss
----------------------------------------------------------------------
diff --git a/_sass/custom.scss b/_sass/custom.scss
new file mode 100644
index 0000000..2581b5d
--- /dev/null
+++ b/_sass/custom.scss
@@ -0,0 +1,20 @@
+.disclaimer {
+  color: $grey-color-dark;
+  font-size: 12px;
+
+  > h1 {
+    text-align: center;
+    color: $grey-color-dark;
+    font-size: 20px;
+    margin: 0 0 0 0;
+  }
+}
+
+.center {
+  text-align: center;
+}
+
+.big-margin {
+  margin-top: 50px;
+  margin-bottom: 50px;
+}
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/incubator-quickstep-site/blob/5958d028/_sass/minima.scss
----------------------------------------------------------------------
diff --git a/_sass/minima.scss b/_sass/minima.scss
index 29b3700..21df28c 100644
--- a/_sass/minima.scss
+++ b/_sass/minima.scss
@@ -39,5 +39,6 @@ $on-laptop:        800px !default;
 @import
   "minima/base",
   "minima/layout",
-  "minima/syntax-highlighting"
+  "minima/syntax-highlighting",
+  "custom"
 ;

http://git-wip-us.apache.org/repos/asf/incubator-quickstep-site/blob/5958d028/about.md
----------------------------------------------------------------------
diff --git a/about.md b/about.md
index 64d5880..a70db8b 100644
--- a/about.md
+++ b/about.md
@@ -3,10 +3,10 @@ layout: page
 title: About
 permalink: /about/
 ---
-## Quickstep (Incubating)
+## Apache (Incubating) Quickstep
 Quickstep is a project starting out of the University of Wisconsin-Madison. It's now an [Apache (incubating) project](https://cwiki.apache.org/confluence/display/QUICKSTEP/Quickstep+Home)!
 
-### UW Team (current)
+### Current UW Team
 
 *   [Harshad Deshmukh](http://pages.cs.wisc.edu/~harshad/)
 *   [Hakan Memisoglu](https://github.com/hakanmemisoglu/)

http://git-wip-us.apache.org/repos/asf/incubator-quickstep-site/blob/5958d028/index.md
----------------------------------------------------------------------
diff --git a/index.md b/index.md
index c3dd0da..8c5a644 100644
--- a/index.md
+++ b/index.md
@@ -3,18 +3,20 @@
 # See: https://jekyllrb.com/docs/themes/#overriding-theme-defaults
 layout: home
 ---
-# Introduction
-Quickstep is a next-generation data processing platform that starts with an underlying relational kernel core. The key design philosophy is to ensure that these kernels - and compositions of these kernels - can exploit the full potential of the underlying hardware. Often this design principle is called running at 'bare-metal' speeds.
+# Apache (incubating) Quickstep Database
 
-The general idea is to build into the DNA of the platform methods that fully exploit the common hardware that is available today,
-including large main memories, fast on-die CPU caches, highly parallel multi-core CPUs, and NVRAM storage technologies.
+Quickstep is a next-generation data processing platform that starts with an underlying relational kernel core. The key design philosophy is to ensure that these kernels - and compositions of these kernels - can exploit the full potential of the underlying hardware. We call this design principle running at bare-metal speed.
 
-For the hardware available in the future, we aim to co-design hardware and software primitives that will allow the data processing
-kernels to work on increasing amounts of data economically - both from the raw performance perspective, and from the perspective of
-the energy consumed by the data processing kernels and the applications running on the platform.
+Bare-metal means to fully exploit the latest hardware trends including large main memories, fast on-die CPU caches, highly parallel multi-core CPUs, and NVRAM storage technologies.
 
-The current roadmap is to produce a platform that can run relational database applications using SQL as the interface. The longer-term roadmap is to cover a broader class of analytics.
+For the hardware available in the future, we aim to co-design hardware and software primitives that will allow the data processing kernels to work on increasing amounts of data economically - both from the raw performance perspective, and from the perspective of the energy consumed by the data processing kernels and the applications running on the platform.
+
+## Getting Started
+Quickstep is easy to get set up. It currently runs on a single node and supports a SQL front-end, and doesn't require tuning parameters. To get started, follow the [quickstart guide](https://github.com/apache/incubator-quickstep/blob/master/README.md).
+
+## Community
+Quickstep is an Apache (incubating) project. If you want to learn more about the community, follow the dev conversation at <de...@quickstep.incubator.apache.org>
 
-# Interested?
-Quickstep currently runs on a single node and supports a SQL front-end. Quickstep aims to deliver high-performance and requires
-no tuning and seamless setup. To get started, follow the [quickstart guide](https://github.com/apache/incubator-quickstep/blob/master/README.md)
+## Roadmap
+
+The current roadmap is to produce a platform that can run relational database applications using SQL as the interface. The longer-term roadmap is to cover a broader class of analytics.