You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@knox.apache.org by lm...@apache.org on 2014/11/21 22:18:08 UTC

[13/14] knox git commit: KNOX-470 - add README and site docs for samples

KNOX-470 - add README and site docs for samples


Project: http://git-wip-us.apache.org/repos/asf/knox/repo
Commit: http://git-wip-us.apache.org/repos/asf/knox/commit/5adbb55e
Tree: http://git-wip-us.apache.org/repos/asf/knox/tree/5adbb55e
Diff: http://git-wip-us.apache.org/repos/asf/knox/diff/5adbb55e

Branch: refs/heads/v0.5.1
Commit: 5adbb55e217200512a2822a3b4ebcbf6a84c3707
Parents: 8b0053e
Author: Larry McCay <lm...@hortonworks.com>
Authored: Tue Nov 11 12:15:16 2014 -0500
Committer: Larry McCay <lm...@hortonworks.com>
Committed: Fri Nov 21 16:03:24 2014 -0500

----------------------------------------------------------------------
 CHANGES                             |  3 +++
 gateway-release/home/samples/README | 13 +++++++++++++
 2 files changed, 16 insertions(+)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/knox/blob/5adbb55e/CHANGES
----------------------------------------------------------------------
diff --git a/CHANGES b/CHANGES
index 694dc29..2458201 100644
--- a/CHANGES
+++ b/CHANGES
@@ -1,6 +1,9 @@
 ------------------------------------------------------------------------------
 Release Notes - Apache Knox - Version 0.5.1
 ------------------------------------------------------------------------------
+** Improvement
+  * [KNOX-470] - add README and site docs for samples
+
 ** Bug
     * [KNOX-467] - Unit tests failing on windows. Second attempt.
     * [KNOX-467] - Unit tests failing on windows

http://git-wip-us.apache.org/repos/asf/knox/blob/5adbb55e/gateway-release/home/samples/README
----------------------------------------------------------------------
diff --git a/gateway-release/home/samples/README b/gateway-release/home/samples/README
new file mode 100644
index 0000000..3e59836
--- /dev/null
+++ b/gateway-release/home/samples/README
@@ -0,0 +1,13 @@
+*********************************************************************
+Samples README
+*********************************************************************
+The purpose of the samples within this directory is to demonstrate the capabilities
+of the Apache Knox Gateway to provide access to the numerous APIs that are available
+from the service components of a Hadoop cluster.
+
+Depending on exactly how your Knox installation was done, there will be some number of
+steps required in order fully install and configure the samples for use in your environment.
+
+Please see the following section within the Apache Knox Users Guide: 
+
+http://knox.apache.org/books/knox-0-5-0/knox-0-5-0.html#Gateway+Samples
\ No newline at end of file