forrest-site-svn mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From cross...@apache.org
Subject svn commit: r952109 - in /forrest/site: howto-forrestbot-svn.html procedures/How_to_publish_docs.html tools/forrestbot.html
Date Mon, 07 Jun 2010 05:42:37 GMT
Author: crossley
Date: Mon Jun  7 05:42:36 2010
New Revision: 952109

URL: http://svn.apache.org/viewvc?rev=952109&view=rev
Log:
 Publish from forrestbot

Modified:
    forrest/site/howto-forrestbot-svn.html
    forrest/site/procedures/How_to_publish_docs.html
    forrest/site/tools/forrestbot.html

Modified: forrest/site/howto-forrestbot-svn.html
URL: http://svn.apache.org/viewvc/forrest/site/howto-forrestbot-svn.html?rev=952109&r1=952108&r2=952109&view=diff
==============================================================================
--- forrest/site/howto-forrestbot-svn.html (original)
+++ forrest/site/howto-forrestbot-svn.html Mon Jun  7 05:42:36 2010
@@ -263,9 +263,6 @@ document.write("Last Published: " + docu
 <a href="#follow">Follow along on your local system</a>
 </li>
 <li>
-<a href="#settings">The deploy.svn.settings file</a>
-</li>
-<li>
 <a href="#buildfile">The Forrestbot buildfile</a>
 </li>
 <li>
@@ -369,18 +366,7 @@ document.write("Last Published: " + docu
         <a href="http://svn.apache.org/repos/asf/forrest/trunk/etc/publishing_our_site.txt">$FORREST_HOME/etc/publishing_our_site.txt</a>
       
 </p>
-<a name="N10066"></a><a name="settings"></a>
-<h3 class="underlined_5">The deploy.svn.settings file</h3>
-<p>
-        As explained in the above document, each committer needs a
-        <span class="codefrag">deploy.svn.settings</span> file to provide their
credentials.
-      </p>
-<pre class="code">&lt;?xml version="1.0"?&gt;
-&lt;project&gt;
-  &lt;property name="deploy.svn.user" value="myApacheUsername"/&gt;
-  &lt;property name="deploy.svn.password" value="mySvnPassword"/&gt;
-&lt;/project&gt;</pre>
-<a name="N10077"></a><a name="buildfile"></a>
+<a name="N10066"></a><a name="buildfile"></a>
 <h3 class="underlined_5">The Forrestbot buildfile</h3>
 <p>
         The Forrestbot buildfile sets some properties and declares the workstages (i.e. Ant
targets) that need to be carried out. Of course this is fully explained in the <a href="tools/forrestbot.html">Forrestbot</a>
@@ -395,7 +381,6 @@ document.write("Last Published: " + docu
 &lt;project name="forrest-docs" default="main"&gt;
   &lt;property name="getsrc.local.root-dir" location="."/&gt;
   &lt;target name="getsrc" depends="getsrc.clean-workdir, getsrc.local"/&gt;
-  &lt;import file="../deploy.svn.settings" optional="true"/&gt;
   &lt;property name="deploy.svn.url"
     value="https://svn.apache.org/repos/asf/forrest/site"/&gt;
   &lt;target name="deploy" depends="deploy.svn"/&gt;
@@ -410,7 +395,7 @@ document.write("Last Published: " + docu
 <p>
         It deploys the generated files directly to the forrest/site SVN repository.
       </p>
-<a name="N10099"></a><a name="build"></a>
+<a name="N10088"></a><a name="build"></a>
 <h3 class="underlined_5">The "build" workstage</h3>
 <p>
         After doing the usual process to edit source documents, review them with
@@ -427,7 +412,7 @@ forrest -f publish.xml build</pre>
 <p>
         To review, see the built docs in <span class="codefrag">build/forrest-docs</span>
directory.
       </p>
-<a name="N100B3"></a><a name="deploy"></a>
+<a name="N100A2"></a><a name="deploy"></a>
 <h3 class="underlined_5">The "deploy" workstage</h3>
 <p>
         When satisfied, then deploy the built docs:
@@ -446,7 +431,7 @@ forrest -f publish.xml build</pre>
         The files that are being committed will now be listed. That is it.
         They are now in the "<a href="http://svn.apache.org/repos/asf/forrest/site">forrest/site</a>"
SVN repository.
       </p>
-<a name="N100CE"></a><a name="production"></a>
+<a name="N100BD"></a><a name="production"></a>
 <h3 class="underlined_5">Moving the documents into production</h3>
 <p>
         Next a cron job on the server will automatically publish it.
@@ -462,12 +447,12 @@ svn update</pre>
         about how the ASF project websites are managed.
       </p>
 </div>
-<a name="N100E3"></a><a name="faqs"></a>
+<a name="N100D2"></a><a name="faqs"></a>
 <h2 class="underlined_10">Frequently Asked Questions</h2>
 <div class="section">
-<a name="N100E7"></a><a name="faq-general"></a>
+<a name="N100D6"></a><a name="faq-general"></a>
 <h3 class="underlined_5">1 General issues</h3>
-<a name="N100EB"></a><a name="1.1+Why+all+the+svn+warnings+about+%22is+already+under+version+control%22"></a>
+<a name="N100DA"></a><a name="1.1+Why+all+the+svn+warnings+about+%22is+already+under+version+control%22"></a>
 <h4>1.1 Why all the svn warnings about "is already under version control"</h4>
 <p>
             The deploy workstage does 'svn add' for all the generated documents
@@ -476,14 +461,14 @@ svn update</pre>
             changed. So the warning messages are issued for the existing, updated
             documents.
           </p>
-<a name="N100F3"></a><a name="1.2+Why+is+every+PDF+document+being+deployed%2C+even+though+they+have+not+changed."></a>
+<a name="N100E2"></a><a name="1.2+Why+is+every+PDF+document+being+deployed%2C+even+though+they+have+not+changed."></a>
 <h4>1.2 Why is every PDF document being deployed, even though they have not changed.</h4>
 <p>
             The PDF plugins FOP library is automatically adding a datestamp to
             every generated document. We need to find a solution.
           </p>
 </div>
-<a name="N100FB"></a><a name="Further-Reading"></a>
+<a name="N100EA"></a><a name="Further-Reading"></a>
 <h2 class="underlined_10">Further Reading</h2>
 <div class="section">
 <ul>

Modified: forrest/site/procedures/How_to_publish_docs.html
URL: http://svn.apache.org/viewvc/forrest/site/procedures/How_to_publish_docs.html?rev=952109&r1=952108&r2=952109&view=diff
==============================================================================
--- forrest/site/procedures/How_to_publish_docs.html (original)
+++ forrest/site/procedures/How_to_publish_docs.html Mon Jun  7 05:42:36 2010
@@ -285,19 +285,6 @@ document.write("Last Published: " + docu
 <h2 class="underlined_10">Updating the site with a local forrestbot</h2>
 <div class="section">
 <p>
-        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:
-      </p>
-<pre class="code">
-&lt;?xml version="1.0"?&gt;
-&lt;project&gt;
-    &lt;property name="deploy.svn.user" value="myApacheUsername"/&gt;
-    &lt;property name="deploy.svn.password" value="myPassword"/&gt;
-&lt;/project&gt;
-      </pre>
-<p>
         Generating and publishing the main docs is very easy using a local
         forrestbot:
       </p>
@@ -334,7 +321,7 @@ $FORREST_HOME/tools/ant/bin/ant deploy-d
       </p>
 </div>
     
-<a name="N10062"></a><a name="OrgDoc"></a>
+<a name="N1005B"></a><a name="OrgDoc"></a>
 <h2 class="underlined_10">original docs</h2>
 <div class="section">
 <p>
@@ -346,21 +333,7 @@ $FORREST_HOME/tools/ant/bin/ant deploy-d
 
                 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:
-                &lt;?xml version="1.0"?&gt;
-                &lt;project&gt;
-                    &lt;property name="deploy.svn.user" value="myApacheUsername"/&gt;
-                    &lt;property name="deploy.svn.password" value="myPassword"/&gt;
-                &lt;/project&gt;
-                
-                
                 # Make changes to sources, and then test, then commit.
-                # Best to wait on committing the source changes until
-                # you have built and reviewed the docs.
 
                 # Please, please, ensure valid xml docs. Errors will be
                 # reported during the 'build' phase if you don't.
@@ -386,10 +359,6 @@ $FORREST_HOME/tools/ant/bin/ant deploy-d
                 ----------------------
                 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.
                  
       </pre>
 <p>

Modified: forrest/site/tools/forrestbot.html
URL: http://svn.apache.org/viewvc/forrest/site/tools/forrestbot.html?rev=952109&r1=952108&r2=952109&view=diff
==============================================================================
--- forrest/site/tools/forrestbot.html (original)
+++ forrest/site/tools/forrestbot.html Mon Jun  7 05:42:36 2010
@@ -887,17 +887,8 @@ document.write("Last Published: " + docu
               
 <td colspan="1" rowspan="1">deploy.svn.user</td>
               <td colspan="1" rowspan="1">SVN username to use when committing changes</td>
-              <td colspan="1" rowspan="1"></td>
-              <td colspan="1" rowspan="1">Yes</td>
-            
-</tr>
-            
-<tr>
-              
-<td colspan="1" rowspan="1">deploy.svn.password</td>
-              <td colspan="1" rowspan="1">SVN password</td>
-              <td colspan="1" rowspan="1"></td>
-              <td colspan="1" rowspan="1">Yes</td>
+              <td colspan="1" rowspan="1">Default is the system username.</td>
+              <td colspan="1" rowspan="1">No</td>
             
 </tr>
             
@@ -921,7 +912,11 @@ document.write("Last Published: " + docu
 </tr>
           
 </table>
-<a name="N104E8"></a><a name="deploy.ftp"></a>
+<p>
+            This uses the "svn" executable expected to be present, and its
+            authorisation mechanism.
+          </p>
+<a name="N104D6"></a><a name="deploy.ftp"></a>
 <h4>deploy.ftp</h4>
 <table class="ForrestTable" cellspacing="1" cellpadding="4">
             
@@ -972,7 +967,7 @@ document.write("Last Published: " + docu
 </tr>
           
 </table>
-<a name="N10565"></a><a name="notify"></a>
+<a name="N10553"></a><a name="notify"></a>
 <h4>notify</h4>
 <p>
             These settings are used by all notify implementations.
@@ -1045,12 +1040,12 @@ document.write("Last Published: " + docu
 </tr>
           
 </table>
-<a name="N1060F"></a><a name="notify.local"></a>
+<a name="N105FD"></a><a name="notify.local"></a>
 <h4>notify.local</h4>
 <p>
             No properties.
           </p>
-<a name="N10619"></a><a name="notify.email"></a>
+<a name="N10607"></a><a name="notify.email"></a>
 <h4>notify.email</h4>
 <table class="ForrestTable" cellspacing="1" cellpadding="4">
             
@@ -1093,7 +1088,7 @@ document.write("Last Published: " + docu
 </table>
 </div>
     
-<a name="N10681"></a><a name="Forrestbot+Design"></a>
+<a name="N1066F"></a><a name="Forrestbot+Design"></a>
 <h2 class="underlined_10">Forrestbot Design</h2>
 <div class="section">
 <p>
@@ -1141,7 +1136,7 @@ document.write("Last Published: " + docu
       </p>
 </div>
     
-<a name="N106B6"></a><a name="refs"></a>
+<a name="N106A4"></a><a name="refs"></a>
 <h2 class="underlined_10">Further Reading</h2>
 <div class="section">
 <ul>



Mime
View raw message