svn commit: r1083669 - in /incubator/rat/main/trunk/src/site: apt/site-publish.apt site.xml

[gm...@apache.org]

Author: gmcdonald
Date: Mon Mar 21 03:44:07 2011
New Revision: 1083669

URL: http://svn.apache.org/viewvc?rev=1083669&view=rev
Log:
Add minimal docs on how to publish the RAT website using Maven.

Added:
    incubator/rat/main/trunk/src/site/apt/site-publish.apt   (with props)
Modified:
    incubator/rat/main/trunk/src/site/site.xml

Added: incubator/rat/main/trunk/src/site/apt/site-publish.apt
URL: http://svn.apache.org/viewvc/incubator/rat/main/trunk/src/site/apt/site-publish.apt?rev=1083669&view=auto
==============================================================================
--- incubator/rat/main/trunk/src/site/apt/site-publish.apt (added)
+++ incubator/rat/main/trunk/src/site/apt/site-publish.apt Mon Mar 21 03:44:07 2011
@@ -0,0 +1,29 @@
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+~~ 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.
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+   --------------------
+   Publishing this site
+   --------------------
+
+How to publish the RAT website
+
+  1. Make your changes to the site xml and/or .apt files and commit.
+  2. Buildbot automatically notices the commit and creates a staging site to look at -
+   See {{{http://ci.apache.org/projects/rat} http://ci.apache.org/projects/rat/}} which is always upto date within a minute of any commit.
+  3. Need to make changes, no problem, go back to 1 and 2 as often as you like.
+  4. Happy with changes and ready to go live?
+   Do 'mvn site-deploy' from your local machine in the root of your RAT checkout, this will scp the site file to 
+   /www/incubator.apache.org/rat/ on minotaur (people.apache.org).
+  5. Wait for the hourly site sync to our www machines and the updated site will be live.
+
+

Propchange: incubator/rat/main/trunk/src/site/apt/site-publish.apt
------------------------------------------------------------------------------
    svn:eol-style = native

Modified: incubator/rat/main/trunk/src/site/site.xml
URL: http://svn.apache.org/viewvc/incubator/rat/main/trunk/src/site/site.xml?rev=1083669&r1=1083668&r2=1083669&view=diff
==============================================================================
--- incubator/rat/main/trunk/src/site/site.xml (original)
+++ incubator/rat/main/trunk/src/site/site.xml Mon Mar 21 03:44:07 2011
@@ -22,6 +22,10 @@
       <item name="Changes" href="/RELEASE_NOTES.txt"/>
     </menu>
 
+    <menu name="Committer Info">
+      <item name="Publish this site" href="site-publish.html"/>
+    </menu>
+
     <menu ref="modules"/>
     <menu ref="reports"/>
   </body>