Author: crossley
Date: Mon Jun 7 07:18:14 2010
New Revision: 952121
URL: http://svn.apache.org/viewvc?rev=952121&view=rev
Log:
Fix docs for:
Use plain svn commands rather than JSVN.
Issue: FOR-1198
Modified:
forrest/trunk/etc/publishing_our_site.txt
forrest/trunk/site-author/content/xdocs/howto-forrestbot-svn.xml
forrest/trunk/site-author/content/xdocs/procedures/How_to_publish_docs.xml
forrest/trunk/site-author/content/xdocs/tools/forrestbot.xml
forrest/trunk/site-author/publish.xml
forrest/trunk/tools/forrestbot/forrest.xml
Modified: forrest/trunk/etc/publishing_our_site.txt
URL:
http://svn.apache.org/viewvc/forrest/trunk/etc/publishing_our_site.txt?rev=952121&r1=952120&r2=952121&view=diff
==============================================================================
--- forrest/trunk/etc/publishing_our_site.txt (original)
+++ forrest/trunk/etc/publishing_our_site.txt Mon Jun 7 07:18:14 2010
@@ -1,15 +1,11 @@
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.
-# Set its file permissions so that only you can read it.
-# The deploy.svn.settings file looks like:
+If your "svn username" is different from your local system username
+create $FORREST_HOME/deploy.svn.settings file like:
<?xml version="1.0"?>
<project>
<property name="deploy.svn.user" value="myApacheUsername"/>
- <property name="deploy.svn.password" value="mySvnPassword"/>
</project>
@@ -22,13 +18,13 @@ Do once:
]$ 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 automatically updated from there.
+Periodically on the server, the website files are automatically updated
+from that repository.
You do not need to do anything else.
For more information, see:
http://forrest.apache.org/procedures/How_to_publish_docs.html
http://forrest.apache.org/howto-forrestbot-svn.html
-----------------------
Note: The first time that you deploy, it will need to do
a long svn checkout first.
Modified: forrest/trunk/site-author/content/xdocs/howto-forrestbot-svn.xml
URL:
http://svn.apache.org/viewvc/forrest/trunk/site-author/content/xdocs/howto-forrestbot-svn.xml?rev=952121&r1=952120&r2=952121&view=diff
==============================================================================
--- forrest/trunk/site-author/content/xdocs/howto-forrestbot-svn.xml (original)
+++ forrest/trunk/site-author/content/xdocs/howto-forrestbot-svn.xml Mon Jun 7
07:18:14 2010
@@ -89,13 +89,13 @@
<section id="settings">
<title>The deploy.svn.settings file</title>
<p>
- As explained in the above document, each committer needs a
- <code>deploy.svn.settings</code> file to provide their credentials.
+ As explained in the above document,
+ if your "svn username" is different from your local system username
+ create <code>$FORREST_HOME/deploy.svn.settings</code> file like:
</p>
<source><![CDATA[<?xml version="1.0"?>
<project>
<property name="deploy.svn.user" value="myApacheUsername"/>
- <property name="deploy.svn.password" value="mySvnPassword"/>
</project>]]></source>
</section>
<section id="buildfile">
Modified:
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=952121&r1=952120&r2=952121&view=diff
==============================================================================
--- forrest/trunk/site-author/content/xdocs/procedures/How_to_publish_docs.xml
(original)
+++ forrest/trunk/site-author/content/xdocs/procedures/How_to_publish_docs.xml
Mon Jun 7 07:18:14 2010
@@ -47,19 +47,6 @@
<section id="forrestbot-local">
<title>Updating the site with a local forrestbot</title>
<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>
- <source>
-<![CDATA[<?xml version="1.0"?>
-<project>
- <property name="deploy.svn.user" value="myApacheUsername"/>
- <property name="deploy.svn.password" value="myPassword"/>
-</project>]]>
- </source>
- <p>
Generating and publishing the main docs is very easy using a local
forrestbot:
</p>
@@ -67,6 +54,11 @@
forrest -f publish.xml build
forrest -f publish.xml deploy</source>
<p>
+ Note: if your system username is not the same as your "svn username"
+ then provide a "deploy.svn.settings" file as explained at
+ <code>$FORREST_HOME/etc/publishing_our_site.txt</code>
+ </p>
+ <p>
This builds the documentation locally then deploys it by committing it
to the
<a href="http://svn.apache.org/repos/asf/forrest/site";>forrest/site
@@ -106,21 +98,7 @@ $FORREST_HOME/tools/ant/bin/ant deploy-d
<![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.
- # 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.
@@ -146,10 +124,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.
]]>
</source>
<p>
Modified: forrest/trunk/site-author/content/xdocs/tools/forrestbot.xml
URL:
http://svn.apache.org/viewvc/forrest/trunk/site-author/content/xdocs/tools/forrestbot.xml?rev=952121&r1=952120&r2=952121&view=diff
==============================================================================
--- forrest/trunk/site-author/content/xdocs/tools/forrestbot.xml (original)
+++ forrest/trunk/site-author/content/xdocs/tools/forrestbot.xml Mon Jun 7
07:18:14 2010
@@ -513,15 +513,13 @@
</tr>
<tr>
<td>deploy.svn.user</td>
- <td>SVN username to use when committing changes</td>
- <td></td>
- <td>Yes</td>
- </tr>
- <tr>
- <td>deploy.svn.password</td>
- <td>SVN password</td>
- <td></td>
- <td>Yes</td>
+ <td>
+ SVN username to use when committing changes.
+ If your "svn username" is not the same as your local system
+ username, then see explanation below.
+ </td>
+ <td>Local system username.</td>
+ <td>No</td>
</tr>
<tr>
<td>deploy.svn.url</td>
@@ -537,6 +535,18 @@
<td>No</td>
</tr>
</table>
+ <p>
+ This uses the "svn" executable expected to be present, and its
+ authorisation mechanism.
+ </p>
+ <p>
+ If your "svn username" is different from your local system username
+ create <code>$FORREST_HOME/deploy.svn.settings</code> file like:
+ </p>
+ <source><![CDATA[<?xml version="1.0"?>
+<project>
+ <property name="deploy.svn.user" value="myApacheUsername"/>
+</project>]]></source>
</section>
<section id="deploy.ftp">
<title>deploy.ftp</title>
Modified: forrest/trunk/site-author/publish.xml
URL:
http://svn.apache.org/viewvc/forrest/trunk/site-author/publish.xml?rev=952121&r1=952120&r2=952121&view=diff
==============================================================================
--- forrest/trunk/site-author/publish.xml (original)
+++ forrest/trunk/site-author/publish.xml Mon Jun 7 07:18:14 2010
@@ -18,10 +18,6 @@
<project name="forrest-docs" default="main">
<property name="getsrc.local.root-dir" location="."/>
<target name="getsrc" depends="getsrc.clean-workdir, getsrc.local"/>
-<!-- create this secret file to be an ant project (not stored in CVS or SVN)
- that sets deploy.svn.user and deploy.svn.password properties.
- See forrest/etc/publishing_our_site.txt
- -->
<import file="../deploy.svn.settings" optional="true"/>
<property name="deploy.svn.url"
value="https://svn.apache.org/repos/asf/forrest/site"/>
<target name="deploy" depends="deploy.svn"/>
Modified: forrest/trunk/tools/forrestbot/forrest.xml
URL:
http://svn.apache.org/viewvc/forrest/trunk/tools/forrestbot/forrest.xml?rev=952121&r1=952120&r2=952121&view=diff
==============================================================================
--- forrest/trunk/tools/forrestbot/forrest.xml (original)
+++ forrest/trunk/tools/forrestbot/forrest.xml Mon Jun 7 07:18:14 2010
@@ -18,8 +18,6 @@
<project name="forrest" default="main">
<property name="getsrc.svn.url"
value="http://svn.apache.org/repos/asf/forrest/trunk"/>
<target name="getsrc" depends="getsrc.clean-workdir, getsrc.svn"/>
-<!-- create this file to be an ant project (not stored in CVS or SVN)
- that sets deploy.svn.user and deploy.svn.password propeties -->
<import file="deploy.svn.settings" optional="true"/>
<property name="deploy.svn.url"
value="https://svn.apache.org/repos/asf/forrest/site"/>
<target name="deploy" depends="deploy.svn"/>
