You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@twill.apache.org by ch...@apache.org on 2016/12/17 23:40:35 UTC

twill git commit: Update site building instructions

Repository: twill
Updated Branches:
  refs/heads/site c74b2d9cb -> 72e367091


Update site building instructions

Project: http://git-wip-us.apache.org/repos/asf/twill/repo
Commit: http://git-wip-us.apache.org/repos/asf/twill/commit/72e36709
Tree: http://git-wip-us.apache.org/repos/asf/twill/tree/72e36709
Diff: http://git-wip-us.apache.org/repos/asf/twill/diff/72e36709

Branch: refs/heads/site
Commit: 72e3670915e8e35c102425d409a92028f98727d6
Parents: c74b2d9
Author: Terence Yim <ch...@apache.org>
Authored: Sat Dec 17 15:40:30 2016 -0800
Committer: Terence Yim <ch...@apache.org>
Committed: Sat Dec 17 15:40:30 2016 -0800

----------------------------------------------------------------------
 src/site/README.md | 29 ++++++++++++++++++++++++-----
 1 file changed, 24 insertions(+), 5 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/twill/blob/72e36709/src/site/README.md
----------------------------------------------------------------------
diff --git a/src/site/README.md b/src/site/README.md
index 6dc7b75..e638097 100644
--- a/src/site/README.md
+++ b/src/site/README.md
@@ -21,9 +21,28 @@ Apache Twill Site Update Instructions
 
 1. Publish snapshot artifacts to maven
 
-    git checkout master
+        git checkout master
 
-    mvn clean prepare-package -DskipTests -Dremoteresources.skip=true -P hadoop-2.0 &&
-    mvn prepare-package -DskipTests -Dremoteresources.skip=true -P hadoop-2.3 &&
-    mvn deploy -DskipTests -Dremoteresources.skip=true -P hadoop-2.3 -P apache-release
-1.
\ No newline at end of file
+        mvn clean prepare-package -DskipTests -Dremoteresources.skip=true -P hadoop-2.0 &&
+        mvn prepare-package -DskipTests -Dremoteresources.skip=true -P hadoop-2.3 &&
+        mvn deploy -DskipTests -Dremoteresources.skip=true -P hadoop-2.3 -P apache-release
+1. Build javadocs for the newly released version
+
+        git checkout branch-${RELEASE_VERSION}
+
+        mvn javadoc:aggregate
+1. Copy the javadocs generated in previous step to site directory
+
+        git checkout site
+        
+        cp -r target/site/apidocs src/site/resources/apidocs-${RELEASE_VERSION}
+1. Update release version and link in `src/site/markdown/index.md`
+1. Create new release page markdown file `src/site/markdown/release/${RELEASE_VERSION}.md`.
+   You can base on the previous release page and update accordingly.
+1. Update the `src/site/site.xml` file to add new release information.
+1. Build the site
+
+        mvn clean site -DskipTests -P site
+   All Twill website files will be generated at the `target/site` directory
+1. Update and check-in changes in SVN `https://svn.apache.org/repos/asf/twill/site`.
+        
\ No newline at end of file