Merge pull request #512 from caskdata/feature/r2.5.1_release_notes

CDAP 2.5.1 Release notes
cdapio · Oct 15, 2014 · 285169d · 285169d
2 parents 0174863 + 4ef9494
commit 285169d
Show file tree

Hide file tree

Showing 6 changed files with 103 additions and 41 deletions.
diff --git a/DEVELOPERS.md b/DEVELOPERS.md
@@ -0,0 +1,24 @@
+
+# CDAP Contributor Quickstart Guide
+
+This guide outlines the steps to setup your system for contributing to CDAP.
+
+## Prerequisites
+* Java 6+ SDK
+* Maven
+* Git
+
+## Setup for IntelliJ IDEA
+
+First, open the CDAP project in IntelliJ IDEA: Select File > Open... > cdap/pom.xml
+
+Then, configure a run configuration to run CDAP Standalone:
+
+* Select Run > Edit Configurations...
+* Add a new "Application" run configuration
+* Set "Main class" to be `co.cask.cdap.StandaloneMain`
+* Set "VM options" to `-Xmx1024m` (for in-memory Map/Reduce jobs)
+* Click "OK"
+
+You can now use this run configuration to start an instance of CDAP Standalone.
+
diff --git a/README.md b/README.md
@@ -28,17 +28,9 @@ installation. CDAP can be run either standalone, deployed within the Enterprise
 For more information, see our collection of 
 [Developer Guides and other documentation](http://docs.cask.co/cdap/current/en/index.html).
 
-## Is It Building?
-
-Build                                                                | Status / Version
----------------------------------------------------------------------|-----------------
-[Continuous Integration Build](https://builds.cask.co/browse/CDAP)   | ![Build](https://builds.cask.co/plugins/servlet/buildStatusImage/CDAP-DUT)
-[GitHub Version](https://github.com/caskdata/cdap/releases/latest)   | ![github](http://img.shields.io/github/release/caskdata/cdap.svg)
-
-
 ## Getting Started
 
-### Prerequiste
+### Prerequisites
 
 To install and use CDAP and its included examples, there are a few simple prerequisites:
 
@@ -51,7 +43,7 @@ To install and use CDAP and its included examples, there are a few simple prereq
 You can get started with CDAP by building directly from the latest source code::
 
 ```
-  git clone https://github.com/cask/cdap.git
+  git clone https://github.com/caskdata/cdap.git
   cd cdap
   mvn clean package
 ```
@@ -68,7 +60,6 @@ For more build options, please refer to the [build instructions](BUILD.md).
 Visit our web site for a [Getting Started](http://docs.cask.co/cdap/current/en/getstarted.html)
 document that will guide you through installing CDAP and running an example application.  
 
-
 ## Where to Go Next
 
 Now that you've had a look at the CDAP SDK, take a look at:
@@ -86,6 +77,8 @@ Interested in helping to improve CDAP? We welcome all contributions, whether in
 bug reports, submitting pull requests for code changes and improvements, or by asking questions and
 assisting others on the mailing list.
 
+For quick guide to getting your system setup to contribute to CDAP, take a look at our [Contributor Quickstart Guide](DEVELOPERS.md).
+
 ### Bug Reports & Feature Requests
 
 Bugs and tasks are tracked in a public JIRA issue tracker. Details on access will be forthcoming.
@@ -109,14 +102,17 @@ features, or fixing bugs, here's how to do it:
 
 Thanks for helping to improve CDAP!
 
+### Filing Issues
+JIRA for filing [Issues](http://issues.cask.co)
+
 ### Mailing List
 
 CDAP User Group and Development Discussions: 
 [[email protected]](https://groups.google.com/d/forum/cdap-dev)
 
 ### IRC Channel
 
-CDAP IRC Channel #cask-cdap on irc.freenode.net
+CDAP IRC Channel: #cdap on irc.freenode.net
 
 
 ## License and Trademarks

diff --git a/cdap-docs/developer-guide/build.sh b/cdap-docs/developer-guide/build.sh
@@ -77,6 +77,23 @@ WEB="web"
 GOOGLE_ANALYTICS_GITHUB="UA-55081520-2"
 GITHUB="github"
 
+REDIRECT_EN_HTML=`cat <<EOF
+<!DOCTYPE HTML>
+<html lang="en-US">
+    <head>
+        <meta charset="UTF-8">
+        <meta http-equiv="refresh" content="0;url=en/index.html">
+        <script type="text/javascript">
+            window.location.href = "en/index.html"
+        </script>
+        <title></title>
+    </head>
+    <body>
+    </body>
+</html>
+EOF`
+
+
 function usage() {
   cd $PROJECT_PATH
   PROJECT_PATH=`pwd`
@@ -128,7 +145,7 @@ function build_docs_google() {
 
 function build_javadocs_full() {
   cd $PROJECT_PATH
-  mvn clean site -DskipTests
+  MAVEN_OPTS="-Xmx512m" mvn clean site -DskipTests
 }
 
 function build_javadocs_sdk() {
@@ -181,7 +198,9 @@ function make_zip() {
   version
   ZIP_DIR_NAME="$PROJECT-docs-$PROJECT_VERSION-$1"
   cd $SCRIPT_PATH/$BUILD
-  mv $HTML $ZIP_DIR_NAME
+  mkdir $ZIP_DIR_NAME
+  mv $HTML $ZIP_DIR_NAME/en
+  echo "$REDIRECT_EN_HTML" > $ZIP_DIR_NAME/index.html
   zip -r $ZIP_DIR_NAME.zip $ZIP_DIR_NAME/*
 }
 
@@ -192,6 +211,8 @@ function make_zip_localized() {
   cd $SCRIPT_PATH/$BUILD
   mkdir $PROJECT_VERSION
   mv $HTML $PROJECT_VERSION/en
+  # Add a redirect index.html file
+  echo "$REDIRECT_EN_HTML" > $PROJECT_VERSION/index.html
   zip -r $ZIP_DIR_NAME.zip $PROJECT_VERSION/*
 }
 
@@ -204,8 +225,6 @@ function build() {
 }
 
 function build_web() {
-# This is used to stage files at cdap-integration10031-1000.dev.continuuity.net
-# desired path is 2.5.0-SNAPSHOT/en/*
   build_docs_google $GOOGLE_ANALYTICS_WEB
   build_javadocs_sdk
   copy_javadocs_sdk
@@ -214,29 +233,24 @@ function build_web() {
 }
 
 function build_github() {
-  # GitHub requires a .nojekyll file at the root to allow for Sphinx's directories beginning with underscores
   build_docs_google $GOOGLE_ANALYTICS_GITHUB
   build_javadocs_sdk
   copy_javadocs_sdk
   copy_license_pdfs
-  make_zip $GITHUB
-  ZIP_DIR_NAME="$PROJECT-docs-$PROJECT_VERSION-$GITHUB"
-  cd $SCRIPT_PATH/$BUILD
-  touch $ZIP_DIR_NAME/.nojekyll
-  zip $ZIP_DIR_NAME.zip $ZIP_DIR_NAME/.nojekyll
+  make_zip_localized $GITHUB
 }
 
 function build_rest_pdf() {
   cd $SCRIPT_PATH
-#   version # version is not needed because the renaming is done by the pom.xml file
+  # version is not needed because the renaming is done by the pom.xml file
   rm -rf $SCRIPT_PATH/$BUILD_PDF
   mkdir $SCRIPT_PATH/$BUILD_PDF
   python $DOC_GEN_PY -g pdf -o $REST_PDF $REST_SOURCE
 }
 
 function check_includes() {
   if hash pandoc 2>/dev/null; then
-    echo "pandoc is installed; checking the README includes."
+    echo "Confirmed that pandoc is installed; checking the README includes."
     # Build includes
     BUILD_INCLUDES_DIR=$SCRIPT_PATH/$BUILD/$INCLUDES
     rm -rf $BUILD_INCLUDES_DIR
@@ -251,7 +265,7 @@ function check_includes() {
     test_include cdap-stream-clients-java.rst
     test_include cdap-stream-clients-python.rst
   else
-    echo "WARNING: pandoc not installed; checked-in README includes will be used instead."
+    echo "WARNING: pandoc is not installed; checked-in README includes will be used instead."
   fi
 }
 
@@ -287,11 +301,10 @@ function pandoc_includes() {
     MD_CLIENTS="../../../cdap-clients"
     MD_INGEST="../../../cdap-ingest"
   else
-    GITHUB="https://raw.githubusercontent.com/caskdata"
-#     VERSION="release/1.0.0" # for development
+    GITHUB_URL="https://raw.githubusercontent.com/caskdata"
     VERSION="v1.0.1" # after tagging
-    MD_CLIENTS="$GITHUB/cdap-clients/$VERSION"
-    MD_INGEST="$GITHUB/cdap-ingest/$VERSION"
+    MD_CLIENTS="$GITHUB_URL/cdap-clients/$VERSION"
+    MD_INGEST="$GITHUB_URL/cdap-ingest/$VERSION"
   fi
 
   echo "Using $TEST_INCLUDES includes..."
@@ -328,8 +341,6 @@ function build_dependencies() {
 
 function version() {
   cd $PROJECT_PATH
-#   PROJECT_VERSION=`mvn help:evaluate -o -Dexpression=project.version | grep -v '^\['`
-#   PROJECT_VERSION="2.5.0"
   PROJECT_VERSION=`grep "<version>" pom.xml`
   PROJECT_VERSION=${PROJECT_VERSION#*<version>}
   PROJECT_VERSION=${PROJECT_VERSION%%</version>*}
@@ -348,10 +359,10 @@ function test() {
   echo "Test..."
   echo "Version..."
   print_version
-  echo "Build all docs..."
-  build
-  echo "Build SDK..."
-  build_sdk
+#   echo "Build all docs..."
+#   build
+#   echo "Build SDK..."
+#   build_sdk
   echo "Test completed."
 }
 

diff --git a/cdap-docs/developer-guide/source/_themes/cdap/static/cdap.css_t b/cdap-docs/developer-guide/source/_themes/cdap/static/cdap.css_t
@@ -47,6 +47,7 @@ div.body {
     color: #3E4349;
     padding: 0 30px 30px 30px;
     font-size: 0.9em;
+    min-height: 1200px;
 }
 
 div.footer {

diff --git a/cdap-docs/developer-guide/source/getstarted.rst b/cdap-docs/developer-guide/source/getstarted.rst
@@ -65,7 +65,7 @@ Click the link marked "SDK" of the *Software Development Kit (SDK).*
 
 Once downloaded, unzip it to a directory on your machine::
 
-    $ tar -zxvf cdap-sdk-2.5.1.zip
+    $ unzip cdap-sdk-2.5.1.zip
 
 CDAP Standalone Virtual Machine Image
 -------------------------------------

diff --git a/cdap-docs/developer-guide/source/releasenotes.rst b/cdap-docs/developer-guide/source/releasenotes.rst
@@ -12,6 +12,39 @@ Cask Data Application Platform Release Notes
 ============================================
 .. _release-notes:
 
+Release 2.5.1
+=============
+
+CDAP Bug Fixes
+--------------
+
+- Improved the documentation of the CDAP Authentication and Stream Clients, both Java and Python APIs.
+- Fixed problems with the CDAP Command Line Interface (CLI):
+
+  - Did not work in non-interactive mode;
+  - Printed excessive debug log messages;
+  - Relative paths did not work as expected; and 
+  - Failed to execute SQL queries.
+
+- Removed dependencies on SNAPSHOT artifacts for *netty-http* and *auth-clients*. 
+- Corrected an error in the message printed by the startup script ``cdap.sh``.
+- Resolved a problem with the reading of the properties file by the CDAP Flume Client of CDAP Ingest library
+  without first checking if authentication was enabled.
+
+Other Changes
+-------------
+
+- The scripts ``send-query.sh``, ``access-token.sh`` and ``access-token.bat`` has been replaced by the 
+  `CDAP Command Line Interface, <api.html#cli>`__ ``cdap-cli.sh``.
+- The CDAP Command Line Interface now uses and saves access tokens when connecting to a secure CDAP instance.
+- The CDAP Java Stream Client now allows empty String events to be sent.
+- The CDAP Python Authentication Client's ``configure()`` method now takes a dictionary rather than a filepath.
+
+Known Issues
+------------
+See *Known Issues* of `the previous version. <#known-issues-251>`_
+
+
 Release 2.5.0
 =============
 
@@ -77,11 +110,8 @@ Major CDAP Bug Fixes
 - Fixed an issue with the Dataset size metric showing data operations size instead of resource usage
 
 
-Other CDAP Changes
-------------------
-- `A list of deprecated Interfaces, Classes and Methods <javadocs/deprecated-list.html>`__ 
-  is included in the Javadocs
-
+.. _known-issues-251:
+
 Known Issues
 ------------
 - Metrics for MapReduce jobs aren't populated on secure Hadoop clusters