You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@isis.apache.org by bu...@apache.org on 2012/12/18 20:52:05 UTC
svn commit: r843015 - in /websites/staging/isis/trunk: cgi-bin/ content/
content/contributors/
Author: buildbot
Date: Tue Dec 18 19:52:01 2012
New Revision: 843015
Log:
Staging update by buildbot for isis
Added:
websites/staging/isis/trunk/content/contributors/building-isis.html
Removed:
websites/staging/isis/trunk/content/contributors/coding-conventions.html
Modified:
websites/staging/isis/trunk/cgi-bin/ (props changed)
websites/staging/isis/trunk/content/ (props changed)
websites/staging/isis/trunk/content/contributors/about.html
websites/staging/isis/trunk/content/contributors/development-environment.html
websites/staging/isis/trunk/content/contributors/verifying-releases.html
websites/staging/isis/trunk/content/documentation.html
Propchange: websites/staging/isis/trunk/cgi-bin/
------------------------------------------------------------------------------
--- cms:source-revision (original)
+++ cms:source-revision Tue Dec 18 19:52:01 2012
@@ -1 +1 @@
-1423091
+1423605
Propchange: websites/staging/isis/trunk/content/
------------------------------------------------------------------------------
--- cms:source-revision (original)
+++ cms:source-revision Tue Dec 18 19:52:01 2012
@@ -1 +1 @@
-1423091
+1423605
Modified: websites/staging/isis/trunk/content/contributors/about.html
==============================================================================
--- websites/staging/isis/trunk/content/contributors/about.html (original)
+++ websites/staging/isis/trunk/content/contributors/about.html Tue Dec 18 19:52:01 2012
@@ -189,9 +189,9 @@
<ul>
<li><a href="contributing.html">Contributing</a></li>
<li><a href="development-environment.html">Development Environment</a></li>
+<li><a href="building-isis.html">Building Isis</a></li>
<li><a href="git-policy.html">Git Policy</a></li>
<li><a href="git-cookbook.html">Git Cookbook</a></li>
-<li><a href="coding-conventions.html">Coding Conventions</a></li>
<li><a href="versioning-policy.html">Versioning Policy</a></li>
</ul>
Added: websites/staging/isis/trunk/content/contributors/building-isis.html
==============================================================================
--- websites/staging/isis/trunk/content/contributors/building-isis.html (added)
+++ websites/staging/isis/trunk/content/contributors/building-isis.html Tue Dec 18 19:52:01 2012
@@ -0,0 +1,283 @@
+<!DOCTYPE html>
+<html lang="en">
+ <head>
+
+ <meta charset="utf-8">
+ <title>Building Isis
</title>
+ <meta name="description" content="">
+ <meta name="author" content="">
+
+ <!-- Le HTML5 shim, for IE6-8 support of HTML elements -->
+ <!--[if lt IE 9]>
+ <script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script>
+ <![endif]-->
+
+ <!-- Le styles -->
+ <link href="./../bootstrap.css" rel="stylesheet">
+ <link href="./../prettify.css" rel="stylesheet">
+ <link href="./../bootstrap-mods.css" rel="stylesheet">
+
+ <style type="text/css">
+ body {
+ padding-top: 60px;
+ }
+ .sprite {
+ display: inline-block;
+ height: 20px;
+ margin: 0 auto 4px;
+ outline: medium none;
+ text-indent: -999em;
+ width: 24px;
+ background-image: url('./../images/sprites.png');
+ background-repeat: no-repeat;
+ overflow: hidden;
+ cursor: pointer;
+ }
+ .edit-page {
+ display: inline-block;
+ height: 20px;
+ margin: 0 auto 4px;
+ outline: medium none;
+ text-indent: -999em;
+ width: 24px;
+ background-image: url('./../images/edit.png');
+ background-repeat: no-repeat;
+ overflow: hidden;
+ cursor: pointer;
+ }
+ .fb-share {
+ background-position: 0px -40px;
+ }
+ .gp-share {
+ background-position: 0px 0px;
+ }
+ .tw-share {
+ background-position: 0px -80px;
+ }
+ .markdown-content {
+ min-height: 500px;
+ }
+ .book-image img {
+ border: 1px;
+ border-style: solid;
+ }
+ .stub,.note {
+ position: relative;
+ padding: 7px 15px;
+ margin-bottom: 18px;
+ color: #404040;
+ background-color: #eedc94;
+ background-repeat: repeat-x;
+ background-image: -khtml-gradient(linear, left top, left bottom, from(#fceec1), to(#eedc94));
+ background-image: -moz-linear-gradient(top, #fceec1, #eedc94);
+ background-image: -ms-linear-gradient(top, #fceec1, #eedc94);
+ background-image: -webkit-gradient(linear, left top, left bottom, color-stop(0%, #fceec1), color-stop(100%, #eedc94));
+ background-image: -webkit-linear-gradient(top, #fceec1, #eedc94);
+ background-image: -o-linear-gradient(top, #fceec1, #eedc94);
+ background-image: linear-gradient(top, #fceec1, #eedc94);
+ filter: progid:DXImageTransform.Microsoft.gradient(startColorstr='#fceec1', endColorstr='#eedc94', GradientType=0);
+ text-shadow: 0 -1px 0 rgba(0, 0, 0, 0.25);
+ border-color: #eedc94 #eedc94 #e4c652;
+ border-color: rgba(0, 0, 0, 0.1) rgba(0, 0, 0, 0.1) rgba(0, 0, 0, 0.25);
+ text-shadow: 0 1px 0 rgba(255, 255, 255, 0.5);
+ border-width: 1px;
+ border-style: solid;
+ -webkit-border-radius: 4px;
+ -moz-border-radius: 4px;
+ border-radius: 4px;
+ -webkit-box-shadow: inset 0 1px 0 rgba(255, 255, 255, 0.25);
+ -moz-box-shadow: inset 0 1px 0 rgba(255, 255, 255, 0.25);
+ box-shadow: inset 0 1px 0 rgba(255, 255, 255, 0.25);
+ }
+ </style>
+ <script type="text/javascript">
+ function fbshare () {
+ window.open(
+ "http://www.facebook.com/sharer/sharer.php?u="+document.URL,
+ 'Share on Facebook',
+ 'width=640,height=426');
+ };
+ function gpshare () {
+ window.open(
+ "https://plus.google.com/share?url="+document.URL,
+ 'Share on Google+',
+ 'width=584,height=385');
+ };
+ function twshare () {
+ window.open(
+ "https://twitter.com/intent/tweet?url="+document.URL+"&text=Building Isis
",
+ 'Share on Twitter',
+ 'width=800,height=526');
+ };
+ </script>
+
+ <!-- Le fav and touch icons -->
+ <link rel="shortcut icon" href="./../images/favicon.ico">
+ <link rel="apple-touch-icon" href="./../images/apple-touch-icon.png">
+ <link rel="apple-touch-icon" sizes="72x72" href="./../images/apple-touch-icon-72x72.png">
+ <link rel="apple-touch-icon" sizes="114x114" href="./../images/apple-touch-icon-114x114.png">
+
+ <script src="./../javascript/prettify.js" type="text/javascript"></script>
+ <script src="./../javascript/jquery-latest.js"></script>
+ <script src="http://platform.twitter.com/widgets.js" type="text/javascript"></script>
+ <script src="./../javascript/common.js"></script>
+ <script src="./../javascript/prettyprint.js"></script>
+
+ <script type="text/javascript">
+
+ var _gaq = _gaq || [];
+ _gaq.push(['_setAccount', 'UA-2717626-1']);
+ _gaq.push(['_setDomainName', 'apache.org']);
+ _gaq.push(['_trackPageview']);
+
+ (function() {
+ var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
+ ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
+ var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
+ })();
+
+ </script>
+
+
+ </head>
+
+ <body>
+
+ <div class="topbar">
+ <div class="fill">
+ <div class="container">
+ <a class="brand" href="./../index.html">Apache Isis</a>
+ <ul class="nav">
+ <li><a href="./../index.html">Home</a></li>
+ <li><a href="./../download.html">Download</a></li>
+ <li><a href="./../documentation.html">Documentation</a></li>
+ <li><a href="./../support.html">Support</a></li>
+ </ul>
+
+ <!-- Google CSE Search Box Begins -->
+ <div style="float: right; position: relative; ">
+ <form action="http://www.google.com/cse" id="cse-search-box" _lpchecked="1">
+ <div>
+ <input type="hidden" name="cx" value="001500763902520246267:purt3m54z98">
+ <input type="hidden" name="ie" value="UTF-8">
+ <input type="text" name="q" size="31" style="border: 1px solid rgb(126, 157, 185); padding: 2px; background-color: rgb(255, 255, 255); background-position: 0% 50%; background-repeat: no-repeat no-repeat;">
+ <input type="submit" name="sa" value="Search">
+ </div>
+ <input name="siteurl" type="hidden" value="incubator.apache.org/isis/">
+ <input name="ref" type="hidden" value="">
+ <input name="ss" type="hidden" value="677j458329j2">
+ </form>
+ </div>
+ <!-- Google CSE Search Box Ends -->
+ </div>
+ </div>
+ </div>
+
+ <div class="container">
+ <div class="markdown-content">
+
+
+<div class="page-header">
+<p><a href="./../documentation.html">Docs</a> » <a href="./../contributors/about.html">Contributors</a></p>
+<h1>Building Isis
+
+</h1>
+</div>
+
+<p>Isis is build using Maven; details of setting up your development environment can be found <a href="development-environment.html">here</a>.</p>
+
+<h3>Building all of Isis</h3>
+
+<p>To build the source code from the command line, simply go to the root directory and type:</p>
+
+<pre>
+mvn clean install
+</pre>
+
+<p>The first time you do this, you'll find it takes a while since Maven needs to download all of the Isis prerequisites.</p>
+
+<p>Thereafter you can speed up the build by adding the <code>-o</code> (offline flag):</p>
+
+<pre>
+mvn clean install -o
+</pre>
+
+<p>For the most part, though, you may want to rely on an IDE such as Eclipse to build the codebase for you. Both Eclipse and Idea (12.0+) support incremental background compilation.</p>
+
+<p>When using Eclipse, a Maven profile is configured such that Eclipse compiles to <code>target-ide</code> directory rather than the usual <code>target</code> directory. You can therefore switch between Eclipse and Maven command line without one interfering with the other.</p>
+
+<h3>Building an Individual Component of Isis</h3>
+
+<p>Alternatively, you can go to the root of any of the components and build each individually.</p>
+
+<p>For example:</p>
+
+<ul>
+<li>to build just core, use:</li>
+</ul>
+
+<pre>
+ cd core
+ mvn clean install
+</pre>
+
+<ul>
+<li>to build the JDO objectstore, use:</li>
+</ul>
+
+<pre>
+ cd component/objectstore/jdo
+ mvn clean install
+</pre>
+
+<ul>
+<li>to build the Wicket viewer, use:</li>
+</ul>
+
+<pre>
+ cd component/viewer/wicket
+ mvn clean install
+</pre>
+
+<p>A list of all of the Isis components can be found in our <a href="release-process.html">release process</a> documentation.</p>
+
+
+
+ </div>
+
+ <div id="edit" class="modal hide fade in" style="display: none; ">
+ <div class="modal-header">
+ <a class="close" data-dismiss="modal">x</a>
+
+ <h3>Thank you for contributing to the documention!</h3>
+ </div>
+ <div class="modal-body">
+ <h4>Any help with the documentation is greatly appreciated.</h4>
+ <p>All edits are reviewed before going live, so feel free to do much more than fix typos or links. If you see a page that could benefit from an entire rewrite, we'd be thrilled to review it. Don't be surprised if we like it so much we ask you for help with other pages :)</p>
+ <small>NOTICE: unless indicated otherwise on the pages in question, all editable content available from apache.org is presumed to be licensed under the Apache License (AL) version 2.0 and hence all submissions to apache.org treated as formal Contributions under the license terms.</small>
+ <!--[if gt IE 6]>
+ <h4>Internet Explorer Users</h4>
+ <p>If you are not an Apache committer, click the Yes link and enter a <i>anonymous</i> for the username and leave the password empty</p>
+ <![endif]-->
+
+ </div>
+ <div class="modal-footer">
+ Do you have an Apache ID?
+ <a href="javascript:void(location.href='https://cms.apache.org/redirect?uri='+escape(location.href))" class="btn">Yes</a>
+ <a href="javascript:void(location.href='https://anonymous:@cms.apache.org/redirect?uri='+escape(location.href))" class="btn">No</a>
+ </div>
+ </div>
+ <script src="./../javascript/bootstrap-modal.js"></script>
+
+ <footer>
+ <p>
+ Copyright © 2012 The Apache Software Foundation, Licensed under the Apache License, Version 2.0.
+ <br/>
+ Apache and the Apache feather logo are trademarks of The Apache Software Foundation.
+ </p>
+ </footer>
+
+ </div> <!-- /container -->
+
+ </body>
+</html>
Modified: websites/staging/isis/trunk/content/contributors/development-environment.html
==============================================================================
--- websites/staging/isis/trunk/content/contributors/development-environment.html (original)
+++ websites/staging/isis/trunk/content/contributors/development-environment.html Tue Dec 18 19:52:01 2012
@@ -184,13 +184,17 @@
</h1>
</div>
-<h4>Installing Git</h4>
+<h2>Git</h2>
+
+<p>The Isis source code lives in a git repo.</p>
+
+<h3>Installation</h3>
<p>The easiest place to get hold of command-line git is probably the <a href="http://git-scm.com/downloads">github download page</a>.</p>
<p>On Windows, this also installs the rather good mSysGit Unix shell. We recommend that you enable git for both the mSysgit and the Windows command prompt:</p>
-<p><img src="resources/setting-up-git.png" width="400px"></img></p>
+<p><img src="resources/setting-up-git.png" width="350px"></img></p>
<p>Once git is installed, the two main command line tools to note are:</p>
@@ -199,34 +203,22 @@
<li><code>gitk</code> for viewing the commit history</li>
</ul>
-<p>Three commands in particular worth knowing:</p>
-
-<pre>git help <i>command</i></pre>
-
-<p>will open the man page in your web browser</p>
-
-<pre>git gui</pre>
-
-<p>will open up a basic GUI client to staging changes and making commits</p>
-
-<pre>gitk --all</pre>
-
-<p>will open the commit history for all branches. In particular, you should be able to see the local <code>master</code>, which branch you are working on (the <code>HEAD</code>), and also the last known position of the <code>master</code> branch from the central repo, called <code>origin/master</code>.</p>
-
<p>If using Windows, note that github also have a dedicated <a href="https://help.github.com/articles/set-up-git">Windows client</a>. With a little <a href="http://haacked.com/archive/2012/05/30/using-github-for-windows-with-non-github-repositories.aspx">hacking around</a>, it can also be made to work with non-github repositories.</p>
<p>If using Mac, you might also want to check out Atlassian's <a href="http://www.atlassian.com/software/sourcetree/overview">Sourcetree</a>.</p>
<h4>Cloning the Isis repo and Configuring</h4>
-<p>First, clone the Isis repo. If you are <strong>not a committer</strong>, please see the <a href="contributing.html">contributing</a> page for details on which repo to clone from.</p>
+<p>First, clone the Isis repo.</p>
-<p><strong>Committers</strong>, meanwhile, should clone from the Apache read/write repo:</p>
+<p>If you are a <strong>committer</strong>, then clone from the Apache read/write repo:</p>
<pre>
git clone https://git-wip-us.apache.org/repos/asf/isis.git
</pre>
+<p>If you are <strong>not a committer</strong>, please see the <a href="contributing.html">contributing</a> page for details on which repo to clone from.</p>
+
<p>You should then configure your user name and password; see also <a href="https://git-wip-us.apache.org/">Apache's git</a> docs:</p>
<pre>
@@ -269,6 +261,22 @@ git config branch.autosetuprebase always
<p>If you don't use git outside of Apache, you can add the <code>--global</code> flag so that the above settings apply for all repos managed by git on your PC.</p>
+<h3>Getting help</h3>
+
+<p>Three commands of git that in particular worth knowing:</p>
+
+<pre>git help <i>command</i></pre>
+
+<p>will open the man page in your web browser</p>
+
+<pre>git gui</pre>
+
+<p>will open up a basic GUI client to staging changes and making commits</p>
+
+<pre>gitk --all</pre>
+
+<p>will open the commit history for all branches. In particular, you should be able to see the local <code>master</code>, which branch you are working on (the <code>HEAD</code>), and also the last known position of the <code>master</code> branch from the central repo, called <code>origin/master</code>.</p>
+
<p>For further reading, see:</p>
<ul>
@@ -287,20 +295,77 @@ git config branch.autosetuprebase always
MAVEN_OPTS=-Xms512m -Xmx1024m -XX:MaxPermSize=128m
</pre>
-<!--
-TODO: x-ref importing-projects
-TODO: x-ref sharing projects
--->
+<h2>Installing and Configuring Eclipse</h2>
-<h2>Building the Source Code</h2>
+<p>You can use any IDE to work with Isis, but most of the Isis committers tend to use Eclipse.</p>
-<p>To build the source code, simply go to the root directory and type:</p>
+<p>Make sure you are using a version of Eclipse that includes both the <code>m2e</code> feature (Maven integration) and the <code>eGit</code> feature (Git integration). Both 3.8 (2011) and 4.2 (2012) have these features bundled as part of the Java and JEE editions; or you can always install using <code>Help > Install New Software</code>.</p>
-<pre>
-mvn clean install
-</pre>
+<h3>Importing Projects</h3>
+
+<p>Next thing to do is to import the Isis projects into your workspace. This is done using <code>File > Import >Project</code>:</p>
+
+<p><img src="resources/importing-projects-1.png" width="500px"></img></p>
+
+<p>On the next page, specify the root directory where you cloned the Isis repo. Eclipse will recursively find all the projects that make up Isis:</p>
+
+<p><img src="resources/importing-projects-2.png" width="500px"></img></p>
+
+<p>Hit <code>Finish</code>; Eclipse should automatically build the entire codebase.</p>
+
+<h3>Sharing Projects</h3>
+
+<p>The next thing to do is to configure eGit so that you can use git commands within Eclipse. This is done by selecting all the projects in the <code>Package Explorer</code>, then right clicking <code>Team > Share Project</code>:</p>
+
+<p><img src="resources/sharing-projects-1.png" width="500px"></img></p>
+
+<p>On the next page, choose the <code>Use or create repository in parent folder of project</code> checkbox:</p>
+
+<p><img src="resources/sharing-projects-2.png" width="500px"></img></p>
+
+<p>Hit <code>Finish</code> and you are done.</p>
+
+<h3>Coding Conventions</h3>
+
+<p>Isis provides a number of Eclipse templates to help ensure that code is formatted according to our standards:</p>
+
+<ul>
+<li><code>Windows > Preferences > Java > Code Style > Code Templates</code>
+<ul>
+<li>Import <a href="resources/Apache-code-style-template.xml">Apache-code-style-template.xml</a></li>
+</ul></li>
+<li><code>Windows > Preferences > Java > Code Style > Formatter</code>
+<ul>
+<li>Import <a href="resources/Apache-code-style-formatting.xml">Apache-code-style-formatting.xml</a></li>
+</ul></li>
+<li><code>Windows > Preferences > Java > Code Style > Organize Imports</code>
+<ul>
+<li>Import <a href="resources/isis.importorder">isis.importorder</a></li>
+</ul></li>
+<li><code>Windows > Preferences > Java > Code Style > Clean Up</code>
+<ul>
+<li>Import <a href="resources/Apache-Isis-code-style-cleanup.xml">Apache-Isis-code-style-cleanup.xml</a></li>
+<li>(this performs both code formatting and organizing imports)</li>
+</ul></li>
+</ul>
+
+<p>In addition, you will probably want to import the Java editor templates, as described in the <a href="../getting-started/editor-templates.html">getting started</a> section.</p>
+
+<p><!--
+TODO: to add from the original incubator website <a href="http://incubator.apache.org/isis" title="Apache Isis (incubator website)">here</a>.</p>
+
+<p>In addition:</p>
+
+<ul>
+<li>checkstyle, as per sec.Checkstyle</li>
+<li>PMD, as per sec.PMD</li>
+<li>findbugs, as per sec.FindBugs
+--></li>
+</ul>
+
+<h2>What's Next</h2>
-<p>Alternatively, you can go to the root of any of the components (eg as documented <a href="release-process.html">here</a> and build each individually.</p>
+<p>The next thing to do is probably to build Isis; see <a href="building-isis.html">here</a>.</p>
Modified: websites/staging/isis/trunk/content/contributors/verifying-releases.html
==============================================================================
--- websites/staging/isis/trunk/content/contributors/verifying-releases.html (original)
+++ websites/staging/isis/trunk/content/contributors/verifying-releases.html Tue Dec 18 19:52:01 2012
@@ -188,6 +188,16 @@
<p>This page provides some guidance on what a voter is expected to verify before casting their vote.</p>
+<p>Per this <a href="http://www.apache.org/dev/release.html">ASF documentation</a>, the legal requirements for an ASF release are:</p>
+
+<ul>
+<li>a source zip file + corresponding signature (signed by me, which is in the ASF web of trust and in our KEYS file)</li>
+<li>all source files have the Apache license (this is ensured by the running of the rat plugin prior to release; you could run it on the unzipped source)</li>
+<li>all dependencies are appropriately licensed; see the DEPENDENCIES file which is automatically generated from the POMs plus the supplemental-models.xml file</li>
+</ul>
+
+<p>Note that the binaries are <em>not</em> an ASF release, they merely exist on the Maven central repo as a convenience.</p>
+
<h2>Verifying the source release artifacts</h2>
<p>Download both the ZIP and .ASC files from the location specified in the voting email. To verify that the signature is correct, use:</p>
Modified: websites/staging/isis/trunk/content/documentation.html
==============================================================================
--- websites/staging/isis/trunk/content/documentation.html (original)
+++ websites/staging/isis/trunk/content/documentation.html Tue Dec 18 19:52:01 2012
@@ -231,9 +231,9 @@
<ul>
<li><a href="contributors/contributing.html">Contributing</a></li>
<li><a href="contributors/development-environment.html">Development Environment</a></li>
+<li><a href="contributors/building-isis.html">Building Isis</a></li>
<li><a href="contributors/git-policy.html">Git Policy</a></li>
<li><a href="contributors/git-cookbook.html">Git Cookbook</a></li>
-<li><a href="contributors/coding-conventions.html">Coding Conventions</a></li>
<li><a href="contributors/versioning-policy.html">Versioning Policy</a></li>
</ul>