Merge pull request #99 from caskdata/feature/r0.2.1_docs

Release 0.2.1 doc changes

tigon-docs/developer-guide/build.sh

@@ -29,6 +29,7 @@ SCRIPT=`basename $0`
 SOURCE="source"
 BUILD="build"
 BUILD_PDF="build-pdf"
+BUILD_TEMP="build-temp"
 HTML="html"
 INCLUDES="_includes"
 
@@ -96,6 +97,7 @@ function usage() {
   echo "Usage: $SCRIPT < option > [source]"
   echo ""
   echo "  Options (select one)"
+  echo "    all            Clean build of everything: HTML docs and Javadocs, GitHub and Web versions"
   echo "    build          Clean build of javadocs and HTML docs, copy javadocs into place, zip results"
   echo "    build-includes Clean conversion of example/README.md to _includes directory reST files"
   echo "    build-quick    Clean build of HTML docs, copy existing javadocs into place"
@@ -186,6 +188,20 @@ function make_zip_localized() {
   zip -r $ZIP_DIR_NAME.zip $PROJECT_VERSION/*
 }
 
+function build_all() {
+  echo "Building GitHub Docs."
+  ./build.sh build-github
+  echo "Stashing GitHub Docs."
+  cd $SCRIPT_PATH
+  mkdir -p $SCRIPT_PATH/$BUILD_TEMP
+  mv $SCRIPT_PATH/$BUILD/*.zip $SCRIPT_PATH/$BUILD_TEMP
+  echo "Building Web Docs."
+  ./build.sh build-web
+  echo "Moving GitHub Docs."
+  mv $SCRIPT_PATH/$BUILD_TEMP/*.zip $SCRIPT_PATH/$BUILD
+  rm -rf $SCRIPT_PATH/$BUILD_TEMP
+}
+
 function build() {
   build_docs
   build_javadocs
@@ -242,6 +258,21 @@ function pandoc_includes() {
   pandoc -t rst $PROJECT_PATH/$TIGON_EXAMPLES/SQLJoinFlow/README.md -o $INCLUDES_DIR/sql-join-flow.rst
   pandoc -t rst $PROJECT_PATH/$TIGON_EXAMPLES/tigon-sql/README.md -o $INCLUDES_DIR/tigon-sql.rst
   pandoc -t rst $PROJECT_PATH/$TIGON_EXAMPLES/TwitterAnalytics/README.md -o $INCLUDES_DIR/twitter-analytics.rst
+
+  # Fix version
+  version_rewrite $SCRIPT_PATH/$SOURCE/getting-started.txt $INCLUDES_DIR/getting-started-versioned.rst
+
+}
+
+function version_rewrite() {
+  version
+  cd $SCRIPT_PATH
+  echo "Re-writing $1 to $2"
+  # Re-writes the version in an RST-snippet file to have the current version.
+  REWRITE_SOURCE=$1
+  REWRITE_TARGET=$2
+  
+  sed -e "s|<version>|$PROJECT_VERSION|g" $REWRITE_SOURCE > $REWRITE_TARGET
 }
 
 function build_quick() {
@@ -311,6 +342,7 @@ if [ $# -lt 1 ]; then
 fi
 
 case "$1" in
+  all )                build_all; exit 1;;
   build )              build; exit 1;;
   build-includes )     build_includes; exit 1;;
   build-quick )        build_quick; exit 1;;

tigon-docs/developer-guide/source/_themes/tigon/static/tigon.css_t

@@ -255,6 +255,16 @@ p.admonition-title:after {
     content: ":";
 }
 
+p.rubric {
+    background-color: #E0E0E0;
+    font-size: 120%;
+    font-weight: normal;
+    color: #111;
+    margin: 30px 0px 10px -15px;
+    padding: 5px 0 5px 15px;
+    text-shadow: 0px 1px 0 white
+}
+
 em {
     font-style: italic;
 }

tigon-docs/developer-guide/source/admin.rst

@@ -68,4 +68,4 @@ Where to Go Next
 
 Now that you're familiar with how to run Tigon, take a look at:
 
-- `Licenses and Copyrights <licenses.html>`__, which covers how Tigon has been released.
+- :doc:`licenses`, which covers how Tigon has been released.

tigon-docs/developer-guide/source/apis/index.rst

@@ -29,7 +29,7 @@ Where to Go Next
 
 Now that you're familiar with the APIs for Tigon, take a look at:
 
-- `Tools <../tools.html>`__, which describes the command-line interface for running a Tigon Application.
+- :doc:`/tools`, which describes the command-line interface for running a Tigon Application.
 
 .. downloads:
 

tigon-docs/developer-guide/source/concepts.rst

@@ -61,4 +61,4 @@ Where to Go Next
 
 Now that you're familiar with the basic concept and architecture of Tigon, take a look at:
 
-- `Developer <developer.html>`__, which covers writing applications using Tigon.
+- :doc:`developer`, which covers writing applications using Tigon.

tigon-docs/developer-guide/source/developer.rst

@@ -780,6 +780,6 @@ Where to Go Next
 
 Now that you're familiar with the components and concepts of Tigon, take a look at:
 
-- `Examples <examples/index.html>`__, with a series of examples demonstrating Tigon.
+- :doc:`/examples/index`, with a series of examples demonstrating Tigon.
 
 

tigon-docs/developer-guide/source/examples/index.rst

@@ -49,10 +49,14 @@ Reference applications built with Tigon are included in the
 - `AdNetworkFlow: <https://github.com/caskdata/tigon-apps/tree/develop/AdNetworkFlow>`__
   Demonstrates using Tigon to write a realtime bidding (RTB) advertisement framework.
 
+- `ClickStreamFlow: <https://github.com/caskdata/tigon-apps/tree/develop/ClickStreamFlow>`__
+  Demonstrates using Tigon SQL to join 2 data streams. In this example, a view event data
+  stream and a click event data stream are joined to generate meta information for each
+  click event. Click events are filtered on the basis of conditions specified in a SQL query.
 
 Where to Go Next
 ================
 
 Now that you're seen an example demonstrating Tigon, take a look at:
 
-- `APIs <../apis/index.html>`__, which includes the Java and TigonSQL APIs of Tigon.
+- :doc:`/apis/index`, which includes the Java and TigonSQL APIs of Tigon.

tigon-docs/developer-guide/source/faq.rst

@@ -9,71 +9,71 @@ Tigon FAQ
 General
 =======
 
-**What is Tigon?**
-
+What is Tigon?
+--------------------------
 **Tigon** is an open-source, real-time stream processing framework built on top of Apache |(TM)| Hadoop |(R)| and HBase.
 
-**Who is Tigon intended for?**
-
+Who is Tigon intended for?
+--------------------------
 Developers who are interested in creating powerful, yet simple-to-develop stream processing
 applications that can handle large volumes of data.
 
-**What are some of the applications that can be built on Tigon?**
+What are some of the applications that can be built on Tigon?
+------------------------------------------------------------------------------
 
 - Processing stream sources such as Twitter, Webserver Logs
 - Rapid Joining, Filtering, and Aggregating of Streams
 
-**How does Tigon work?**
-
+How does Tigon work?
+------------------------------------------------------------------------------
 Tigon is built on top of Hadoop/HBase. It uses the 
 `Tephra Transaction Engine <https://github.com/caskdata/tephra>`__ and `Twill <http://twill.incubator.apache.org>`__
 for spinning up YARN applications. For in-memory stream processing, it uses the `TigonSQL <advanced.html>`__
 in-memory stream processing engine developed by AT&T.
 
-**What is the difference between Tigon and Cask's other projects, such as CDAP?**
-
+What is the difference between Tigon and Cask's other projects, such as CDAP?
+------------------------------------------------------------------------------
 Tigon is focused on solving the issues faced in real-time stream processing. 
 
 The `Cask Data Application Platform (CDAP) <http://cdap.io>`__ is a generalized 'Big
 Data' application platform with additional features such as dataset abstractions, batch job
 integration, and security.
 
-**What's the vision for Tigon?**
-
+What's the vision for Tigon?
+------------------------------------------------------------------------------
 Enable every Java developer to create powerful, real-time stream processing applications.
 
 
 Running Tigon
 =============
 
-**How do I get started with Tigon?**
-
+How do I get started with Tigon?
+------------------------------------------------------------------------------
 Download the zip, unzip it and checkout the examples! 
 
-See our `Getting Started With Tigon <getting-started.html>`__ guide.
-
-**What are the prerequisites for running Tigon?**
-
-See our `Getting Started With Tigon <getting-started.html#prerequisites>`__ guide
-for a list of prerequisites.
+See our :doc:`getting-started` guide.
 
-**What platforms and Java version does Tigon run on?**
+What are the prerequisites for running Tigon?
+------------------------------------------------------------------------------
+See our :doc:`getting-started` guide for a :ref:`list of prerequisites. <getting-started-prerequisites>`
 
+What platforms and Java version does Tigon run on?
+------------------------------------------------------------------------------
 Tigon runs on \*NIX systems such as Linux and Macintosh OS X.
 A Java Development Kit such as JDK 6 or JDK 7 is required to run Tigon.
 
 .. **Are there Tigon RPM or Debian packages available for download?**
 
-**Does Tigon run on Windows?**
-
+Does Tigon run on Windows?
+------------------------------------------------------------------------------
 Currently, Tigon does not run on Windows.
 
-**What hardware do I need for Tigon?**
-
+What hardware do I need for Tigon?
+------------------------------------------------------------------------------
 Tigon runs on the same hardware that would support Hadoop/HBase.
 
-**What programming languages are supported by Tigon?**
-
+What programming languages are supported by Tigon?
+------------------------------------------------------------------------------
 Applications that use Tigon currently need to be written in Java. 
 If you are using TigonSQL, commands are written in an SQL dialect.
 
@@ -83,42 +83,42 @@ certain elements are written in Perl and Python.
 Tigon Support
 =========================
 
-**Where can I find more information about Tigon?**
-
+Where can I find more information about Tigon?
+------------------------------------------------------------------------------
 Our resources include this website, our parent website (`cask.co <http://cask.co>`__),
 two mailing lists, an IRC channel and a `GitHub repository. <https://github.com/caskdata/tigon>`__
 
-**What mailing lists are available for additional help?**
-
+What mailing lists are available for additional help?
+------------------------------------------------------------------------------
 Tigon User Group and Development Discussions: 
 
 - Focused on Tigon usage questions, discussions, and solutions: `tigon-user@googlegroups.com <https://groups.google.com/d/forum/tigon-user>`__
 - For developers modifying Tigon itself: `tigon-dev@googlegroups.com <https://groups.google.com/d/forum/tigon-dev>`__
 
-**Is there an IRC Channel?**
-
-Tigon IRC Channel #tigon on irc.freenode.net
-
-**Where are Bug Reports and Feature Requests kept?**
+Is there an IRC Channel?
+------------------------------------------------------------------------------
+Tigon IRC Channel #tigon on `irc.freenode.net. <http://irc.freenode.net/>`__
 
-Bugs and tasks are tracked in a public JIRA issue tracker. Details on access will be forthcoming.
-
-**Is commercial support available for Tigon?**
+Where are Bug Reports and Feature Requests kept?
+------------------------------------------------------------------------------
+We have a `JIRA for filing issues. <https://issues.cask.co/browse/Tigon>`__
 
+Is commercial support available for Tigon?
+------------------------------------------------------------------------------
 Contact Cask Data for information on `commercial Tigon support. <http://cask.co/company/#company-contact>`__
 
 
 Contributing to Tigon
 =========================
 
-**How can I help make Tigon better?**
-
+How can I help make Tigon better?
+------------------------------------------------------------------------------
 We welcome all contributions, whether in filing detailed
 bug reports, submitting pull requests for code changes and improvements, or by asking questions and
 assisting others on the mailing list.
 
-**How can I contribute?**
-
+How can I contribute?
+------------------------------------------------------------------------------
 Are you interested in making Tigon better? We have a simple pull-based development model
 with a consensus-building phase, similar to Apache's voting process. If you’d like to help
 make Tigon better by adding new features, enhancing existing features, or fixing bugs,
@@ -136,6 +136,7 @@ here's how to do it:
 #. After we review and accept your request, we’ll commit your code to the 
    `caskdata/tigon <https://github.com/caskdata/tigon>`__ repository.
 
+
 .. |(TM)| unicode:: U+2122 .. trademark sign
    :ltrim: