Author: steveh
Date: Thu Feb 3 10:39:42 2005
New Revision: 151199
URL: http://svn.apache.org/viewcvs?view=rev&rev=151199
Log:
(1) Fix for BEEHIVE-127.
(2) Refining instructions for updating live site.
Modified:
incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/pageflow/pageflow_building.xml
incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/pageflow/pageflow_controllers.xml
incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/pageflow/pageflow_jsp.xml
incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/pageflow/tutorial_pageflow.xml
incubator/beehive/trunk/docs/updating_livesite.txt
Modified:
incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/pageflow/pageflow_building.xml
URL:
http://svn.apache.org/viewcvs/incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/pageflow/pageflow_building.xml?view=diff&r1=151198&r2=151199
==============================================================================
---
incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/pageflow/pageflow_building.xml
(original)
+++
incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/pageflow/pageflow_building.xml
Thu Feb 3 10:39:42 2005
@@ -52,7 +52,7 @@
<p>
The top-level of the web-app, at <code>$WEBAPP_DIR</code> should contain
your JSP pages and a <code>Controller.jpf</code>. When built, the
- <code>Controller.jpf</code> will be compiled to
<code>WEB-INF/classes/Controller.jpf</code>.
+ <code>Controller.jpf</code> will be compiled to
<code>WEB-INF/classes/Controller.class</code>.
</p>
Modified:
incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/pageflow/pageflow_controllers.xml
URL:
http://svn.apache.org/viewcvs/incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/pageflow/pageflow_controllers.xml?view=diff&r1=151198&r2=151199
==============================================================================
---
incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/pageflow/pageflow_controllers.xml
(original)
+++
incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/pageflow/pageflow_controllers.xml
Thu Feb 3 10:39:42 2005
@@ -234,7 +234,8 @@
names within the body of a controller method, Beehive once
again uses annotations. The <code>Jpf.Action</code> and
<code>Jpf.Forward</code> annotations are used on each action method to
- build a <strong>forward name to JSP page</strong> mapping. The method
+ build a <strong>mapping</strong> between <strong>forward names</strong>
and
+ <strong>JSP pages</strong>. The method
then works only in terms of the forward name, and doesn't
directly refer to the JSP page path.
</p>
@@ -446,7 +447,7 @@
...
...
- <strong>public static class LoginForm
+ <strong>public static class LoginForm implements java.io.Serializable
{
private String username;
private String password;
Modified:
incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/pageflow/pageflow_jsp.xml
URL:
http://svn.apache.org/viewcvs/incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/pageflow/pageflow_jsp.xml?view=diff&r1=151198&r2=151199
==============================================================================
---
incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/pageflow/pageflow_jsp.xml
(original)
+++
incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/pageflow/pageflow_jsp.xml
Thu Feb 3 10:39:42 2005
@@ -99,9 +99,8 @@
The <code><netui:anchor></code> tag replaces the normal
<code><a></code>
HTML anchor tag. A plain <code><a></code> links directly from one
URL to
another, without providing the controller an opportunity to perform any
conditional
- logic. The <code><netui:anchor></code> tag will be substituted when
the
- page is display to render the correct HTML and Javascript to cause the link
- to venture through the controller class.
+ logic. But the <code><netui:anchor></code> tag is rendered as HTML
and Javascript
+ code, code which causes the link to venture through the controller
class.
</p>
<p>
@@ -122,7 +121,7 @@
<p>
The <code><netui:anchor></code> tag parallels the
<code><a></code>
- tag but uses a <code>action</code> attribute instead of an
<code>href</code>.
+ tag but uses an <code>action</code> attribute instead of an
<code>href</code>.
Instead of specifying the URL to another page, the name of the method
on the controller class is used, without parenthesis.
</p>
Modified:
incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/pageflow/tutorial_pageflow.xml
URL:
http://svn.apache.org/viewcvs/incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/pageflow/tutorial_pageflow.xml?view=diff&r1=151198&r2=151199
==============================================================================
---
incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/pageflow/tutorial_pageflow.xml
(original)
+++
incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/pageflow/tutorial_pageflow.xml
Thu Feb 3 10:39:42 2005
@@ -355,7 +355,7 @@
<p><strong><code>ProfileForm.java</code></strong></p>
<source>package forms;
-public class ProfileForm
+public class ProfileForm implements java.io.Serializable
{
private int age;
private String name;
Modified: incubator/beehive/trunk/docs/updating_livesite.txt
URL:
http://svn.apache.org/viewcvs/incubator/beehive/trunk/docs/updating_livesite.txt?view=diff&r1=151198&r2=151199
==============================================================================
--- incubator/beehive/trunk/docs/updating_livesite.txt (original)
+++ incubator/beehive/trunk/docs/updating_livesite.txt Thu Feb 3 10:39:42 2005
@@ -3,15 +3,22 @@
The following instructions explain how to maintain the Beehive's live
documentation.
-The site is currently posted at http://incubator.apache.org/beehive.
-When Beehive
-leaves incubation, the address will change, in all probability, to
http://beehive.apache.org/
+The site is currently posted at
+
+ http://incubator.apache.org/beehive.
+
+When Beehive leaves incubation, the address will change, in all probability,
to
+
+ http://beehive.apache.org/
The main site address, http://incubator.apache.org/beehive, should display
the docs for the latest release.
Upcoming releases may be posted in an appropriately named sub-directory.
-For example, the upcoming v1beta release is posted at
http://incubator.apache.org/beehive/v1beta
+For example, an upcoming ver.-whatever-beta release should be posted at
+
+ http://incubator.apache.org/beehive/v-whatever-beta
+
Posting of upcoming release docs is primarily for developer review of the
forthcoming docs.
@@ -21,76 +28,72 @@
To update the live site, you must have the following three software
installations:
(a) a Beehive SVN enlistment (See beehive/trunk/BUILDING.txt)
- (b) a secure FTP (SFTP) client installed on your machine
- (c) a SSH client
+ (b) a SCP (Secure file CoPy) client installed on your machine
+ (c) a SSH (Secure SHell) client
-The following instructions assume that you have the Putty SFTP and SSH clients
installed.
+The following instructions assume that you have the Putty SCP and SSH clients
installed.
(Downloadable from http://www.putty.nl/download.html)
If you have different clients, the instructions can be easily modified to work
with
that client (using a bit of common sense). For example, you could easily
replace
-the SFTP client with a SCP client.
+the SCP client with a SFTP (Secure File Transfer Protocol) client.
Before proceding, it is important that your umask (on
cvs.apache.org) is set to "0002" so that group write is set on all the
-files. That way, if the next site update is done by someone else,
-they don't run in to permissions problems because you alone own the files and
-disallow any other member of the "beehive" group from modifying them.
+files. This insures that there are no permissions problems,
+if someone else performs the next site update.
In brief, the process for updating the live site goes as follows:
(1) Make a ZIP file of the latest docs on your local machine.
- (2) Delete the old site from the live, remote machine.
- (3) Upload the ZIP file to the live, remote machine.
- (4) Unzip the ZIP file on the live, remote machine.
+ (2) Upload the ZIP file to the remote (live) machine.
+ (3) Unzip the ZIP file on the remote (live) machine.
(1) Make a ZIP file of the latest docs
--------------------------------------
Run the following Ant command:
- ant -f distribution.xml build.dist.docs build.dist.docs.zip -Ddist.name=site
-
-This will build a ZIP file called "site-docs.zip" and save it at
/beehive/trunk/build/jars/site-docs.zip
-
-
-(2) Delete the old site from the live, remote machine.
------------------------------
+ ant -f distribution.xml build.dist.docs build.livesite
-Open a SSH connection to cvs.apache.org.
+This will build a ZIP file called "site.zip" and save it at
-cd to www/incubator.apache.org/beehive
+ /beehive/trunk/build/jars/site.zip
-Delete the content to be refreshed (rm -r [directory])
+Note: this ZIP file has no top-level directory. If you unzip it, it will
+spew files all over the directory you unzip it into. For this reason, you
should
+take care where you unzip it.
-Re-create the deleted directory (mkdir [directory]). You will upload and
unzip into this directory.
+*Why* does it have no top-level directory?
+Because it is much easier to manage the URL for the live site, if the ZIP file
has no
+URL-determining elements (such as a top-level directory) in it.
-(3) Upload the ZIP file to the live, remove machine
+(2) Upload the ZIP file to the live, remove machine
---------------------------------------------------
-Place the SFTP client on your PATH (e.g., set
PATH=C:\path\to\psftp.exe;%PATH%).
+cd to
-psftp cvs.apache.org (You will be prompted for your username and password.)
+ /beehive/trunk/build/jars/site.zip
-cd to www/incubator.apache.org/beehive/[directory] (This is the target
directory on the remote machine.)
+Run the following commmand:
-lcd to the directory where site-docs.zip resides on your local machine. ( =
trunk/build/docs/)
+ pscp -pw [password] site.zip [EMAIL
PROTECTED]:/www/incubator.apache.org/beehive/[target_dir]
-put site.zip (Uploads the new site-docs.zip to the remote machine.)
+ [password] - your password on cvs.apache.org
+ [username] - your username on cvs.apache.org
+ [target_dir] - the directory where you want the site.zip to go.
+ This could the empty string, especially if you are updating
+ the main live site for a major release of Beehive.
-
-(4) Unzip the ZIP on the live, remote machine
+(3) Unzip the ZIP on the live, remote machine
---------------------------------------------
-Return to the SSH client.
-
-unzip site-docs.zip
-
-The content is now live.
-
-
-
-
+Using the SSH client, make a connection to cvs.apache.org.
+cd to
+
+ /www/incubator.apache.org/beehive/[target_dir]
+unzip site.zip
+The content is now live.
\ No newline at end of file
