knox-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From kmin...@apache.org
Subject git commit: Add site documentation for various processing. Implement site publication process in Ant build file.
Date Wed, 20 Mar 2013 03:38:14 GMT
Updated Branches:
  refs/heads/master 786e307be -> 9b5a6ff82


Add site documentation for various processing.
Implement site publication process in Ant build file.


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

Branch: refs/heads/master
Commit: 9b5a6ff821b9462639bc60a68f1578f5e16a9fba
Parents: 786e307
Author: Kevin Minder <kevin.minder@hortonworks.com>
Authored: Tue Mar 19 23:38:09 2013 -0400
Committer: Kevin Minder <kevin.minder@hortonworks.com>
Committed: Tue Mar 19 23:38:09 2013 -0400

----------------------------------------------------------------------
 build.xml                                          |   42 ++++++++++++---
 gateway-site/src/site/markdown/build-process.md    |   11 ++++-
 .../src/site/markdown/contribute-process.md        |   14 ++++-
 gateway-site/src/site/markdown/release-process.md  |   14 +++++-
 gateway-site/src/site/markdown/site-process.md     |   34 ++++++++++++
 gateway-site/src/site/site.xml                     |    3 +-
 6 files changed, 105 insertions(+), 13 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-knox/blob/9b5a6ff8/build.xml
----------------------------------------------------------------------
diff --git a/build.xml b/build.xml
index 958e306..80b766e 100644
--- a/build.xml
+++ b/build.xml
@@ -32,6 +32,13 @@
         <os family="windows" />
     </condition>
 
+    <condition property="svn.cmd" value="svn">
+        <os family="unix" />
+    </condition>
+    <condition property="svn.cmd" value="svn">
+        <os family="windows" />
+    </condition>
+
     <target name="init" description="Initialize the build.">
     </target>
 
@@ -69,15 +76,36 @@
         </zip>
     </target>
 
-    <target name="site" description="Generate and copy the Apache web site.">
-        <exec executable="${mvn.cmd}">
-            <arg value="--file"/>
-            <arg value="gateway-site/pom.xml"/>
+    <target name="publish" description="Generate and publish the Apache web site.">
+        <exec executable="${mvn.cmd}" dir="gateway-site">
+            <arg value="clean"/>
+        </exec>
+        <mkdir dir="gateway-site/target/site"/>
+        <exec executable="${svn.cmd}" dir="gateway-site/target">
+            <arg value="checkout"/>
+            <arg value="https://svn.apache.org/repos/asf/incubator/knox/site"/>
+        </exec>
+        <delete quiet="true" verbose="true">
+            <fileset dir="gateway-site/target/site">
+                <filename name="**/*.html"/>
+                <filename name="**/*.css"/>
+                <filename name="**/*.png"/>
+                <filename name="**/*.gif"/>
+            </fileset>
+        </delete>
+        <exec executable="${mvn.cmd}" dir="gateway-site">
             <arg value="site"/>
         </exec>
-        <copy todir="site" overwrite="true">
-            <fileset dir="gateway-site/target/site"/>
-        </copy>
+        <exec executable="${svn.cmd}" dir="gateway-site/target/site">
+            <arg value="add"/>
+            <arg value="-q"/>
+            <arg value="."/>
+        </exec>
+        <exec executable="${svn.cmd}" dir="gateway-site/target/site">
+            <arg value="commit"/>
+            <arg value="-m"/>
+            <arg value="Publish site from Git repository."/>
+        </exec>
     </target>
 
     <target name="release" depends="init,clean,build,archive" description="Create the
release."/>

http://git-wip-us.apache.org/repos/asf/incubator-knox/blob/9b5a6ff8/gateway-site/src/site/markdown/build-process.md
----------------------------------------------------------------------
diff --git a/gateway-site/src/site/markdown/build-process.md b/gateway-site/src/site/markdown/build-process.md
index fb56939..c7272dc 100644
--- a/gateway-site/src/site/markdown/build-process.md
+++ b/gateway-site/src/site/markdown/build-process.md
@@ -17,7 +17,16 @@ limitations under the License.
 
 Build Process
 -------------
-TODO: Here we will describe how to build the project.
+The following process can be used to build the project without an existing repository clone.
+
+    git clone https://git-wip-us.apache.org/repos/asf/incubator-knox.git knox
+    mvn clean install
+
+If the repository has already been cloned the following process should be used.
+
+    git pull
+    mvn clean install
+
 
 Disclaimer
 ----------

http://git-wip-us.apache.org/repos/asf/incubator-knox/blob/9b5a6ff8/gateway-site/src/site/markdown/contribute-process.md
----------------------------------------------------------------------
diff --git a/gateway-site/src/site/markdown/contribute-process.md b/gateway-site/src/site/markdown/contribute-process.md
index 8c1280f..47afeeb 100644
--- a/gateway-site/src/site/markdown/contribute-process.md
+++ b/gateway-site/src/site/markdown/contribute-process.md
@@ -15,9 +15,17 @@ See the License for the specific language governing permissions and
 limitations under the License.
 -->
 
-Contribution Process
---------------------
-TODO: Here we will describe how to contribute to the project.
+Development & Contribute Process
+================================
+
+Non-Member
+----------
+TODO: Here we will describe how to develop and contribute to the project as a non-member.
+
+Member
+------
+TODO: Here we will describe how to develop and contribute to the project as a member.
+
 
 Disclaimer
 ----------

http://git-wip-us.apache.org/repos/asf/incubator-knox/blob/9b5a6ff8/gateway-site/src/site/markdown/release-process.md
----------------------------------------------------------------------
diff --git a/gateway-site/src/site/markdown/release-process.md b/gateway-site/src/site/markdown/release-process.md
index 5d69a28..74ad5bd 100644
--- a/gateway-site/src/site/markdown/release-process.md
+++ b/gateway-site/src/site/markdown/release-process.md
@@ -17,7 +17,19 @@ limitations under the License.
 
 Release Process
 ---------------
-TODO: Here we will describe how to release the project.
+The Apache Knox Gateway is currently distributed as a single Zip file.
+Following the steps described below this Zip file will be created in the target directory.
+The following process can be used create a release build without an existing repository clone.
+
+    git clone https://git-wip-us.apache.org/repos/asf/incubator-knox.git knox
+    cd knox
+    ant release
+
+If the repository has already been cloned the following process should be used.
+
+    git pull
+    ant release
+
 
 Disclaimer
 ----------

http://git-wip-us.apache.org/repos/asf/incubator-knox/blob/9b5a6ff8/gateway-site/src/site/markdown/site-process.md
----------------------------------------------------------------------
diff --git a/gateway-site/src/site/markdown/site-process.md b/gateway-site/src/site/markdown/site-process.md
new file mode 100644
index 0000000..78a2add
--- /dev/null
+++ b/gateway-site/src/site/markdown/site-process.md
@@ -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.
+-->
+
+Apache Site Publication Process
+-------------------------------
+The following process can be used to publish the generated site to Apache without an existing
repository clone.
+
+    git clone https://git-wip-us.apache.org/repos/asf/incubator-knox.git knox
+    cd knox
+    ant publish
+
+If the repository has already been cloned the following process should be used.
+
+    git pull
+    ant publish
+
+
+
+
+

http://git-wip-us.apache.org/repos/asf/incubator-knox/blob/9b5a6ff8/gateway-site/src/site/site.xml
----------------------------------------------------------------------
diff --git a/gateway-site/src/site/site.xml b/gateway-site/src/site/site.xml
index ebc41f9..a8cdf1c 100644
--- a/gateway-site/src/site/site.xml
+++ b/gateway-site/src/site/site.xml
@@ -99,7 +99,7 @@
             <!--
             <item name="Install" href="install"/>
             -->
-            <item name="Client (KnoxShell)" href="client.html"/>
+            <item name="Client (KnoxShell DSL)" href="client.html"/>
             <item name="Wiki" href="https://cwiki.apache.org/confluence/display/KNOX/Knox"/>
         </menu>
 
@@ -112,6 +112,7 @@
             <item name="Build" href="build-process.html"/>
             <item name="Release" href="release-process.html"/>
             <item name="Contribute" href="contribute-process.html"/>
+            <item name="Site Publication" href="site-process.html"/>
         </menu>
 
         <menu name="Resources">


Mime
View raw message