You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@griffin.apache.org by gu...@apache.org on 2018/09/12 11:01:24 UTC
incubator-griffin-site git commit: init
Repository: incubator-griffin-site
Updated Branches:
refs/heads/master 570bb6140 -> 3573064dc
init
Project: http://git-wip-us.apache.org/repos/asf/incubator-griffin-site/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-griffin-site/commit/3573064d
Tree: http://git-wip-us.apache.org/repos/asf/incubator-griffin-site/tree/3573064d
Diff: http://git-wip-us.apache.org/repos/asf/incubator-griffin-site/diff/3573064d
Branch: refs/heads/master
Commit: 3573064dcd462be5fe6d53664cd0c07fc9637ebb
Parents: 570bb61
Author: William Guo <gu...@apache.org>
Authored: Wed Sep 12 19:01:12 2018 +0800
Committer: William Guo <gu...@apache.org>
Committed: Wed Sep 12 19:01:12 2018 +0800
----------------------------------------------------------------------
_includes/footer.html | 44 +++++++
_includes/head.html | 64 ++++++++++
_includes/header.html | 34 +++++
_layouts/default.html | 32 +++++
_layouts/dev.html | 28 +++++
_layouts/doc.html | 31 +++++
_layouts/navpage.html | 34 +++++
_layouts/page.html | 14 +++
_layouts/post.html | 14 +++
_sass/_base.scss | 94 ++++++++++++++
_sass/_layout.scss | 235 +++++++++++++++++++++++++++++++++++
_sass/_syntax-highlighting.scss | 67 ++++++++++
community.md | 19 +++
conf.md | 9 ++
download.md | 8 ++
latest.md | 8 ++
quick-start.md | 132 ++++++++++++++++++++
usecases.md | 8 ++
18 files changed, 875 insertions(+)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-griffin-site/blob/3573064d/_includes/footer.html
----------------------------------------------------------------------
diff --git a/_includes/footer.html b/_includes/footer.html
new file mode 100644
index 0000000..d6ead25
--- /dev/null
+++ b/_includes/footer.html
@@ -0,0 +1,44 @@
+<!--
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements. See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership. The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied. See the License for the
+specific language governing permissions and limitations
+under the License.
+-->
+<!-- footer start -->
+<div class="footerwrapper">
+ <div class="container">
+ <div class="row">
+ <div class="col-md-3">
+ <img src="/images/incubator_feather_egg_logo.png" height="60">
+ </div>
+ <div class="col-md-9">
+ <div style="margin-left:auto; margin-right:auto; text-align:center;font-size:12px;">
+ <div>
+ Apache Griffin is an effort undergoing incubation at The <a href="http://www.apache.org">Apache Software Foundation (ASF)</a>sponsored by the Apache Incubator PMC. 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. Apache Pulsar (incubating) is available under the <a href="https://www.apache.org/licenses">Apache License, version 2.0</a>.
+ </div>
+ </div>
+ </div>
+ </div>
+ <div class="row">
+ <br/>
+ Copyright © 2018 The Apache Software Foundation. All Rights Reserved. Apache, Apache Griffin and the Apache feather logo are trademarks of The Apache Software Foundation.
+ </div>
+ </div>
+</div>
+<!-- footer end -->
+
+<!-- JavaScripts -->
+<script src="https://code.jquery.com/jquery-2.2.4.min.js"></script>
+
http://git-wip-us.apache.org/repos/asf/incubator-griffin-site/blob/3573064d/_includes/head.html
----------------------------------------------------------------------
diff --git a/_includes/head.html b/_includes/head.html
new file mode 100644
index 0000000..d40279a
--- /dev/null
+++ b/_includes/head.html
@@ -0,0 +1,64 @@
+<!--
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements. See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership. The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied. See the License for the
+specific language governing permissions and limitations
+under the License.
+-->
+<head>
+ <meta charset="utf-8">
+ <meta http-equiv="X-UA-Compatible" content="IE=edge">
+
+ <title>{{site.title}} - {% if page.title %}{{ page.title }}{% else %}{{ site.title }}{% endif %}</title>
+ <meta name="description" content="{% if page.excerpt %}{{ page.excerpt | strip_html | strip_newlines | truncate: 160 }}{% else %}{{ site.description }}{% endif %}">
+
+ <meta name="keywords" content="{{site.title}}, Hadoop, Security, Real Time">
+ <meta name="author" content="eBay Inc.">
+
+ <meta charset="utf-8">
+ <meta name="viewport" content="initial-scale=1">
+
+ <link rel="stylesheet" href="{{ "/css/animate.css" | prepend: site.baseurl }}">
+ <link rel="stylesheet" href="{{ "/css/bootstrap.min.css" | prepend: site.baseurl }}">
+
+ <link rel="stylesheet" href="{{ "/css/font-awesome.min.css" | prepend: site.baseurl }}">
+
+ <link rel="stylesheet" href="{{ "/css/misc.css" | prepend: site.baseurl }}">
+ <link rel="stylesheet" href="{{ "/css/style.css" | prepend: site.baseurl }}">
+ <link rel="stylesheet" href="{{ "/css/styles.css" | prepend: site.baseurl }}">
+ <link rel="stylesheet" href="{{ "/css/main.css" | prepend: site.baseurl }}">
+ <link rel="alternate" type="application/rss+xml" title="{{ site.title }}" href="{{ "/feed.xml" | prepend: site.baseurl | prepend: site.url }}" />
+ <link rel="shortcut icon" href="{{ "/images/favicon.ico" | prepend: site.baseurl }}">
+
+ <!-- Baidu Analytics Tracking-->
+ <script>
+ var _hmt = _hmt || [];
+ (function() {
+ var hm = document.createElement("script");
+ hm.src = "//hm.baidu.com/hm.js?fedc55df2ea52777a679192e8f849ece";
+ var s = document.getElementsByTagName("script")[0];
+ s.parentNode.insertBefore(hm, s);
+ })();
+ </script>
+
+ <!-- Google Analytics Tracking -->
+ <script>
+ (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
+ (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
+ m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
+ })(window,document,'script','//www.google-analytics.com/analytics.js','ga');
+ ga('create', 'UA-68929805-1', 'auto');
+ ga('send', 'pageview');
+ </script>
+</head>
http://git-wip-us.apache.org/repos/asf/incubator-griffin-site/blob/3573064d/_includes/header.html
----------------------------------------------------------------------
diff --git a/_includes/header.html b/_includes/header.html
new file mode 100644
index 0000000..4d7cc74
--- /dev/null
+++ b/_includes/header.html
@@ -0,0 +1,34 @@
+<!--
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements. See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership. The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied. See the License for the
+specific language governing permissions and limitations
+under the License.
+-->
+<div class="topbar">
+ <div class="container">
+ <div class="row" >
+ <nav class="navbar navbar-default">
+ <div class="container-fluid">
+ <!-- Brand and toggle get grouped for better mobile display -->
+ <div class="navbar-header">
+ <button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#bs-example-navbar-collapse-1"> <span class="sr-only">Toggle navigation</span> <span class="icon-bar"></span> <span class="icon-bar"></span> <span class="icon-bar"></span> </button>
+ <a class="navbar-brand" href="{{ "/" | prepend: site.baseurl }}"><img src="{{ "/images/logo.png" | prepend: site.baseurl }}" height="44px" style="margin-top:-7px"></a> </div>
+ </div>
+ </div>
+ <!-- /.container-fluid -->
+ </nav>
+ </div>
+ </div>
+ </div>
http://git-wip-us.apache.org/repos/asf/incubator-griffin-site/blob/3573064d/_layouts/default.html
----------------------------------------------------------------------
diff --git a/_layouts/default.html b/_layouts/default.html
new file mode 100644
index 0000000..6107a7a
--- /dev/null
+++ b/_layouts/default.html
@@ -0,0 +1,32 @@
+<!DOCTYPE html>
+<!--
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements. See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership. The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied. See the License for the
+specific language governing permissions and limitations
+under the License.
+-->
+<html>
+
+ {% include head.html %}
+ <body>
+ {% include header.html %}
+ <div class="page-content">
+ <div class="pagewrapper">
+ {{ content }}
+ </div>
+ </div>
+ {% include footer.html %}
+ </body>
+</html>
http://git-wip-us.apache.org/repos/asf/incubator-griffin-site/blob/3573064d/_layouts/dev.html
----------------------------------------------------------------------
diff --git a/_layouts/dev.html b/_layouts/dev.html
new file mode 100644
index 0000000..2d5ac14
--- /dev/null
+++ b/_layouts/dev.html
@@ -0,0 +1,28 @@
+---
+layout: page
+---
+
+<div class="container-fluid page-content">
+ <div class="row">
+ <div class="col-md-10 col-md-offset-1">
+ <!-- sidebar -->
+ <div class="col-xs-6 col-sm-3" id="sidebar" role="navigation">
+ <ul class="nav" id="adminnav">
+ {% for doc in site.developments %}
+ <li class="heading">{{ doc.category }}</li>
+ {% for link in doc.links %}
+ <li class="sidenavli"><a href="{{ link.url }}" id="{{link.id}}">{{ link.title }}</a></li>
+ {% endfor %}
+ <li class="divider"></li>
+ {% endfor %}
+ </ul>
+ </div>
+ <div class="col-xs-6 col-sm-9 page-main-content" id="loadcontent">
+ <h1 class="page-header" style="margin-top: 0px">{{ page.title }}</h1>
+ {{ content }}
+ </div><!--end of loadcontent-->
+ </div>
+ <!--end of centered content-->
+ </div>
+</div>
+<!--end of container-->
http://git-wip-us.apache.org/repos/asf/incubator-griffin-site/blob/3573064d/_layouts/doc.html
----------------------------------------------------------------------
diff --git a/_layouts/doc.html b/_layouts/doc.html
new file mode 100644
index 0000000..5639773
--- /dev/null
+++ b/_layouts/doc.html
@@ -0,0 +1,31 @@
+---
+layout: page
+---
+
+<div class="container-fluid page-content">
+ <div class="row">
+ <div class="col-md-10 col-md-offset-1">
+ <!-- sidebar -->
+ <div class="col-xs-6 col-sm-3" id="sidebar" role="navigation">
+ <ul class="nav" id="adminnav">
+ {% for doc in site.documentations %}
+ <li class="heading">{{ doc.category }}</li>
+ {% for link in doc.links %}
+ <li class="sidenavli {% if link.url == page.permalink %}current{% endif %}"><a href="{{ link.url }}" data-permalink="{{ page.permalink }}" id="{{link.id}}">{{ link.title }}</a></li>
+ {% endfor %}
+ <li class="divider"></li>
+ {% endfor %}
+ <li class="sidenavli">
+ <a href="mailto:dev@griffin.apache.org" target="_blank">Need Help?</a>
+ </li>
+ </ul>
+ </div>
+ <div class="col-xs-6 col-sm-9 page-main-content" style="margin-left: -15px" id="loadcontent">
+ <h1 class="page-header" style="margin-top: 0px">{{ page.title }}</h1>
+ {{ content }}
+ </div><!--end of loadcontent-->
+ </div>
+ <!--end of centered content-->
+ </div>
+</div>
+<!--end of container-->
http://git-wip-us.apache.org/repos/asf/incubator-griffin-site/blob/3573064d/_layouts/navpage.html
----------------------------------------------------------------------
diff --git a/_layouts/navpage.html b/_layouts/navpage.html
new file mode 100644
index 0000000..16e18bc
--- /dev/null
+++ b/_layouts/navpage.html
@@ -0,0 +1,34 @@
+---
+layout: page
+---
+
+<div class="container-fluid page-content">
+ <div class="row">
+ <div class="col-md-10 col-md-offset-1">
+ <!-- sidebar -->
+ <div class="col-xs-6 col-sm-3" id="sidebar" role="navigation">
+ <ul class="nav" id="adminnav">
+ {% for doc in site.documentations %}
+ <li class="heading">{{ doc.category }}</li>
+ {% for link in doc.links %}
+ <li class="sidenavli {% if link.url == page.permalink %}current{% endif %}"><a href="{{ link.url }}" data-permalink="{{ page.permalink }}" id="{{link.id}}">{{ link.title }}</a></li>
+ {% endfor %}
+ <li class="divider"></li>
+ {% endfor %}
+ <li class="sidenavli">
+ <a href="/sup/index.html">Go To Supplement</a>
+ </li>
+ <li class="sidenavli">
+ <a href="mailto:dev@griffin.apache.org" target="_blank">Need Help?</a>
+ </li>
+ </ul>
+ </div>
+ <div class="col-xs-6 col-sm-9 page-main-content" style="margin-left: -15px" id="loadcontent">
+ <h1 class="page-header" style="margin-top: 0px">{{ page.title }}</h1>
+ {{ content }}
+ </div><!--end of loadcontent-->
+ </div>
+ <!--end of centered content-->
+ </div>
+</div>
+<!--end of container-->
http://git-wip-us.apache.org/repos/asf/incubator-griffin-site/blob/3573064d/_layouts/page.html
----------------------------------------------------------------------
diff --git a/_layouts/page.html b/_layouts/page.html
new file mode 100644
index 0000000..a2d6c18
--- /dev/null
+++ b/_layouts/page.html
@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+{% include head.html %}
+<body>
+<!-- header start -->
+<div id="home_page">
+ {% include header.html %}
+</div>
+<!-- header end -->
+{{ content }}
+
+{% include footer.html %}
+
+</body>
+</html>
http://git-wip-us.apache.org/repos/asf/incubator-griffin-site/blob/3573064d/_layouts/post.html
----------------------------------------------------------------------
diff --git a/_layouts/post.html b/_layouts/post.html
new file mode 100644
index 0000000..37163f7
--- /dev/null
+++ b/_layouts/post.html
@@ -0,0 +1,14 @@
+---
+layout: default
+---
+<div class="post">
+
+ <header class="post-header">
+ <h1 class="post-title">{{ page.title }}</h1>
+ <p class="post-meta">{{ page.date | date: "%b %-d, %Y" }}{% if page.author %} • {{ page.author }}{% endif %}{% if page.meta %} • {{ page.meta }}{% endif %}</p>
+ </header>
+
+ <article class="post-content">
+ {{ content }}
+ </article>
+</div>
http://git-wip-us.apache.org/repos/asf/incubator-griffin-site/blob/3573064d/_sass/_base.scss
----------------------------------------------------------------------
diff --git a/_sass/_base.scss b/_sass/_base.scss
new file mode 100644
index 0000000..75a96a4
--- /dev/null
+++ b/_sass/_base.scss
@@ -0,0 +1,94 @@
+/**
+ * Set `margin-bottom` to maintain vertical rhythm
+ */
+%vertical-rhythm {
+ margin-bottom: $spacing-unit / 4;
+}
+
+
+/**
+ * Code formatting
+ */
+pre,
+code {
+ font-size: 15px;
+ border: 1px solid $grey-color-light;
+ border-radius: 3px;
+ background-color: #eef;
+}
+
+code {
+ padding: 1px 5px;
+}
+
+pre {
+ padding: 8px 12px;
+ overflow-x: scroll;
+
+ > code {
+ border: 0;
+ padding-right: 0;
+ padding-left: 0;
+ }
+}
+
+/**
+ * Clearfix
+ */
+%clearfix {
+
+ &:after {
+ content: "";
+ display: table;
+ clear: both;
+ }
+}
+
+
+
+/**
+ * Icons
+ */
+.icon {
+
+ > svg {
+ display: inline-block;
+ width: 16px;
+ height: 16px;
+ vertical-align: middle;
+
+ path {
+ fill: $grey-color;
+ }
+ }
+}
+
+/**
+ * Documentations
+ */
+.docs-sidenav.nav > li {
+ > a {
+ display: block;
+ padding: 4px 20px;
+ font-size: 18px;
+ font-weight: 600;
+ color: #146fd1;
+
+ &:hover {
+ /*padding-left: 19px;*/
+ /*color: #1756a9;*/
+ text-decoration: none;
+ /**background-color: transparent;*/
+ }
+ }
+
+ ul li {
+ a {
+ display: block;
+ padding: 4px 20px;
+ font-size: 16px;
+ font-weight: 300;
+ color: #146fd1;
+ }
+ }
+}
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-griffin-site/blob/3573064d/_sass/_layout.scss
----------------------------------------------------------------------
diff --git a/_sass/_layout.scss b/_sass/_layout.scss
new file mode 100644
index 0000000..83c7372
--- /dev/null
+++ b/_sass/_layout.scss
@@ -0,0 +1,235 @@
+/**
+ * Site header
+ */
+.site-header {
+ border-top: 5px solid $grey-color-dark;
+ border-bottom: 1px solid $grey-color-light;
+ min-height: 56px;
+
+ // Positioning context for the mobile navigation icon
+ position: relative;
+}
+
+.site-title {
+ font-size: 26px;
+ line-height: 56px;
+ letter-spacing: -1px;
+ margin-bottom: 0;
+ float: left;
+
+ &,
+ &:visited {
+ color: $grey-color-dark;
+ }
+}
+
+.site-nav {
+ float: right;
+ line-height: 56px;
+
+ .menu-icon {
+ display: none;
+ }
+
+ .page-link {
+ color: $text-color;
+ line-height: $base-line-height;
+
+ // Gaps between nav items, but not on the first one
+ &:not(:first-child) {
+ margin-left: 20px;
+ }
+ }
+
+ @include media-query($on-palm) {
+ position: absolute;
+ top: 9px;
+ right: 30px;
+ background-color: $background-color;
+ border: 1px solid $grey-color-light;
+ border-radius: 5px;
+ text-align: right;
+
+ .menu-icon {
+ display: block;
+ float: right;
+ width: 36px;
+ height: 26px;
+ line-height: 0;
+ padding-top: 10px;
+ text-align: center;
+
+ > svg {
+ width: 18px;
+ height: 15px;
+
+ path {
+ fill: $grey-color-dark;
+ }
+ }
+ }
+
+ .trigger {
+ clear: both;
+ display: none;
+ }
+
+ &:hover .trigger {
+ display: block;
+ padding-bottom: 5px;
+ }
+
+ .page-link {
+ display: block;
+ padding: 5px 10px;
+ }
+ }
+}
+
+
+
+/**
+ * Site footer
+ */
+.site-footer {
+ border-top: 1px solid $grey-color-light;
+ padding: $spacing-unit 0;
+}
+
+.footer-heading {
+ font-size: 18px;
+ margin-bottom: $spacing-unit / 2;
+}
+
+.contact-list,
+.social-media-list {
+ list-style: none;
+ margin-left: 0;
+}
+
+.footer-col-wrapper {
+ font-size: 15px;
+ color: $grey-color;
+ margin-left: -$spacing-unit / 2;
+ @extend %clearfix;
+}
+
+.footer-col {
+ float: left;
+ margin-bottom: $spacing-unit / 2;
+ padding-left: $spacing-unit / 2;
+}
+
+.footer-col-1 {
+ width: -webkit-calc(35% - (#{$spacing-unit} / 2));
+ width: calc(35% - (#{$spacing-unit} / 2));
+}
+
+.footer-col-2 {
+ width: -webkit-calc(20% - (#{$spacing-unit} / 2));
+ width: calc(20% - (#{$spacing-unit} / 2));
+}
+
+.footer-col-3 {
+ width: -webkit-calc(45% - (#{$spacing-unit} / 2));
+ width: calc(45% - (#{$spacing-unit} / 2));
+}
+
+@include media-query($on-laptop) {
+ .footer-col-1,
+ .footer-col-2 {
+ width: -webkit-calc(50% - (#{$spacing-unit} / 2));
+ width: calc(50% - (#{$spacing-unit} / 2));
+ }
+
+ .footer-col-3 {
+ width: -webkit-calc(100% - (#{$spacing-unit} / 2));
+ width: calc(100% - (#{$spacing-unit} / 2));
+ }
+}
+
+@include media-query($on-palm) {
+ .footer-col {
+ float: none;
+ width: -webkit-calc(100% - (#{$spacing-unit} / 2));
+ width: calc(100% - (#{$spacing-unit} / 2));
+ }
+}
+
+
+/**
+ * Page content
+ */
+.page-content {
+ padding: 70px 10px;
+}
+
+.page-heading {
+ font-size: 20px;
+}
+
+.post-list {
+ margin-left: 0;
+ list-style: none;
+
+ > li {
+ margin-bottom: $spacing-unit;
+ }
+}
+
+.post-meta {
+ font-size: $small-font-size;
+ color: $grey-color;
+}
+
+.post-link {
+ display: block;
+ font-size: 24px;
+}
+
+
+
+/**
+ * Posts
+ */
+.post-header {
+ margin-bottom: $spacing-unit;
+}
+
+.post-title {
+ font-size: 42px;
+ letter-spacing: -1px;
+ line-height: 1;
+
+ @include media-query($on-laptop) {
+ font-size: 36px;
+ }
+}
+
+.post-content {
+ margin-bottom: $spacing-unit;
+
+ h2 {
+ font-size: 32px;
+
+ @include media-query($on-laptop) {
+ font-size: 28px;
+ }
+ }
+
+ h3 {
+ font-size: 26px;
+
+ @include media-query($on-laptop) {
+ font-size: 22px;
+ }
+ }
+
+ h4 {
+ font-size: 20px;
+
+ @include media-query($on-laptop) {
+ font-size: 18px;
+ }
+ }
+}
http://git-wip-us.apache.org/repos/asf/incubator-griffin-site/blob/3573064d/_sass/_syntax-highlighting.scss
----------------------------------------------------------------------
diff --git a/_sass/_syntax-highlighting.scss b/_sass/_syntax-highlighting.scss
new file mode 100644
index 0000000..e36627d
--- /dev/null
+++ b/_sass/_syntax-highlighting.scss
@@ -0,0 +1,67 @@
+/**
+ * Syntax highlighting styles
+ */
+.highlight {
+ background: #fff;
+ @extend %vertical-rhythm;
+
+ .c { color: #998; font-style: italic } // Comment
+ .err { color: #a61717; background-color: #e3d2d2 } // Error
+ .k { font-weight: bold } // Keyword
+ .o { font-weight: bold } // Operator
+ .cm { color: #998; font-style: italic } // Comment.Multiline
+ .cp { color: #999; font-weight: bold } // Comment.Preproc
+ .c1 { color: #998; font-style: italic } // Comment.Single
+ .cs { color: #999; font-weight: bold; font-style: italic } // Comment.Special
+ .gd { color: #000; background-color: #fdd } // Generic.Deleted
+ .gd .x { color: #000; background-color: #faa } // Generic.Deleted.Specific
+ .ge { font-style: italic } // Generic.Emph
+ .gr { color: #a00 } // Generic.Error
+ .gh { color: #999 } // Generic.Heading
+ .gi { color: #000; background-color: #dfd } // Generic.Inserted
+ .gi .x { color: #000; background-color: #afa } // Generic.Inserted.Specific
+ .go { color: #888 } // Generic.Output
+ .gp { color: #555 } // Generic.Prompt
+ .gs { font-weight: bold } // Generic.Strong
+ .gu { color: #aaa } // Generic.Subheading
+ .gt { color: #a00 } // Generic.Traceback
+ .kc { font-weight: bold } // Keyword.Constant
+ .kd { font-weight: bold } // Keyword.Declaration
+ .kp { font-weight: bold } // Keyword.Pseudo
+ .kr { font-weight: bold } // Keyword.Reserved
+ .kt { color: #458; font-weight: bold } // Keyword.Type
+ .m { color: #099 } // Literal.Number
+ .s { color: #d14 } // Literal.String
+ .na { color: #008080 } // Name.Attribute
+ .nb { color: #0086B3 } // Name.Builtin
+ .nc { color: #458; font-weight: bold } // Name.Class
+ .no { color: #008080 } // Name.Constant
+ .ni { color: #800080 } // Name.Entity
+ .ne { color: #900; font-weight: bold } // Name.Exception
+ .nf { color: #900; font-weight: bold } // Name.Function
+ .nn { color: #555 } // Name.Namespace
+ .nt { color: #000080 } // Name.Tag
+ .nv { color: #008080 } // Name.Variable
+ .ow { font-weight: bold } // Operator.Word
+ .w { color: #bbb } // Text.Whitespace
+ .mf { color: #099 } // Literal.Number.Float
+ .mh { color: #099 } // Literal.Number.Hex
+ .mi { color: #099 } // Literal.Number.Integer
+ .mo { color: #099 } // Literal.Number.Oct
+ .sb { color: #d14 } // Literal.String.Backtick
+ .sc { color: #d14 } // Literal.String.Char
+ .sd { color: #d14 } // Literal.String.Doc
+ .s2 { color: #d14 } // Literal.String.Double
+ .se { color: #d14 } // Literal.String.Escape
+ .sh { color: #d14 } // Literal.String.Heredoc
+ .si { color: #d14 } // Literal.String.Interpol
+ .sx { color: #d14 } // Literal.String.Other
+ .sr { color: #009926 } // Literal.String.Regex
+ .s1 { color: #d14 } // Literal.String.Single
+ .ss { color: #990073 } // Literal.String.Symbol
+ .bp { color: #999 } // Name.Builtin.Pseudo
+ .vc { color: #008080 } // Name.Variable.Class
+ .vg { color: #008080 } // Name.Variable.Global
+ .vi { color: #008080 } // Name.Variable.Instance
+ .il { color: #099 } // Literal.Number.Integer.Long
+}
http://git-wip-us.apache.org/repos/asf/incubator-griffin-site/blob/3573064d/community.md
----------------------------------------------------------------------
diff --git a/community.md b/community.md
new file mode 100644
index 0000000..cd61c49
--- /dev/null
+++ b/community.md
@@ -0,0 +1,19 @@
+---
+layout: doc
+title: "Apache Griffin Community"
+permalink: /docs/community.html
+---
+### Mailing Lists
+
+|Name|||||Email|||||Subscribe|Unsubscribe|Archive|
+|----|||||-----|||||---------|-----------|-------|
+| User Mailling List|||||[user@Griffin.apache.org](mailto:user@Griffin.apache.org)|||||[subscribe](mailto:user-subscribe@Griffin.apache.org)|[unsubscribe](mailto:user-unsubscribe@Griffin.apache.org)| [Griffin-user](http://mail-archives.apache.org/mod_mbox/Griffin-user/)|
+| Dev Mailling List|||||[dev@Griffin.apache.org](mailto:dev@Griffin.apache.org)|||||[subscribe](mailto:dev-subscribe@Griffin.apache.org)|[unsubscribe](mailto:dev-unsubscribe@Griffin.apache.org)| [Griffin-dev](http://mail-archives.apache.org/mod_mbox/Griffin-dev/)|
+| Issues Mailling List|||||[issues@Griffin.apache.org](mailto:issues@Griffin.apache.org)|||||[subscribe](mailto:issues-subscribe@Griffin.apache.org)|[unsubscribe](mailto:issues-unsubscribe@Griffin.apache.org)| [Griffin-issues](http://mail-archives.apache.org/mod_mbox/Griffin-issues/)|
+| Commits Mailling List|||||[commits@Griffin.apache.org](mailto:commits@Griffin.apache.org)|||||[subscribe](mailto:commits-subscribe@Griffin.apache.org)|[unsubscribe](mailto:commits-unsubscribe@Griffin.apache.org)| [Griffin-commits](http://mail-archives.apache.org/mod_mbox/Griffin-commits/)|
+
+
+### Issue Tracker
+
+[https://issues.apache.org/jira/browse/Griffin](https://issues.apache.org/jira/browse/Griffin)
+
http://git-wip-us.apache.org/repos/asf/incubator-griffin-site/blob/3573064d/conf.md
----------------------------------------------------------------------
diff --git a/conf.md b/conf.md
new file mode 100644
index 0000000..46f369b
--- /dev/null
+++ b/conf.md
@@ -0,0 +1,9 @@
+---
+layout: doc
+title: "Apache Griffin Conferences"
+permalink: /docs/conf.html
+---
+
+### 2017
+ - 2017 Apache Griffin data quality solution for big data @中国数据库技术大会 @ Beijing
+ - 2017 Apache Griffin data quality solution for big data @2017中国开源年会 @ Shanghai
http://git-wip-us.apache.org/repos/asf/incubator-griffin-site/blob/3573064d/download.md
----------------------------------------------------------------------
diff --git a/download.md b/download.md
new file mode 100644
index 0000000..a40e3b9
--- /dev/null
+++ b/download.md
@@ -0,0 +1,8 @@
+---
+layout: doc
+title: "Download Apache Griffin"
+permalink: /docs/download.html
+---
+
+### Download Apache Griffin
+
http://git-wip-us.apache.org/repos/asf/incubator-griffin-site/blob/3573064d/latest.md
----------------------------------------------------------------------
diff --git a/latest.md b/latest.md
new file mode 100644
index 0000000..f5ab034
--- /dev/null
+++ b/latest.md
@@ -0,0 +1,8 @@
+---
+layout: doc
+title: "Latest version"
+permalink: /docs/latest.html
+---
+
+### Latest version
+
http://git-wip-us.apache.org/repos/asf/incubator-griffin-site/blob/3573064d/quick-start.md
----------------------------------------------------------------------
diff --git a/quick-start.md b/quick-start.md
new file mode 100644
index 0000000..64f9bf8
--- /dev/null
+++ b/quick-start.md
@@ -0,0 +1,132 @@
+---
+layout: doc
+title: "Quick Start"
+permalink: /docs/quick-start.html
+---
+
+## Environment Preparation
+Prepare the environment for Apache Griffin.
+You can use our pre-built docker images as the environment.
+Follow the [docker guide](https://github.com/apache/incubator-griffin/blob/master/griffin-doc/docker/griffin-docker-guide.md#environment-preparation) to start up the docker images, and login to the griffin container.
+```
+docker exec -it <griffin docker container id> bash
+cd ~/measure
+```
+
+## Data Preparation
+Prepare the test data in Hive.
+In the docker image, we've prepared two Hive tables named `demo_src` and `demo_tgt`, and the test data is generated hourly.
+The schema is like this:
+```
+id bigint
+age int
+desc string
+dt string
+hour string
+```
+In which `dt` and `hour` are the partition columns, with string values like `20180912` and `06`.
+
+## Configuration Files
+The environment config file: env.json
+```
+{
+ "spark": {
+ "log.level": "WARN"
+ },
+ "sinks": [
+ {
+ "type": "console"
+ },
+ {
+ "type": "hdfs",
+ "config": {
+ "path": "hdfs:///griffin/persist"
+ }
+ },
+ {
+ "type": "elasticsearch",
+ "config": {
+ "method": "post",
+ "api": "http://es:9200/griffin/accuracy"
+ }
+ }
+ ]
+}
+```
+The DQ config file: dq.json
+```
+{
+ "name": "batch_accu",
+ "process.type": "batch",
+ "data.sources": [
+ {
+ "name": "src",
+ "baseline": true,
+ "connectors": [
+ {
+ "type": "hive",
+ "version": "1.2",
+ "config": {
+ "database": "default",
+ "table.name": "demo_src"
+ }
+ }
+ ]
+ }, {
+ "name": "tgt",
+ "connectors": [
+ {
+
+ "type": "hive",
+ "version": "1.2",
+ "config": {
+ "database": "default",
+ "table.name": "demo_tgt"
+ }
+ }
+ ]
+ }
+ ],
+ "evaluate.rule": {
+ "rules": [
+ {
+ "dsl.type": "griffin-dsl",
+ "dq.type": "accuracy",
+ "out.dataframe.name": "accu",
+ "rule": "src.id = tgt.id AND src.age = tgt.age AND src.desc = tgt.desc",
+ "details": {
+ "source": "src",
+ "target": "tgt",
+ "miss": "miss_count",
+ "total": "total_count",
+ "matched": "matched_count"
+ },
+ "out": [
+ {
+ "type": "metric",
+ "name": "accu"
+ },
+ {
+ "type": "record",
+ "name": "missRecords"
+ }
+ ]
+ }
+ ]
+ },
+ "sinks": ["CONSOLE", "HDFS"]
+}
+```
+
+## Submit Measure Job
+Submit the measure job to Spark, with config file paths as parameters.
+```
+spark-submit --class org.apache.griffin.measure.Application --master yarn --deploy-mode client --queue default \
+--driver-memory 1g --executor-memory 1g --num-executors 2 \
+<path>/griffin-measure.jar \
+<path>/env.json <path>/batch-accu-config.json
+```
+Then you can get the calculation log in console, after the job finishes, you can get the result metrics printed. The metrics will also be saved in hdfs: `hdfs:///griffin/persist/<job name>/<timestamp>/_METRICS`.
+
+## More Details
+For more details about griffin measures, you can visit our documents in [github](https://github.com/apache/incubator-griffin/tree/master/griffin-doc).
http://git-wip-us.apache.org/repos/asf/incubator-griffin-site/blob/3573064d/usecases.md
----------------------------------------------------------------------
diff --git a/usecases.md b/usecases.md
new file mode 100644
index 0000000..426dfca
--- /dev/null
+++ b/usecases.md
@@ -0,0 +1,8 @@
+---
+layout: doc
+title: "griffin use cases"
+permalink: /docs/usecases.html
+---
+
+### Apache Griffin Use Cases
+