svn commit: r1444559 - in /tapestry/tapestry-site/trunk: README pom.xml

[bo...@apache.org]

Author: bobharner
Date: Sun Feb 10 16:10:39 2013
New Revision: 1444559

URL: http://svn.apache.org/r1444559
Log:
Turned off checkstyle, simplifiied building of whole site, tweaked the README for how to run the SiteExporer

Modified:
    tapestry/tapestry-site/trunk/README
    tapestry/tapestry-site/trunk/pom.xml

Modified: tapestry/tapestry-site/trunk/README
URL: http://svn.apache.org/viewvc/tapestry/tapestry-site/trunk/README?rev=1444559&r1=1444558&r2=1444559&view=diff
==============================================================================
--- tapestry/tapestry-site/trunk/README (original)
+++ tapestry/tapestry-site/trunk/README Sun Feb 10 16:10:39 2013
@@ -1,38 +1,49 @@
 
-This is the start of an export utility to export the Tapestry
-confluence spaces to the sites. To run this manually, you need to 
-have a copy of the Tapestry website checked out to a local directory:
+This is SiteExporter utility, used to export (publish) the Tapestry Confluence
+wiki content (pages and their attachments) to static web content directories and
+files. To run this manually, you need to have a copy of the Tapestry static
+website checked out to a local directory:
 
-svn checkout https://svn.apache.org/repos/infra/websites/production/tapestry/content
+  svn checkout https://svn.apache.org/repos/infra/websites/production/tapestry/content
 
-Build:
-mvn install
+To build the SiteExporter Java (command-line) program itself:
 
-You will need to pass credentials for a valid confluence user.  This can be
-done in one of two ways:
+  mvn install
 
-1) Command line:
-   -Dconfluence.user=username -Dconfluence.password=password
+To run the SiteExporter program, you will need to pass credentials for a valid
+Confluence user, and specify the directory where the static content resides.
+This can be done in one of two ways:
+
+1) Add a profile to your .m2/settings.xml file, with your user name, password,
+and content directory:
 
-2) Profile in .m2/settings.xml
        <profile>
             <id>confluence</id>
             <properties>
                 <confluence.user>user</confluence.user>
                 <confluence.password>passwd</confluence.password>
+                <cxf.site.output>/path/to/content</cxf.site.output>
             </properties>
         </profile>
 
-To export the space:
-mvn -Pconfluence exec:java -Dcxf.site.output=/path/to/content
-should appear in /path/to/content/
-
-In the confluence profile above, you could add a property like:
-   <cxf.site.output>/path/to/content</cxf.site.output>
-to simplify passing that into the command.
+2) Alternatively, and less conveniently, you can specify the user name, password
+and content directory as system properties on mvn command line:
+
+   -Dconfluence.user=username -Dconfluence.password=password -Dcxf.site.output=/path/to/content
+
+To export only the changed pages in the wiki space (this is normally only
+run from BuildBot):
+
+  mvn -Pconfluence exec:java
+  
+To export ALL pages in the wiki space (for example, after you have changed
+the Velocity template file:
+
+  mvn -Pconfluence,force exec:java
 
-When you commit any changes in the content directory, the changes 
-should be "live" fairly quickly due to the svnpubsub process.
+After you have updated the static content locally, you'll need to commit any
+changes in the content directory via the usual Subversion commit. The changes
+should be "live" in just a few seconds, due to the svnpubsub process.
 
 
 

Modified: tapestry/tapestry-site/trunk/pom.xml
URL: http://svn.apache.org/viewvc/tapestry/tapestry-site/trunk/pom.xml?rev=1444559&r1=1444558&r2=1444559&view=diff
==============================================================================
--- tapestry/tapestry-site/trunk/pom.xml (original)
+++ tapestry/tapestry-site/trunk/pom.xml Sun Feb 10 16:10:39 2013
@@ -39,6 +39,7 @@
         <site.output>${basedir}/content</site.output>
         <cxf.site.output>${site.output}</cxf.site.output>
         <maven.test.skip>true</maven.test.skip>
+        <checkstyle.skip>true</checkstyle.skip>
     </properties>
 
     <dependencies>
@@ -90,7 +91,7 @@
                             <argument>${extra.arg}</argument>
                             <argument>${svn.arg1}</argument>
                             <argument>${svn.arg2}</argument>
-                            <!--argument>-force</argument-->
+                            <argument>${force.arg}</argument>
                             <argument>${basedir}/template/main.cfg</argument>
                         </arguments>
                     </configuration>
@@ -99,8 +100,22 @@
         </pluginManagement>
     </build>
 
-
     <profiles>
+
+        <!--
+            Invoke the "force" profile to for a rebuild of all static content:
+                            mvn exec:java -P force
+            Do this after changing the velocity template (template.vm), for
+            example.
+         -->
+        <profile>
+            <id>force</id>
+            <properties>
+                <force.arg>-force</force.arg>
+            </properties>
+        </profile>
+
+        <!-- Invoke the "svn" profile to cause a svn commit of changes -->
         <profile>
             <id>svn</id>
             <properties>
@@ -108,5 +123,6 @@
                 <svn.arg2>-commit</svn.arg2>
             </properties>
         </profile>
+
     </profiles>
 </project>