You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@rave.apache.org by ja...@apache.org on 2011/07/06 11:42:31 UTC
svn commit: r1143318 - in /incubator/rave/site/trunk:
content/rave/ide-settings-and-debugging.mdtext content/rave/source.mdtext
templates/sidenav.mdtext
Author: jasha
Date: Wed Jul 6 09:42:31 2011
New Revision: 1143318
URL: http://svn.apache.org/viewvc?rev=1143318&view=rev
Log:
RAVE-65 Split up 'source code' into 'Getting started' and 'IDE Settings and debugging'. Add JRebel information.
Added:
incubator/rave/site/trunk/content/rave/ide-settings-and-debugging.mdtext
Modified:
incubator/rave/site/trunk/content/rave/source.mdtext
incubator/rave/site/trunk/templates/sidenav.mdtext
Added: incubator/rave/site/trunk/content/rave/ide-settings-and-debugging.mdtext
URL: http://svn.apache.org/viewvc/incubator/rave/site/trunk/content/rave/ide-settings-and-debugging.mdtext?rev=1143318&view=auto
==============================================================================
--- incubator/rave/site/trunk/content/rave/ide-settings-and-debugging.mdtext (added)
+++ incubator/rave/site/trunk/content/rave/ide-settings-and-debugging.mdtext Wed Jul 6 09:42:31 2011
@@ -0,0 +1,162 @@
+Title: IDE Settings and Debugging
+Notice: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you 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.
+
+## Configuring Eclipse
+
+ * Install [Eclipse for Java EE][1]
+ * Install M2Eclipse from the [Update Site][2]
+ * Install [Subclipse][3]
+ * File -> Import -> Maven -> Check Out maven project from SCM
+ * select SVN
+ * URL is https://svn.apache.org/repos/asf/incubator/rave/trunk
+ * Ensure rave-portal is building without errors
+ * you may need to update dependencies first
+ * With m2eclipse you can configure it to automatically resolve
+ (download) missing dependencies if you have set Eclipse
+ Preferences/Maven/Offline to false (unchecked), which should be
+ the default. We recommend you always set that preference to true
+ (checked) as this one specific feature of m2eclipse is often a
+ performance drain (Update Maven projects on startup being the
+ other).
+
+Now the application is building you probably want to be able to develop and debug
+Rave from inside Eclipse. This gives a faster turnaround in the
+edit/build/deploy cycle.
+
+There are a few different ways to do this:
+
+### Using Remote debugging and the Eclipse FileSync plugin
+
+The OSS [Eclipse FileSync][4] plugin can automatically synchronize (re)source changes
+(e.g. .jsp, .css, .js) made in the Eclipse IDE directly to the runtime tomcat deployment
+started (separately) through maven cargo:start. And you can attach the Eclipse debugger
+to the cargo started Tomcat instance (see above) as remote application on default port 8000.
+
+The [maven-filesync-plugin][5] is pre-configured to generate default Eclipse FileSync
+configurations for the rave-shindig and rave-portal projects, mapping their source folders
+src/main/webapps and src/main/resources to synchronize (copy) changes to the Tomcat deployment
+environment under rave-portal/target/Tomcat6x, so this will work out-of-the-box.
+
+Prerequisite: install the Eclipse FileSync plugin from its [Update Site][6]
+
+The first time you build the Rave project with maven, the maven-filesync-plugin
+will generate this default FileSync configuration for the FileSync plugin.
+Afterwards you only have to refresh the Eclipse projects once to have them recognize this.
+Thereafter you can customize the synchronization configuration manually within Eclipse through
+the project properties dialog.
+Note: manual changes will not be overridden anymore by the maven-filesync-plugin once they
+exist. Furthermore, if you are not using Eclipse, this plugin will simply skip its execution.
+
+If you have "Build automatically" enabled within Eclipse, the FileSync plugin will synchronize
+changes automatically after you saved them in Eclipse. Otherwise you can force a manual
+synchronization from the project (rave-portal or rave-shindig) its context menu actions.
+
+### Using Remote debugging with the JRebel plugin
+
+Using [JRebel][7] provides one the best remote debugging and runtime code change synchronizing
+solutions, as well as can handle resource (non-code) change synchronization.
+
+However, JRebel is not free. If you are a committer you can get a free licence, but if not you
+will need to buy your own licence (you can try out a free 30 day trial licence first).
+
+#### Setting up the JRebel plugin
+To enable JRebel for the Rave project add the following profile to the rave-project (root) pom:
+
+ <profile>
+ <id>jrebel</id>
+ <activation>
+ <property>
+ <name>jrebel</name>
+ </property>
+ </activation>
+ <properties>
+ <javaagent>-javaagent:${env.REBEL_HOME}/jrebel.jar</javaagent>
+ </properties>
+ <build>
+ <plugins>
+ <plugin>
+ <groupId>org.zeroturnaround</groupId>
+ <artifactId>jrebel-maven-plugin</artifactId>
+ <version>1.0.7</version>
+ <executions>
+ <execution>
+ <id>generate-rebel-xml</id>
+ <phase>process-resources</phase>
+ <goals>
+ <goal>generate</goal>
+ </goals>
+ </execution>
+ </executions>
+ </plugin>
+ </plugins>
+ </build>
+ </profile>
+
+To build the Rave project with JRebel descriptors run
+
+ mvn install -Djrebel
+
+The same profile also takes care of enabling the JRebel java agent when running Cargo.
+To run Cargo with JRebel enabled, use the following command from the rave-portal directory:
+
+ mvn cargo:run -Djrebel
+
+Note: using both the Eclipse FileSync plugin for (only) resources synchronization and JRebel
+for the hot-code replacement probably will provide the best combination with the least
+configuration overhead.
+
+### Using Eclipse WTP
+The Rave project can also be deployed through Eclipse WTP, and might be adequate for some, but it
+it is less functional and sometimes a bit quirky. Furthermore, because of (current) limitations
+of the m2eclipse WTP integration for maven war overlays (which the rave-shindig project uses),
+you'll need to use some workarounds to make it workable.
+
+Prerequisite: Install m2eclipse-wtp integration from the m2eclipse-extras [Update Site][8]
+
+If you already imported the Rave projects in Eclipse, first remove them (but don't need to delete them)
+and then (re)import the Rave project as Maven projects to get the m2eclipse-wtp integration enabled.
+
+Then you need to follow these steps:
+
+ * Right click on the rave-shindig project and select Properties
+ * Open the "Deployment Assembly" property
+ * Press Add, select Directive Type "Folder", and select the
+ target/rave-shindig-0.1-incubating-SNAPSHOT folder.
+ (do a "mvn install" in rave-project first for this folder to be available)
+ * configure the correct Context root paths for rave-portal
+ ("portal") and rave-shindig ("/") in their Eclipse project
+ properties under "Web Project Settings"
+
+Now we need to add the the two webapps to a pre-setup (Tomcat 6) server:
+
+ * Windows->Show View->Other...
+ * Server->Servers
+ * OK
+ * In the servers view right click your chosen server and slect Add and Remove...
+ * Add rave-shindig and rave-portal
+ * Start the server
+ * Now see the instructions above for logging into the server
+
+[1]: http://download.eclipse.org/webtools/downloads/
+[2]: http://m2eclipse.sonatype.org/sites/m2e
+[3]: http://subclipse.tigris.org/update_1.6.x/
+[4]: http://andrei.gmxhome.de/filesync/index.html
+[5]: http://code.google.com/p/mavenfilesync/
+[6]: http://andrei.gmxhome.de/eclipse/
+[7]: http://www.zeroturnaround.com/jrebel/how-to-install-jrebel-for-eclipse/
+[8]: http://m2eclipse.sonatype.org/sites/m2e-extras
\ No newline at end of file
Modified: incubator/rave/site/trunk/content/rave/source.mdtext
URL: http://svn.apache.org/viewvc/incubator/rave/site/trunk/content/rave/source.mdtext?rev=1143318&r1=1143317&r2=1143318&view=diff
==============================================================================
--- incubator/rave/site/trunk/content/rave/source.mdtext (original)
+++ incubator/rave/site/trunk/content/rave/source.mdtext Wed Jul 6 09:42:31 2011
@@ -1,4 +1,4 @@
-Title: Source Control
+Title: Getting Started
Notice: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
@@ -73,114 +73,8 @@ Once the server is running:
* jane.doe
* OpenID: http://rave2011.myopenid.com/ (password rave2011)
-### Configuring Eclipse
-
- * Install [Eclipse for Java EE][5]
- * Install M2Eclipse from the [Update Site][6]
- * Install [Subclipse][7]
- * File -> Import -> Maven -> Check Out maven project from SCM
- * select SVN
- * URL is https://svn.apache.org/repos/asf/incubator/rave/trunk
- * Ensure rave-portal is building without errors
- * you may need to update dependencies first
- * With m2eclipse you can configure it to automatically resolve
- (download) missing dependencies if you have set Eclipse
- Preferences/Maven/Offline to false (unchecked), which should be
- the default. We recommend you always set that preference to true
- (checked) as this one specific feature of m2eclipse is often a
- performance drain (Update Maven projects on startup being the
- other).
-
-Now the application is building you probably want to be able to develop and debug
-Rave from inside Eclipse. This gives a faster turnaround in the
-edit/build/deploy cycle.
-
-There are a few different ways to do this:
-
-#### Using Remote debugging and the Eclipse FileSync plugin
-
-The OSS [Eclipse FileSync][8] plugin can automatically synchronize (re)source changes
-(e.g. .jsp, .css, .js) made in the Eclipse IDE directly to the runtime tomcat deployment
-started (separately) through maven cargo:start. And you can attach the Eclipse debugger
-to the cargo started Tomcat instance (see above) as remote application on default port 8000.
-
-The [maven-filesync-plugin][9] is pre-configured to generate default Eclipse FileSync
-configurations for the rave-shindig and rave-portal projects, mapping their source folders
-src/main/webapps and src/main/resources to synchronize (copy) changes to the Tomcat deployment
-environment under rave-portal/target/Tomcat6x, so this will work out-of-the-box.
-
-Prerequisite: install the Eclipse FileSync plugin from its [Update Site][10]
-
-The first time you build the Rave project with maven, the maven-filesync-plugin
-will generate this default FileSync configuration for the FileSync plugin.
-Afterwards you only have to refresh the Eclipse projects once to have them recognize this.
-Thereafter you can customize the synchronization configuration manually within Eclipse through
-the project properties dialog.
-Note: manual changes will not be overridden anymore by the maven-filesync-plugin once they
-exist. Furthermore, if you are not using Eclipse, this plugin will simply skip its execution.
-
-If you have "Build automatically" enabled within Eclipse, the FileSync plugin will synchronize
-changes automatically after you saved them in Eclipse. Otherwise you can force a manual
-synchronization from the project (rave-portal or rave-shindig) its context menu actions.
-
-#### Using Remote debugging with the JRebel plugin
-
-Using [JRebel][11] provides one the best remote debugging and runtime code change synchronizing
-solutions, as well as can handle resource (non-code) change synchronization.
-
-However, JRebel is not free. If you are a committer you can get a free licence, but if not you
-will need to buy your own licence (you can try out a free 30 day trial licence first).
-
-Setting up and configuring JRebel is not pre-configured for the Rave project but by following
-the instructions from the JRebel manual this should be relatively easy to do.
-
-Note: using both the Eclipse FileSync plugin for (only) resources synchronization and JRebel
-for the hot-code replacement probably will provide the best combination with the least
-configuration overhead.
-
-#### Using Eclipse WTP
-The Rave project can also be deployed through Eclipse WTP, and might be adequate for some, but it
-it is less functional and sometimes a bit quirky. Furthermore, because of (current) limitations
-of the m2eclipse WTP integration for maven war overlays (which the rave-shindig project uses),
-you'll need to use some workarounds to make it workable.
-
-Prerequisite: Install m2eclipse-wtp integration from the m2eclipse-extras [Update Site][12]
-
-If you already imported the Rave projects in Eclipse, first remove them (but don't need to delete them)
-and then (re)import the Rave project as Maven projects to get the m2eclipse-wtp integration enabled.
-
-Then you need to follow these steps:
-
- * Right click on the rave-shindig project and select Properties
- * Open the "Deployment Assembly" property
- * Press Add, select Directive Type "Folder", and select the
- target/rave-shindig-0.1-incubating-SNAPSHOT folder.
- (do a "mvn install" in rave-project first for this folder to be available)
- * configure the correct Context root paths for rave-portal
- ("portal") and rave-shindig ("/") in their Eclipse project
- properties under "Web Project Settings"
-
-Now we need to add the the two webapps to a pre-setup (Tomcat 6) server:
-
- * Windows->Show View->Other...
- * Server->Servers
- * OK
- * In the servers view right click your chosen server and slect Add and Remove...
- * Add rave-shindig and rave-portal
- * Start the server
- * Now see the instructions above for logging into the server
-
[1]: http://subversion.apache.org
[2]: http://svn.apache.org/viewvc/incubator/rave/
[3]: http://maven.apache.org/download.html
[4]: http://maven.apache.org/download.html#Installation
-[5]: http://download.eclipse.org/webtools/downloads/
-[6]: http://m2eclipse.sonatype.org/sites/m2e
-[7]: http://subclipse.tigris.org/update_1.6.x/
-[8]: http://andrei.gmxhome.de/filesync/index.html
-[9]: http://code.google.com/p/mavenfilesync/
-[10]: http://andrei.gmxhome.de/eclipse/
-[11]: http://www.zeroturnaround.com/jrebel/how-to-install-jrebel-for-eclipse/
-[12]: http://m2eclipse.sonatype.org/sites/m2e-extras
-
\ No newline at end of file
Modified: incubator/rave/site/trunk/templates/sidenav.mdtext
URL: http://svn.apache.org/viewvc/incubator/rave/site/trunk/templates/sidenav.mdtext?rev=1143318&r1=1143317&r2=1143318&view=diff
==============================================================================
--- incubator/rave/site/trunk/templates/sidenav.mdtext (original)
+++ incubator/rave/site/trunk/templates/sidenav.mdtext Wed Jul 6 09:42:31 2011
@@ -12,7 +12,8 @@
- [People](people.html)
# Development
- - [Source Code](source.html)
+ - [Getting Started](source.html)
+ - [IDE Settings and debugging](ide-settings-and-debugging.html)
- [Release Management](release-management.html)
- [Issue Tracker](https://issues.apache.org/jira/browse/rave)
- [Continuous Integration](https://builds.apache.org/hudson/view/M-R/view/Rave/)