Author: buildbot
Date: Thu May 10 15:44:44 2012
New Revision: 817086
Log:
Staging update by buildbot for stanbol
Added:
websites/staging/stanbol/trunk/content/stanbol/development/
websites/staging/stanbol/trunk/content/stanbol/development/index.html
Modified:
websites/staging/stanbol/trunk/content/ (props changed)
Propchange: websites/staging/stanbol/trunk/content/
------------------------------------------------------------------------------
--- cms:source-revision (original)
+++ cms:source-revision Thu May 10 15:44:44 2012
@@ -1 +1 @@
-1336550
+1336752
Added: websites/staging/stanbol/trunk/content/stanbol/development/index.html
==============================================================================
--- websites/staging/stanbol/trunk/content/stanbol/development/index.html
(added)
+++ websites/staging/stanbol/trunk/content/stanbol/development/index.html Thu
May 10 15:44:44 2012
@@ -0,0 +1,151 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd";>
+<html>
+<head>
+<!--
+
+ 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.
+-->
+
+ <link href="/stanbol/css/stanbol.css" rel="stylesheet" type="text/css">
+ <title>Apache Stanbol - Development</title>
+ <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+ <link rel="icon" type="image/png"
href="/stanbol/images/stanbol-logo/stanbol-favicon.png"/>
+</head>
+
+<body>
+ <div id="navigation">
+ <a href="/stanbol/index.html"><img alt="Apache Stanbol" width="220"
height="101" border="0"
src="/stanbol/images/stanbol-logo/stanbol-2010-12-14.png"/></a>
+ <h1 id="stanbol">Stanbol</h1>
+<ul>
+<li><a href="/stanbol/index.html">Home</a></li>
+<li><a href="/stanbol/docs/trunk/tutorial.html">Tutorial</a></li>
+<li><a href="/stanbol/docs/trunk/">Documentation</a><ul>
+<li><a href="/stanbol/docs/0.9.0-incubating/">0.9.0-incubating</a></li>
+</ul>
+</li>
+<li><a href="/stanbol/docs/trunk/building.html">Building</a></li>
+</ul>
+<h1 id="project">Project</h1>
+<ul>
+<li><a href="/stanbol/docs/trunk/mailinglists.html">Mailing Lists</a></li>
+<li><a href="https://issues.apache.org/jira/browse/STANBOL";>Issue
Tracker</a></li>
+<li><a href="/stanbol/team.html">Project Team</a></li>
+<li><a href="http://www.apache.org/licenses/LICENSE-2.0";>License</a></li>
+</ul>
+<h1 id="downloads">Downloads</h1>
+<ul>
+<li><a href="/stanbol/downloads/">Overview</a><ul>
+<li><a href="/stanbol/downloads/releases.html">Releases</a></li>
+<li><a href="/stanbol/downloads/launchers.html">Launchers</a></li>
+</ul>
+</li>
+</ul>
+<h1 id="the-asf">The ASF</h1>
+<ul>
+<li><a href="http://www.apache.org";>Apache Software Foundation</a></li>
+<li><a href="http://www.apache.org/foundation/thanks.html";>Thanks</a></li>
+<li><a href="http://www.apache.org/foundation/sponsorship.html";>Become a
Sponsor</a></li>
+<li><a href="http://www.apache.org/security/";>Security</a></li>
+</ul>
+ </div>
+
+ <div id="content">
+ <h1 class="title">Development</h1>
+ <h2 id="dependency-management">Dependency Management</h2>
+<p>Apache Stanbol is a modular software stack and therefore all of its modules
+basically have different release cycles. Technically, this modularization
+is implemented by the underlying OSGi component infrastructure. Each Apache
+Stanbol component is implemented as an OSGi bundle that can be deployed in
+an OSGi environment. Apache Stanbol uses the OSGi implementation from Apache
+Felix for this.</p>
+<p>Apache Stanbol's dependency management is organized at three levels:</p>
+<ol>
+<li><a href="#Build_Dependency_Management">Build Dependency Management</a></li>
+<li>Runtime (OSGi) Dependency Management</li>
+<li>Launcher Configuration Management</li>
+</ol>
+<h3 id="build-dependency-management">Build Dependency Management</h3>
+<p>Build dependencies are configured in the Apache Maven pom.xml (POM) files.
+We distinguish between internal and external dependencies.</p>
+<ul>
+<li>Internal dependencies are dependencies to other org.apache.stanbol.*
+ components.</li>
+<li>External dependencies are dependencies to third party components from
+ outside the Apache Stanbol project.</li>
+</ul>
+<p>Internal dependencies are managed separatly for each component. So each
+component defines in its own POM which other Apache Stanbol components in
+which versions it requires. This makes it possible that different components
+could rely on different versions of another Apache Stanbol component.
+This is a requirement to be able to release single Apache Stanbol
+components independently.</p>
+<p>External dependencies to third party components are managed at a central
+place to ensure that all Apache Stanbol components rely on the very same
+version of a third party component. The central configuration for this can
+be found in the dependency management section of the Apache Stanbol parent
+POM. As all Apache Stanbol components define this central parent POM as
+their parent, it is ensured that all components use the same version of an
+external dependency. Changing the version of an external dependency in the
+parent POM affects all Apache Stanbol components that rely on this
+dependency.</p>
+<p>In consequence it is not allowed that an Apache Stanbol
+components define their own version of an external dependency in their POM.
+External dependencies are configured in the parent POM only! If there is
+any Apache Stanbol component that does not apply to this rule, it should
+be considered as a bug or a good reason for this should be documented.
+Relying on the same version of external dependencies is essential to ensure
+a working Apache Stanbol stack.</p>
+<h3 id="runtime-osgi-dependency-management">Runtime (OSGi) Dependency
Management</h3>
+<h3 id="launcher-configuration-management">Launcher Configuration
Management</h3>
+<h2 id="coding">Coding</h2>
+<h3 id="code-conventions">Code Conventions</h3>
+<p>Most developers of Apache Stanbol use the Eclipse IDE for development. The
+code conventions for this IDE can be imported from the
+'/conventions/stanbol-eclipse-codeformatter.xml' file
+<a
href="http://svn.apache.org/repos/asf/incubator/stanbol/trunk/conventions/";>in
SVN</a>.</p>
+<h3 id="svn-structure">SVN Structure</h3>
+<h3 id="legal-issues">Legal Issues</h3>
+<p>The Apache Stanbol software is released under the Apache Software License
+(AL). Therefore, we have to ensure that our software is developed according
+to this license. Here is a short list of the most important rules every
+developer has to keep in mind when writing this software.</p>
+<ul>
+<li>Ideally, each file in SVN should have the Apache license header. This is
+ especially important for each source (*.java) file. This rule is checked
+ automatically before doing a release using the Apache RAT tool.</li>
+<li>The licenses of all dependencies that are used by Apache Stanbol must
+ be compatible with the AL.</li>
+<li>All dependencies used by Apache Stanbol should be available from the
+ Maven central repository. If this is not the case, the Apache Stanbol
+ module depending on a libraray that is not available from Maven
+ central can not be released that easy, i.e. a separate -deps package would
be required.</li>
+</ul>
+<h2 id="release-process">Release Process</h2>
+ </div>
+
+ <div id="footer">
+ <div class="copyright">
+ <p>
+ Copyright © 2010 The Apache Software Foundation, Licensed under
+ the <a href="http://www.apache.org/licenses/LICENSE-2.0";>Apache
License, Version 2.0</a>.
+ <br />
+ Apache, Stanbol and the Apache feather and Stanbol logos are
trademarks of The Apache Software Foundation.
+ </p>
+ </div>
+ </div>
+
+</body>
+</html>
