You are viewing a plain text version of this content. The canonical link for it is here.
Posted to server-dev@james.apache.org by no...@apache.org on 2009/10/16 11:52:34 UTC
svn commit: r825826 - in /james/hupa/trunk/src/site: ./
resources/images/dev/ xdoc/ xdoc/dev/
Author: norman
Date: Fri Oct 16 09:52:34 2009
New Revision: 825826
URL: http://svn.apache.org/viewvc?rev=825826&view=rev
Log:
Add contributer documents. Thx to Juergen Hoffmann for contributing ! (HUPA-40)
Added:
james/hupa/trunk/src/site/resources/images/dev/
james/hupa/trunk/src/site/resources/images/dev/checkout-hupa.jpg (with props)
james/hupa/trunk/src/site/resources/images/dev/eclipse_setup.jpg (with props)
james/hupa/trunk/src/site/resources/images/dev/login-page.jpg (with props)
james/hupa/trunk/src/site/resources/images/dev/run-configurations-gwt.jpg (with props)
james/hupa/trunk/src/site/resources/images/dev/run-configurations-main.jpg (with props)
james/hupa/trunk/src/site/resources/images/dev/run-configurations-refresh.jpg (with props)
james/hupa/trunk/src/site/resources/images/dev/svn-repo.jpg (with props)
james/hupa/trunk/src/site/resources/images/dev/svn-repositories-installed.jpg (with props)
james/hupa/trunk/src/site/xdoc/dev/
james/hupa/trunk/src/site/xdoc/dev/building.xml
james/hupa/trunk/src/site/xdoc/dev/environment.xml
Modified:
james/hupa/trunk/src/site/site.xml
james/hupa/trunk/src/site/xdoc/index.xml
Added: james/hupa/trunk/src/site/resources/images/dev/checkout-hupa.jpg
URL: http://svn.apache.org/viewvc/james/hupa/trunk/src/site/resources/images/dev/checkout-hupa.jpg?rev=825826&view=auto
==============================================================================
Binary file - no diff available.
Propchange: james/hupa/trunk/src/site/resources/images/dev/checkout-hupa.jpg
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: james/hupa/trunk/src/site/resources/images/dev/eclipse_setup.jpg
URL: http://svn.apache.org/viewvc/james/hupa/trunk/src/site/resources/images/dev/eclipse_setup.jpg?rev=825826&view=auto
==============================================================================
Binary file - no diff available.
Propchange: james/hupa/trunk/src/site/resources/images/dev/eclipse_setup.jpg
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: james/hupa/trunk/src/site/resources/images/dev/login-page.jpg
URL: http://svn.apache.org/viewvc/james/hupa/trunk/src/site/resources/images/dev/login-page.jpg?rev=825826&view=auto
==============================================================================
Binary file - no diff available.
Propchange: james/hupa/trunk/src/site/resources/images/dev/login-page.jpg
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: james/hupa/trunk/src/site/resources/images/dev/run-configurations-gwt.jpg
URL: http://svn.apache.org/viewvc/james/hupa/trunk/src/site/resources/images/dev/run-configurations-gwt.jpg?rev=825826&view=auto
==============================================================================
Binary file - no diff available.
Propchange: james/hupa/trunk/src/site/resources/images/dev/run-configurations-gwt.jpg
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: james/hupa/trunk/src/site/resources/images/dev/run-configurations-main.jpg
URL: http://svn.apache.org/viewvc/james/hupa/trunk/src/site/resources/images/dev/run-configurations-main.jpg?rev=825826&view=auto
==============================================================================
Binary file - no diff available.
Propchange: james/hupa/trunk/src/site/resources/images/dev/run-configurations-main.jpg
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: james/hupa/trunk/src/site/resources/images/dev/run-configurations-refresh.jpg
URL: http://svn.apache.org/viewvc/james/hupa/trunk/src/site/resources/images/dev/run-configurations-refresh.jpg?rev=825826&view=auto
==============================================================================
Binary file - no diff available.
Propchange: james/hupa/trunk/src/site/resources/images/dev/run-configurations-refresh.jpg
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: james/hupa/trunk/src/site/resources/images/dev/svn-repo.jpg
URL: http://svn.apache.org/viewvc/james/hupa/trunk/src/site/resources/images/dev/svn-repo.jpg?rev=825826&view=auto
==============================================================================
Binary file - no diff available.
Propchange: james/hupa/trunk/src/site/resources/images/dev/svn-repo.jpg
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: james/hupa/trunk/src/site/resources/images/dev/svn-repositories-installed.jpg
URL: http://svn.apache.org/viewvc/james/hupa/trunk/src/site/resources/images/dev/svn-repositories-installed.jpg?rev=825826&view=auto
==============================================================================
Binary file - no diff available.
Propchange: james/hupa/trunk/src/site/resources/images/dev/svn-repositories-installed.jpg
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Modified: james/hupa/trunk/src/site/site.xml
URL: http://svn.apache.org/viewvc/james/hupa/trunk/src/site/site.xml?rev=825826&r1=825825&r2=825826&view=diff
==============================================================================
--- james/hupa/trunk/src/site/site.xml (original)
+++ james/hupa/trunk/src/site/site.xml Fri Oct 16 09:52:34 2009
@@ -40,6 +40,9 @@
</menu>
+ <menu name="Get Involved" inherit="top">
+ <item name="Setup" href="/dev/environment.html"/>
+ </menu>
<menu name="Project">
<item name="Bug Database" href="/issue-tracking.html"/>
Added: james/hupa/trunk/src/site/xdoc/dev/building.xml
URL: http://svn.apache.org/viewvc/james/hupa/trunk/src/site/xdoc/dev/building.xml?rev=825826&view=auto
==============================================================================
--- james/hupa/trunk/src/site/xdoc/dev/building.xml (added)
+++ james/hupa/trunk/src/site/xdoc/dev/building.xml Fri Oct 16 09:52:34 2009
@@ -0,0 +1,101 @@
+<?xml version="1.0" encoding="ISO-8859-1"?>
+ <!--
+ 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.
+ -->
+<document>
+ <properties>
+ <title>Building Hupa</title>
+ <author email="server-dev@james.apache.org">James Hupa Project Team</author>
+ </properties>
+ <body>
+ <section name="Building Hupa for the first time">
+ <p>
+ Because Hupa uses maven2 as its build tool, the management of
+ dependencies is rather simple. You can either run
+ <code>mvn clean package</code>
+ from the command line, or use the built-in m2eclipse plugin.
+ </p>
+ <subsection name="Setting up m2eclipse to build Hupa">
+ <p>
+ m2eclipse provides you with the ability to create different run
+ configurations for maven. So you can run
+ <b>what</b>
+ you want,
+ <b>when</b>
+ you want, by a single mouse-click. To configure the m2 run
+ configuration, please do a right click on the project name and select
+ Run As -> Run Configurations ...
+ </p>
+ <p>
+ In the Following Dialog left-click Maven Build, then click on New on
+ the top. On the dialogs main content area provide the run
+ configuration now. In the Name field type
+ <code>hupa clean package</code>
+ . Uder the Base Directory should be written
+ <code>${workspace_loc:/hupa-trunk}</code>
+ (if your project is only named hupa, then it would be
+ ${workspace_loc:/hupa}).
+ <img src="../images/dev/run-configurations-main.jpg" />
+ Underneath you should check Update Snaphots
+ and on the Refresh Tab you
+ should check Refresh Resources upon
+ Completion and The Project
+ Containing the selected Resource.
+ <img src="../images/dev/run-configurations-refresh.jpg" />
+ After all is set, click Apply and then click Run. It will take a hile
+ to download all the dependencies. Once it is finished, it will refresh
+ eclipse, and we are on the final step to start it up the first time.
+ </p>
+ </subsection>
+ </section>
+ <section name="Setting up the Google Plugin">
+ <p>
+ Because Hupa uses the google web toolkit (GWT) it is necessary to
+ adjust
+ the output directory of the project. If you don't the Stand alone
+ google
+ browser will not be able to pick up the compiled classes. So, to
+ change
+ it do a right-click on your project choos Run As -> Web Application. But
+ beware you will get an error! We do this only because the plugin sets
+ almost everything up for us. After we get the error right-click on the
+ project again, and choose Run As -> Run Configurations... then expand
+ the Web Application Node, go to the Arguments tab and add
+ <code>-Dhupa.config.file=${project_loc}/server/src/main/webapp/WEB-INF/conf/config.properties
+ </code>
+ to the VM Arguments Textbox. Click on Apply and close the dialog.
+ After
+ that go into the Package Explorer
+ View and expand server -> src -> main
+ -> webapp -> WEB-INF -> conf and
+ double click on config.properties.
+ Adjust these settings to your liking.
+ googlemail is setup by default.
+ Last thing to setup is the projects output path. Do a right-click on the
+ project and choose Build Path -> Configure Build Path... Under the
+ Source tab put <your_project_name>/war/WEB-INF/classes in the
+ output directory textbox.
+ </p>
+ </section>
+ <section name="Starting Hupa">
+ <p>
+ So we are finally there. We can run Hupa for the first time. Do a
+ right-click
+ on the project choose Run As -> Run Configurations... ->
+ Hupa.html and
+ click on run.
+ </p>
+ </section>
+ </body>
+</document>
\ No newline at end of file
Added: james/hupa/trunk/src/site/xdoc/dev/environment.xml
URL: http://svn.apache.org/viewvc/james/hupa/trunk/src/site/xdoc/dev/environment.xml?rev=825826&view=auto
==============================================================================
--- james/hupa/trunk/src/site/xdoc/dev/environment.xml (added)
+++ james/hupa/trunk/src/site/xdoc/dev/environment.xml Fri Oct 16 09:52:34 2009
@@ -0,0 +1,167 @@
+<?xml version="1.0" encoding="ISO-8859-1"?>
+ <!--
+ 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.
+ -->
+<document>
+ <properties>
+ <title>Setup your Development Environment</title>
+ <author email="server-dev@james.apache.org">James Hupa Project Team</author>
+ </properties>
+ <body>
+ <section name="So you want to get involved?">
+ <p>
+ Great! Hupa is a new project, which just made it from the labs over to
+ the james
+ project.
+ We have a solid codebase, but there are many features
+ missing. But you already
+ know that, right?
+ At least that is why you are
+ trying to help, correct?
+ </p>
+ <p>
+ So, what do you need... We develop in eclipse, hence this document
+ describes
+ how to setup eclipse,
+ to get a Hupa Development Environment up
+ and running. So if you are a
+ developer who is using netbeans
+ or any other
+ IDE like IntelliJ IDEA, don't hesitate, to tell us how you setup
+ your
+ Environment, and
+ we will be more than happy to include the documentation
+ as well.
+ </p>
+ <p>
+ This document describes which steps are needed to setup eclipse, as if
+ it was
+ freshly downloaded.
+ So if you already have some plugins installed,
+ skip over to the next section.
+ Other than that,
+ all that is left for is to
+ wish you guys fun coding Hupa!
+ </p>
+ </section>
+
+ <section name="How to setup eclipse...">
+ <subsection name="What Version do you need">
+ <p>
+ Eclipse can be downloaded from
+ <a href="http://download.eclipse.org">the eclipse download page</a>
+ I recommend using the Eclipse IDE for Java Developers or the Eclipse
+ IDE for Java EE Developers.
+ </p>
+ <p>
+ If you need help installing eclipse, you can find the answers you are
+ looking for on the
+ <a href="http://wiki.eclipse.org/FAQ_Where_do_I_get_and_install_Eclipse%3F">eclipse homepage</a>
+ </p>
+ <p>
+ From this point on we assume you have a running distribution of
+ eclipse installed on your system.
+ </p>
+ </subsection>
+ <subsection name="Setting up the maven eclipse plugin">
+ <p>
+ Hupa uses maven2 as its build tool. Although it is possible to only
+ run maven commands
+ from the command line, a tight integration into the
+ tool you use to write and run the code is a lot nicer.
+ </p>
+ <p>
+ Nowadays there is more than one plugin for eclipse to interact with
+ maven2. Although all might be great, I only know my way around the
+ m2eclipse plugin. I work
+ with it on all my m2 projects, and it provides
+ me with the tools I need to get
+ the job done. Again, if you provide the
+ documentation for other
+ plugins, we would be more than happy to put
+ them up here.
+ </p>
+ <p>
+ But enough of the bla bla let us get started. You can download the
+ plugin
+ <a href="http://m2eclipse.sonatype.org/">here.</a>
+ The Installation Instructions are right on the first page. From this
+ point this guide assumes that you have the m2eclipse plugin installed.
+ </p>
+ </subsection>
+ <subsection name="Setting up the GWT Plugin">
+ <p>
+ Hupa is developed using
+ <a href="http://code.google.com/intl/de/webtoolkit/">GWT</a>
+ So to make your development a lot easier we recommend installing the
+ <a href="http://code.google.com/appengine/docs/java/tools/eclipse.html">google plugin for eclipse</a>
+ </p>
+ </subsection>
+ <subsection name="Setting up subclipse">
+ <p>
+ The ASF uses subversion as its Version Control System (VCS). So to be
+ able to check out the source code I recommend using a special plugin
+ called
+ <a href="http://subclipse.tigris.org/">subclipse</a>
+ After subclipse is installed, it is fairly easy to start your
+ development on Hupa :)
+ </p>
+ </subsection>
+ <subsection name="Checking out the Hupa source code">
+ <p>
+ Now we have everything setup to be able to check out and run the Hupa
+ source code.
+ </p>
+ <p>
+ Open up Eclipse and go to Window -> Open Perspective -> Other -> SVN
+ Repository Exploring
+ <br/>
+ <img src="../images/dev/svn-repo.jpg" />
+ <br/>
+ In the SVN Repositories View Click the right mouse button and choose
+ New -> Repository Location ...
+ </p>
+ <p>
+ In the Dialog enter the following url in the URL Field:
+ http://svn.apache.org/repos/asf then click on Finish. After that the
+ ASF Software Repository should be visible inside your SVN Repositories
+ view as shown here.
+ <br/>
+ <img src="../images/dev/svn-repositories-installed.jpg" />
+ <br/>
+ </p>
+ <p>
+ Expand the Repository, then james, then hupa, and finally do a right
+ click on trunk and select Checkout. Fill in the settings as you think
+ they fit your needs.
+ <br/>
+ <img src="../images/dev/checkout-hupa.jpg" />
+ <br/>
+ </p>
+ <p>
+ So after everything is set up correctly your screen should look like
+ this one here.
+ <br/>
+ <img src="../images/dev/eclipse_setup.jpg" />
+ <br/>
+ </p>
+ <p>
+ Now, that the foundation is laid out, we can finally
+ <a href="building.html">build hupa</a>
+ .
+ </p>
+ </subsection>
+ </section>
+ </body>
+</document>
\ No newline at end of file
Modified: james/hupa/trunk/src/site/xdoc/index.xml
URL: http://svn.apache.org/viewvc/james/hupa/trunk/src/site/xdoc/index.xml?rev=825826&r1=825825&r2=825826&view=diff
==============================================================================
--- james/hupa/trunk/src/site/xdoc/index.xml (original)
+++ james/hupa/trunk/src/site/xdoc/index.xml Fri Oct 16 09:52:34 2009
@@ -1,22 +1,18 @@
<?xml version="1.0" encoding="ISO-8859-1"?>
-<!--
- 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
+ <!--
+ 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.
--->
+ 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.
+ -->
<document>
<properties>
<title>Overview</title>
@@ -25,26 +21,26 @@
<body>
<section name="What is it?">
<p>
- Hupa is IMAP-based Webmail written in GWT.
+ Hupa is IMAP-based Webmail written in GWT.
</p>
</section>
<section name="News">
-
- <subsection name="2009">
-
- <h4>Sept/2009 - Hupa moved to James</h4>
- <p>
- Hupa moved from Apache Labs to James this month.
+
+ <subsection name="2009">
+
+ <h4>Sept/2009 - Hupa moved to James</h4>
+ <p>
+ Hupa moved from Apache Labs to James this month.
</p>
- </subsection>
-
+ </subsection>
+
</section>
-
+
<section name="releases">
<p>
<b>Latest: None</b>
- <br/>
- No releases done yet.
+ <br />
+ No releases done yet. Would like helping getting one together? <a href="dev/environment.html">Check this out</a>
</p>
</section>
</body>
---------------------------------------------------------------------
To unsubscribe, e-mail: server-dev-unsubscribe@james.apache.org
For additional commands, e-mail: server-dev-help@james.apache.org