Permalink
Browse files

Start to rework publishing instructions

git-svn-id: https://svn.apache.org/repos/asf/creadur/rat/trunk@1411832 13f79535-47bb-0310-9956-ffa450edef68
  • Loading branch information...
1 parent 9eb45c1 commit cfa7a84b4bae42733f49ced23dc3213c0b81fbf3 @itstechupnorth itstechupnorth committed Nov 20, 2012
Showing with 30 additions and 32 deletions.
  1. +30 −32 src/site/apt/site-publish.apt
@@ -20,54 +20,52 @@
How to publish the Rat website
- * Make your changes to the site xml and/or .apt files and commit.
+ The {{{http://creadur.apache.org}Apache Creadur}} project, the community
+ that develops {{{http://creadur.apache.org/rat}Apache Rat}},
+ hosts its website on the
+ {{{http://www.apache.org/dev/cms.html}ASF Content Management System}}.
+ {{{http//maven.apache.org}Apache Maven}} builds Rat, and generates this
+ subsite. Here's (one way) to work with these systems.
- * Buildbot automatically notices the commit and creates a staging site to look at -
+* Developing Content
- See {{{http://ci.apache.org/projects/rat} http://ci.apache.org/projects/rat/}} which is always upto date within a minute of any commit.
-
- * Need to make changes?, no problem, go back to 1 and 2 as often as you like.
-
- * Happy with changes and ready to go live?
-
- Do
+ Build and generate using Maven the usual way
+------------------------------------------+
-mvn site
+mvn clean install site
+------------------------------------------+
- then if successful do
+ Make your changes to the site xml and/or .apt files then launch
+ a server on <<<localhost:8080>>> using
+------------------------------------------+
-mvn site-deploy
+ mvn site:run
+------------------------------------------+
- 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).
+ Review the {{{http://localhost:8080}<<<localhost:8080>>>}} using a browser, and edit.
+ You'll see your change as soon as you refresh the page.
- If you have issues with 'mvn site' failing try running 'mvn clean' then 'mvn install package' before going back and running 'mvn site' again.
+* Committing and Reviewing Content
- If you experience an Out of Memory error <<java.lang.OutOfMemoryError: Java heap space>> when running 'mvn site' try setting 'export MAVEN_OPTS=-Xmx512m'
- or for windows 'set MAVEN_OPTS=-Xmx512m' first on the command line (or in your profile) and then try 'mvn site' again. Only when 'mvn site' is successful
- should you then 'mvn site-deploy'
+ As soon as your changes look okay locally, commit them.
+ {{{http://ci.apache.org/buildbot.html}Buildbot}} automatically
+ notices the commit and creates a staging site to look at
+ {{{http://ci.apache.org/projects/rat} http://ci.apache.org/projects/rat/}}
+ which is always up to date (within a minute of any commit).
- * Wait for the hourly site sync to our www machines and the updated site will be live.
+ Need to make changes? No problem - go back and repeat the cycle as often as you like.
-Using the CMS
+ Happy with changes and ready to go live? Then read on...
- This information is subject to change soon when the project
- switches to using the Apache CMS system; the current state of the
- CMS migration can be seen at {{{http://rat.staging.apache.org/rat/}
- http://rat.staging.apache.org/rat/}}. The site of the original Rat
- product is still generated by mvn via
+* Publishing the Site
-+------------------------------------------+
-mvn site:site
-+------------------------------------------+
+ Publishing updates the main site with changes committed since the last
+ time the site was published.
- and gets deployed via
-+------------------------------------------+
-mvn site:deploy -Pcms
-+------------------------------------------+
+Troubleshooting
+
+ * If you have issues with 'mvn site' failing try running 'mvn clean' then 'mvn install package' before going back and running 'mvn site' again.
+ * If you experience an Out of Memory error <<java.lang.OutOfMemoryError: Java heap space>> when running 'mvn site' try setting 'export MAVEN_OPTS=-Xmx512m'
+ or for windows 'set MAVEN_OPTS=-Xmx512m' first on the command line (or in your profile) and then try 'mvn site' again.

0 comments on commit cfa7a84

Please sign in to comment.