You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@knox.apache.org by km...@apache.org on 2013/03/19 03:53:03 UTC

git commit: Created doc outline for client.

Updated Branches:
  refs/heads/master d084401b8 -> ee15d8117


Created doc outline for client.


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

Branch: refs/heads/master
Commit: ee15d81179c2ee649231dfc5515c3a2741d0e305
Parents: d084401
Author: Kevin Minder <ke...@hortonworks.com>
Authored: Mon Mar 18 22:52:58 2013 -0400
Committer: Kevin Minder <ke...@hortonworks.com>
Committed: Mon Mar 18 22:52:58 2013 -0400

----------------------------------------------------------------------
 gateway-site/pom.xml                         |   16 ------
 gateway-site/src/site/markdown/build.md      |   31 +++++++++++
 gateway-site/src/site/markdown/client.md     |   59 +++++++++++++++++++++
 gateway-site/src/site/markdown/contribute.md |   31 +++++++++++
 gateway-site/src/site/markdown/index.md      |   16 ++----
 gateway-site/src/site/markdown/news.md       |   14 +++++-
 gateway-site/src/site/markdown/release.md    |   31 +++++++++++
 gateway-site/src/site/site.xml               |   24 ++++++---
 8 files changed, 187 insertions(+), 35 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-knox/blob/ee15d811/gateway-site/pom.xml
----------------------------------------------------------------------
diff --git a/gateway-site/pom.xml b/gateway-site/pom.xml
index 278a6b3..e11a179 100644
--- a/gateway-site/pom.xml
+++ b/gateway-site/pom.xml
@@ -32,22 +32,6 @@
     <description>Knox is a gateway for Hadoop clusters.</description>
     <url>http://incubator.apache.org/knox</url>
 
-    <!--
-    <properties>
-        <buildtype>test</buildtype>
-        <BUILD_NUMBER>${env.BUILD_NUMBER}</BUILD_NUMBER>
-        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
-        <package.prefix>/usr</package.prefix>
-        <package.conf.dir>/etc/ambari</package.conf.dir>
-        <package.log.dir>/var/log/ambari</package.log.dir>
-        <package.pid.dir>/var/run/ambari</package.pid.dir>
-        <package.release>1</package.release>
-        <package.type>tar.gz</package.type>
-        <ambari.version>1.0.0-SNAPSHOT</ambari.version>
-        <final.name>${project.artifactId}-${ambari.version}</final.name>
-    </properties>
-    -->
-
     <licenses>
         <license>
             <name>The Apache Software License, Version 2.0</name>

http://git-wip-us.apache.org/repos/asf/incubator-knox/blob/ee15d811/gateway-site/src/site/markdown/build.md
----------------------------------------------------------------------
diff --git a/gateway-site/src/site/markdown/build.md b/gateway-site/src/site/markdown/build.md
new file mode 100644
index 0000000..75621c9
--- /dev/null
+++ b/gateway-site/src/site/markdown/build.md
@@ -0,0 +1,31 @@
+<!---
+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.
+-->
+
+### Build Process
+TODO
+
+### Disclaimer
+The Apache Knox Gateway is an effort undergoing incubation at the
+Apache Software Foundation (ASF), 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.
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/incubator-knox/blob/ee15d811/gateway-site/src/site/markdown/client.md
----------------------------------------------------------------------
diff --git a/gateway-site/src/site/markdown/client.md b/gateway-site/src/site/markdown/client.md
new file mode 100644
index 0000000..8971c15
--- /dev/null
+++ b/gateway-site/src/site/markdown/client.md
@@ -0,0 +1,59 @@
+<!---
+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.
+-->
+### Introduction
+
+Usable from data workers local host
+  Super light weight
+  Zero configuration
+  Does not depend on Hadoop install
+Easily extensible
+Support "single sing on"
+
+
+### Usage
+
+### Examples
+
+### Constructs
+
+### Services
+
+### HDFS Commands
+
+### Job Commands
+
+### Workflow Commands
+
+### Futures
+
+### Closures
+
+### Extension
+
+### Groovy
+
+### Disclaimer
+The Apache Knox Gateway is an effort undergoing incubation at the
+Apache Software Foundation (ASF), 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.
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/incubator-knox/blob/ee15d811/gateway-site/src/site/markdown/contribute.md
----------------------------------------------------------------------
diff --git a/gateway-site/src/site/markdown/contribute.md b/gateway-site/src/site/markdown/contribute.md
new file mode 100644
index 0000000..5a72893
--- /dev/null
+++ b/gateway-site/src/site/markdown/contribute.md
@@ -0,0 +1,31 @@
+<!---
+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.
+-->
+
+### Contribution Process
+TODO
+
+### Disclaimer
+The Apache Knox Gateway is an effort undergoing incubation at the
+Apache Software Foundation (ASF), 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.
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/incubator-knox/blob/ee15d811/gateway-site/src/site/markdown/index.md
----------------------------------------------------------------------
diff --git a/gateway-site/src/site/markdown/index.md b/gateway-site/src/site/markdown/index.md
index 1362e6b..702861a 100644
--- a/gateway-site/src/site/markdown/index.md
+++ b/gateway-site/src/site/markdown/index.md
@@ -16,18 +16,14 @@ limitations under the License.
 -->
 
 ### Introduction
-
-TODO
-
-### Roadmap
-
-* 0.2.0
-* 0.3.0
-* 1.0.0
+The charter for the Apache Knox Gateway project is to simplify and normalize
+the deployment and implementation of secure Hadoop clusters as well as be
+a central access point for the service specific REST APIs exposed from
+within the Hadoop clusters.
 
 ### Disclaimer
-Apache Knox is an effort undergoing incubation at the Apache Software
-Foundation (ASF), sponsored by the Apache Incubator PMC.
+The Apache Knox Gateway is an effort undergoing incubation at the
+Apache Software Foundation (ASF), 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

http://git-wip-us.apache.org/repos/asf/incubator-knox/blob/ee15d811/gateway-site/src/site/markdown/news.md
----------------------------------------------------------------------
diff --git a/gateway-site/src/site/markdown/news.md b/gateway-site/src/site/markdown/news.md
index dbaf4f9..9837784 100644
--- a/gateway-site/src/site/markdown/news.md
+++ b/gateway-site/src/site/markdown/news.md
@@ -16,4 +16,16 @@ See the License for the specific language governing permissions and
 limitations under the License.
 -->
 ### 2013-03-05
-Started creating the site.
\ No newline at end of file
+Started creating the site.
+
+### Disclaimer
+The Apache Knox Gateway is an effort undergoing incubation at the
+Apache Software Foundation (ASF), 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.
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/incubator-knox/blob/ee15d811/gateway-site/src/site/markdown/release.md
----------------------------------------------------------------------
diff --git a/gateway-site/src/site/markdown/release.md b/gateway-site/src/site/markdown/release.md
new file mode 100644
index 0000000..d9f7ecf
--- /dev/null
+++ b/gateway-site/src/site/markdown/release.md
@@ -0,0 +1,31 @@
+<!---
+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.
+-->
+
+### Release Process
+TODO
+
+### Disclaimer
+The Apache Knox Gateway is an effort undergoing incubation at the
+Apache Software Foundation (ASF), 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.
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/incubator-knox/blob/ee15d811/gateway-site/src/site/site.xml
----------------------------------------------------------------------
diff --git a/gateway-site/src/site/site.xml b/gateway-site/src/site/site.xml
index 3ea04cf..f9e2ec3 100644
--- a/gateway-site/src/site/site.xml
+++ b/gateway-site/src/site/site.xml
@@ -80,6 +80,7 @@
 
         <links>
             <item name="Git" href="https://git-wip-us.apache.org/repos/asf/incubator-knox.git" />
+            <item name="Svn" href="https://svn.apache.org/repos/asf/incubator/knox/site" />
             <item name="Jira" href="https://issues.apache.org/jira/browse/KNOX" />
             <item name="Wiki" href="https://cwiki.apache.org/confluence/display/KNOX/Knox" />
         </links>
@@ -91,22 +92,29 @@
         <menu name="Knox">
             <item name="Welcome" href="index.html"/>
             <item name="News" href="news.html"/>
-            <item name="Project License" href="license.html"/>
+            <item name="License" href="license.html"/>
         </menu>
 
-        <menu name="Releases">
+        <menu name="Documentation">
             <!--
-            <item name="0.2.0 (coming soon)" href="whats-comming.html"/>
+            <item name="Install" href="install"/>
             -->
+            <item name="Client" href="client.html"/>
+            <item name="Wiki" href="https://cwiki.apache.org/confluence/display/KNOX/Knox"/>
         </menu>
 
-        <menu name="Documentation">
-            <item name="Wiki" href="https://cwiki.apache.org/confluence/display/KNOX/Knox"/>
+        <menu name="Releases">
             <!--
-            <item name="Install Guide for 1.2.1" href="1.2.1/installing-hadoop-using-ambari/content/index.html"/>
+            <item name="0.2.0 (coming soon)" href="whats-coming.html"/>
             -->
         </menu>
 
+        <menu name="Processes">
+            <item name="Build" href="build.html"/>
+            <item name="Release" href="release.html"/>
+            <item name="Contribute" href="contribute.html"/>
+        </menu>
+
         <menu name="Resources">
             <item name="Source Code" href="https://git-wip-us.apache.org/repos/asf/incubator-knox.git"/>
             <item name="Project Team" href="team-list.html"/>
@@ -114,9 +122,9 @@
             <item name="Issue Tracking" href="issue-tracking.html"/>
         </menu>
 
-        <menu name="ADF">
+        <menu name="ASF">
             <item name="How Apache Works" href="http://www.apache.org/foundation/how-it-works.html"/>
-            <item name="Foundating" href="http://www.apache.org/foundation/"/>
+            <item name="Foundation" href="http://www.apache.org/foundation/"/>
             <item name="Sponsoring Apache" href="http://www.apache.org/foundation/sponsorship.html"/>
             <item name="Thanks" href="http://www.apache.org/foundation/thanks.html"/>
         </menu>