forrest-svn mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From ferdin...@apache.org
Subject svn commit: r408587 - in /forrest/trunk/site-author/content/xdocs: procedures/How_to_publish_docs.xml site.xml
Date Mon, 22 May 2006 07:12:28 GMT
Author: ferdinand
Date: Mon May 22 00:12:28 2006
New Revision: 408587

URL: http://svn.apache.org/viewvc?rev=408587&view=rev
Log:
Added minimal version of How_to_publish_docs.xml

Added:
    forrest/trunk/site-author/content/xdocs/procedures/How_to_publish_docs.xml
Modified:
    forrest/trunk/site-author/content/xdocs/site.xml

Added: forrest/trunk/site-author/content/xdocs/procedures/How_to_publish_docs.xml
URL: http://svn.apache.org/viewvc/forrest/trunk/site-author/content/xdocs/procedures/How_to_publish_docs.xml?rev=408587&view=auto
==============================================================================
--- forrest/trunk/site-author/content/xdocs/procedures/How_to_publish_docs.xml (added)
+++ forrest/trunk/site-author/content/xdocs/procedures/How_to_publish_docs.xml Mon May 22
00:12:28 2006
@@ -0,0 +1,77 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+  Copyright 2006 The Apache Software Foundation or its licensors,
+  as applicable.
+
+  Licensed 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.
+-->
+<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V2.0//EN"
+  "http://forrest.apache.org/dtd/document-v20.dtd">
+<document>
+    <header>
+        <title>How to Publish Forrest Documentation</title>
+        <abstract>This documents the steps that the Documentation Coordinator should
follow to update the Forrest
+            Website.</abstract>
+    </header>
+    <body>
+
+        <section id="About">
+            <title>About this Document</title>
+            <fixme author="fso">This is work in progress!</fixme>
+        </section>
+
+        <section id="OrgDoc">
+            <title>original docs</title>
+           
+            <source>
+                <![CDATA[
+                To publish from trunk/site-author/
+                
+                Do once:
+                # Create $FORREST_HOME/deploy.svn.settings file. These credentials
+                # are needed by forrestbot so that it can do your 'svn add'
+                # and 'svn commit' etc. to the forrest/site/ repository.
+                # The deploy.svn.settings file looks like:
+                <?xml version="1.0"?>
+                <project>
+                    <property name="deploy.svn.user" value="myApacheUsername"/>
+                    <property name="deploy.svn.password" value="myPassword"/>
+                </project>
+                
+                
+                # Make changes to sources, and then test, then commit.
+                # Use the forrestbot to build and then deploy to svn.apache.org ...
+                
+                cd site-author
+                forrest -f publish.xml build
+                # ... verify files in build/forrest-docs
+                forrest -f publish.xml deploy -Ddeploy.svn.commit-message="my commit message"
+                
+                Now the files are in SVN at forrest/site
+                Periodically the real website files are updated from there.
+                You do not have to do anything else.
+                
+                ----------------------
+                Note: The first time that you deploy, it will need to do
+                a long svn checkout first.
+                
+                FIXME: That commit message technique does not work.
+                The second word is treated as an ant target to be called.
+                Just leave it out and forrestbot will use a default message.
+                 ]]>
+            </source>
+        </section>
+        
+        
+    </body>
+</document>

Modified: forrest/trunk/site-author/content/xdocs/site.xml
URL: http://svn.apache.org/viewvc/forrest/trunk/site-author/content/xdocs/site.xml?rev=408587&r1=408586&r2=408587&view=diff
==============================================================================
--- forrest/trunk/site-author/content/xdocs/site.xml (original)
+++ forrest/trunk/site-author/content/xdocs/site.xml Mon May 22 00:12:28 2006
@@ -86,6 +86,8 @@
         <zoneMangement label="Zone notes Testbed-Management" description="Notes for committers
to manage forrest.zones.apache.org" href="zone.html"/>
         <howToRelease label="How to release" href="procedures/release/How_to_release.html"
description="Instructions on preparing and
             creating a new Forrest release."/>
+        <howToPublishDocs label="Publishing Forrest Documentation" href="procedures/How_to_publish_docs.html"
description="Instructions on publishing the Forrest
+            Website"/>
     </procedures>
 
   <proposals label="Proposals" tab="project">



Mime
View raw message