You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@beehive.apache.org by Bryan Che <bc...@redhat.com> on 2005/01/25 20:27:47 UTC
Re: svn commit: r126412 - /incubator/beehive/trunk/distribution.xml
/incubator/beehive/trunk/docs/updating_livesite.txt
BTW, the distribution.xml patch I submitted yesterday also has a target
for building a zipfile of docs (along with a tarball). But, I put the
docs in a lower directory so that if you unzip the docs, you don't
accidentally put all the files in your current directory. Instead,
everything unzips into a ${dist.name}-docs directory.
Bryan
steveh@apache.org wrote:
> Author: steveh
> Date: Tue Jan 25 11:22:30 2005
> New Revision: 126412
>
> URL: http://svn.apache.org/viewcvs?view=rev&rev=126412
> Log:
> Adding target for building a ZIP of the live site.
> Added:
> incubator/beehive/trunk/docs/updating_livesite.txt (contents, props changed)
> Modified:
> incubator/beehive/trunk/distribution.xml
>
> Modified: incubator/beehive/trunk/distribution.xml
> Url: http://svn.apache.org/viewcvs/incubator/beehive/trunk/distribution.xml?view=diff&rev=126412&p1=incubator/beehive/trunk/distribution.xml&r1=126411&p2=incubator/beehive/trunk/distribution.xml&r2=126412
> ==============================================================================
> --- incubator/beehive/trunk/distribution.xml (original)
> +++ incubator/beehive/trunk/distribution.xml Tue Jan 25 11:22:30 2005
> @@ -188,6 +188,10 @@
> </copy>
> </target>
>
> + <target name="build.livesite" depends="build.dist.docs" description="Builds a ZIP file to be posted on the live site">
> + <zip basedir="${dist.dir}/docs/" destfile="${dist.dir}/docs/site.zip" />
> + </target>
> +
> <target name="build.dist.archives" description="Builds all Beehive distribution archives (.zip, .tar.gz, etc)">
> <fail unless="beehive.version" message="Could not build distribution archives; beehive.version property not specified!"/>
> <antcall target="build.dist.zip"/>
>
> Added: incubator/beehive/trunk/docs/updating_livesite.txt
> Url: http://svn.apache.org/viewcvs/incubator/beehive/trunk/docs/updating_livesite.txt?view=auto&rev=126412
> ==============================================================================
> --- (empty file)
> +++ incubator/beehive/trunk/docs/updating_livesite.txt Tue Jan 25 11:22:30 2005
> @@ -0,0 +1,63 @@
> +Beehive's Live Documentation Site
> +---------------------------------
> +
> +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 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
> +Posting of upcoming release docs is primarily for developer review of the forthcoming docs.
> +
> +
> +Process for Updating the Live Site
> +----------------------------------
> +
> +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) Upload and and unzip the file on the live, remote machine.
> +
> +To update the live site, you must have both (a) a Beehive SVN enlistment and (b) a secure FTP (SFTP) client installed on your machine.
> +The following instructions assume that you have the Putty SFTP client installed.
> +(Downloadable from http://www.putty.nl/download.html)
> +If you have a different SFTP client, the instructions can be easily modified to work with
> +that client (using a bit of common sense).
> +
> +(1) Make a ZIP file of the latest docs
> +--------------------------------------
> +
> +Run the following Ant command:
> +
> + ant -f distribution.xml build.livesite
> +
> +This will build a ZIP file called "site.zip" and save it at /trunk/build/docs/site.zip
> +
> +(2) Upload and Unzip site.zip
> +-----------------------------
> +
> +Place the SFTP client on your PATH (set PATH=C:\path\to\psftp.exe;%PATH%).
> +
> +psftp cvs.apache.org (You will be prompted for your username and password.)
> +
> +cd to www/incubator.apache.org/beehive (This is the target directory on the remote machine. You may cd to a subdirectory if appropriate.)
> +
> +rm -r [directory] (Deletes the old content from the remote machine.)
> +
> +lcd to the directory where site.zip resides on your local machine. ( = trunk/build/docs/)
> +
> +put site.zip (Uploads the new site.zip to the remote machine.)
> +
> +Make a putty SSH connection, cd to the www/incubator.apache.org/beehive (or whichever subdirectory is appropriate), and unzip the file.
> +
> +
> +
> +
> +
> +
> +