You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@stanbol.apache.org by bu...@apache.org on 2012/06/06 14:39:18 UTC
svn commit: r820476 - in /websites/staging/stanbol/trunk/content: ./
stanbol/development/coding.html
stanbol/development/dependency-management.html
stanbol/development/index.html stanbol/development/release-management.html
stanbol/development/website.html
Author: buildbot
Date: Wed Jun 6 12:39:18 2012
New Revision: 820476
Log:
Staging update by buildbot for stanbol
Added:
websites/staging/stanbol/trunk/content/stanbol/development/coding.html
websites/staging/stanbol/trunk/content/stanbol/development/dependency-management.html
websites/staging/stanbol/trunk/content/stanbol/development/release-management.html
Modified:
websites/staging/stanbol/trunk/content/ (props changed)
websites/staging/stanbol/trunk/content/stanbol/development/index.html
websites/staging/stanbol/trunk/content/stanbol/development/website.html
Propchange: websites/staging/stanbol/trunk/content/
------------------------------------------------------------------------------
--- cms:source-revision (original)
+++ cms:source-revision Wed Jun 6 12:39:18 2012
@@ -1 +1 @@
-1346823
+1346852
Added: websites/staging/stanbol/trunk/content/stanbol/development/coding.html
==============================================================================
--- websites/staging/stanbol/trunk/content/stanbol/development/coding.html (added)
+++ websites/staging/stanbol/trunk/content/stanbol/development/coding.html Wed Jun 6 12:39:18 2012
@@ -0,0 +1,129 @@
+<!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 - Coding</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"/>
+ <script type="text/javascript">
+ // Google Analytics Tracking Code
+ var _gaq = _gaq || [];
+ _gaq.push(['_setAccount', 'UA-32086816-1']);
+ _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 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>
+<li><a href="/stanbol/development/">Development</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>
+<li><a href="/stanbol/privacy-policy.html">Privacy Policy</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">Coding</h1>
+ <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>
+<p>The Apache Stanbol <a href="http://svn.apache.org/repos/asf/incubator/stanbol/">SVN</a>
+is divided into the classical trio of</p>
+<ul>
+<li>trunk: where the main development takes place</li>
+<li>branches: used for release branching and to implement prove of concepts
+ that are not yet ready to be part of the trunk</li>
+<li>tags: used for tagging releases, i.e. stable version of Apache Stanbol</li>
+</ul>
+<p>Additionally, there is the 'site' directory in the SVN. This holds the
+sources of the website you are currently reading. Apache Stanbol uses the
+<a href="https://blogs.apache.org/infra/entry/the_asf_cms">ASF CMS</a> to create
+and maintain its website.</p>
+<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>
+ </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>
Added: websites/staging/stanbol/trunk/content/stanbol/development/dependency-management.html
==============================================================================
--- websites/staging/stanbol/trunk/content/stanbol/development/dependency-management.html (added)
+++ websites/staging/stanbol/trunk/content/stanbol/development/dependency-management.html Wed Jun 6 12:39:18 2012
@@ -0,0 +1,180 @@
+<!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 - Dependency Management</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"/>
+ <script type="text/javascript">
+ // Google Analytics Tracking Code
+ var _gaq = _gaq || [];
+ _gaq.push(['_setAccount', 'UA-32086816-1']);
+ _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 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>
+<li><a href="/stanbol/development/">Development</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>
+<li><a href="/stanbol/privacy-policy.html">Privacy Policy</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">Dependency Management</h1>
+ <p>Apache Stanbol is a modular software stack. 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
+<a href="http://felix.apache.org/site/index.html">Apache Felix</a> 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><a href="#runtime-dependency-management">Runtime (OSGi) Dependency Management</a></li>
+<li><a href="#launcher-configuration-management">Launcher Configuration Management</a></li>
+</ol>
+<p><a name="build-dependency-management"></a></p>
+<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
+<a href="http://svn.apache.org/repos/asf/incubator/stanbol/trunk/parent/pom.xml">parent POM</a>.
+As all Apache Stanbol components define this central 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 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>
+<p><a name="runtime-dependency-management"></a></p>
+<h3 id="runtime-osgi-dependency-management">Runtime (OSGi) Dependency Management</h3>
+<p>Apache Stanbol components are OSGi bundles. Therefore, the runtime
+dependencies between such bundles are managed by the exported and imported
+packages of those bundles. What a bundle requires to import and what it
+exports is configured by using the Maven Bundle plugin of the Apache Felix
+project. Its configuration is done inside the POM. The Maven Bundle plugin
+ensures that the OSGi specific meta-information are generated correctly
+for the resulting JAR.</p>
+<p>Configuring the OSGi imports and exports is in most cases analogue to
+configure the build dependencies in the POM. We can not go into the details
+of OSGi here and refer to the
+<a href="http://www.osgi.org/">OSGi Alliance</a> and the
+<a href="http://felix.apache.org/site/index.html">Apache Felix</a> project
+for further information.</p>
+<p><a name="launcher-configuration-management"></a></p>
+<h3 id="launcher-configuration-management">Launcher Configuration Management</h3>
+<p>Launchers represent the binary distribution of Apache Stanbol. An Apache
+Stanbol launcher is a packaged OSGi runtime environment. It includes a set
+of Apache Stanbol components and required third party components to build up
+the runtime stack. Additionally, a launcher instantiates an Apache Stanbol
+HTTP endpoint to provide the RESTful interface and documentation.</p>
+<p>Basically, a launcher packages everything together in a single executable
+JAR that is needed to run Apache Stanbol. To configure which bundles are
+part of this launcher and to ensure that all required third party components
+are in place, the launchers are composed of so called 'partial bundlelists'.</p>
+<p>A partial bundlelist is defined by each Apache Stanbol component and it lists
+all required internal and external dependencies that have to be included in a
+launcher in order to make this component work. The dependencies are
+configured in a 'src/main/bundles/list.xml' file of each partial bundlelist
+artifact. The dependencies listed in such a file of a partial bundlelist
+are more or less the same as the ones defined for the build dependencies in
+the POM. But remember that the partial bundlelists define the dependencies
+needed at runtime and there may be other/more dependencies needed at runtime
+than at build time.</p>
+<p>Apache Stanbol pre-configures a set of launchers in the
+<a href="http://svn.apache.org/repos/asf/incubator/stanbol/trunk/launchers/">/launchers</a> directory.
+The most important one is the 'full' launcher which includes all available
+Apache Stanbol components. This launcher is also used when executing the
+integration tests. In a launcher's POM you just have to declare dependencies
+to all required partial bundlelists that the launcher should include.</p>
+ </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>
Modified: websites/staging/stanbol/trunk/content/stanbol/development/index.html
==============================================================================
--- websites/staging/stanbol/trunk/content/stanbol/development/index.html (original)
+++ websites/staging/stanbol/trunk/content/stanbol/development/index.html Wed Jun 6 12:39:18 2012
@@ -80,228 +80,20 @@
<h1 class="title">Development</h1>
<p>This site documents development related issues when working with the
Apache Stanbol source code and contributing to it.</p>
+<h2 id="software-development">Software Development</h2>
+<p>The following documents describe the software development practices that are
+followed by the Apache Stanbol project.</p>
<ul>
-<li><a href="#dependency-management">Dependency Management</a></li>
-<li><a href="#coding">Coding</a></li>
-<li><a href="#release-management">Release Management</a></li>
+<li><a href="dependency-management.html">Dependency Management</a></li>
+<li><a href="coding.html">Coding</a></li>
+<li><a href="release-management.html">Release Management</a></li>
</ul>
-<p><a name="dependency-management"></a></p>
-<h2 id="dependency-management">Dependency Management</h2>
-<p>Apache Stanbol is a modular software stack. 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
-<a href="http://felix.apache.org/site/index.html">Apache Felix</a> 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><a href="#runtime-dependency-management">Runtime (OSGi) Dependency Management</a></li>
-<li><a href="#launcher-configuration-management">Launcher Configuration Management</a></li>
-</ol>
-<p><a name="build-dependency-management"></a></p>
-<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>
+<h2 id="documentation">Documentation</h2>
+<p>A good documentation is nearly as important as the software itself. Here you
+can find information how to contribute to it.</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>
+<li><a href="website.html">Website</a></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
-<a href="http://svn.apache.org/repos/asf/incubator/stanbol/trunk/parent/pom.xml">parent POM</a>.
-As all Apache Stanbol components define this central 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 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>
-<p><a name="runtime-dependency-management"></a></p>
-<h3 id="runtime-osgi-dependency-management">Runtime (OSGi) Dependency Management</h3>
-<p>Apache Stanbol components are OSGi bundles. Therefore, the runtime
-dependencies between such bundles are managed by the exported and imported
-packages of those bundles. What a bundle requires to import and what it
-exports is configured by using the Maven Bundle plugin of the Apache Felix
-project. Its configuration is done inside the POM. The Maven Bundle plugin
-ensures that the OSGi specific meta-information are generated correctly
-for the resulting JAR.</p>
-<p>Configuring the OSGi imports and exports is in most cases analogue to
-configure the build dependencies in the POM. We can not go into the details
-of OSGi here and refer to the
-<a href="http://www.osgi.org/">OSGi Alliance</a> and the
-<a href="http://felix.apache.org/site/index.html">Apache Felix</a> project
-for further information.</p>
-<p><a name="launcher-configuration-management"></a></p>
-<h3 id="launcher-configuration-management">Launcher Configuration Management</h3>
-<p>Launchers represent the binary distribution of Apache Stanbol. An Apache
-Stanbol launcher is a packaged OSGi runtime environment. It includes a set
-of Apache Stanbol components and required third party components to build up
-the runtime stack. Additionally, a launcher instantiates an Apache Stanbol
-HTTP endpoint to provide the RESTful interface and documentation.</p>
-<p>Basically, a launcher packages everything together in a single executable
-JAR that is needed to run Apache Stanbol. To configure which bundles are
-part of this launcher and to ensure that all required third party components
-are in place, the launchers are composed of so called 'partial bundlelists'.</p>
-<p>A partial bundlelist is defined by each Apache Stanbol component and it lists
-all required internal and external dependencies that have to be included in a
-launcher in order to make this component work. The dependencies are
-configured in a 'src/main/bundles/list.xml' file of each partial bundlelist
-artifact. The dependencies listed in such a file of a partial bundlelist
-are more or less the same as the ones defined for the build dependencies in
-the POM. But remember that the partial bundlelists define the dependencies
-needed at runtime and there may be other/more dependencies needed at runtime
-than at build time.</p>
-<p>Apache Stanbol pre-configures a set of launchers in the
-<a href="http://svn.apache.org/repos/asf/incubator/stanbol/trunk/launchers/">/launchers</a> directory.
-The most important one is the 'full' launcher which includes all available
-Apache Stanbol components. This launcher is also used when executing the
-integration tests. In a launcher's POM you just have to declare dependencies
-to all required partial bundlelists that the launcher should include.</p>
-<p><a name="coding"></a></p>
-<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>
-<p>The Apache Stanbol <a href="http://svn.apache.org/repos/asf/incubator/stanbol/">SVN</a>
-is divided into the classical trio of</p>
-<ul>
-<li>trunk: where the main development takes place</li>
-<li>branches: used for release branching and to implement prove of concepts
- that are not yet ready to be part of the trunk</li>
-<li>tags: used for tagging releases, i.e. stable version of Apache Stanbol</li>
-</ul>
-<p>Additionally, there is the 'site' directory in the SVN. This holds the
-sources of the website you are currently reading. Apache Stanbol uses the
-<a href="https://blogs.apache.org/infra/entry/the_asf_cms">ASF CMS</a> to create
-and maintain its website.</p>
-<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>
-<p><a name="release-management"></a></p>
-<h2 id="release-process">Release Process</h2>
-<p>Before you do any release related action, you should definitely read the
-<a href="http://www.apache.org/dev/#releases">release sections</a> on the Apache
-website and the
-<a href="http://incubator.apache.org/guides/releasemanagement.html">incubator release management pages</a>.</p>
-<p>The Apache Stanbol release management process is very similar to the one
-followed by the <a href="http://sling.apache.org/">Apache Sling</a> project. Their
-<a href="http://sling.apache.org/site/release-management.html">release management documentation</a>
-is a must read for Apache Stanbol committers. </p>
-<p>Apache Stanbol is a modular software stack and therefore all of its modules
-basically have different release cycles. So each component of Apache Stanbol
-may be released independently of others. The only requirement is, that a
-released Apache Stanbol component may not have any SNAPSHOT dependencies to
-any other component it depends on.</p>
-<p>To release a single component, Apache Stanbol makes use the
-<a href="http://maven.apache.org/plugins/maven-release-plugin/">Maven Release plugin</a>.
-This plugin takes care of checking that there are no SNAPSHOT
-dependencies left. Additionally, there are some checks for legal issues
-automatically performed using the
-<a href="http://incubator.apache.org/rat/">Apache RAT</a> Maven plugin.</p>
-<p>To do a release test build, you have to activate the 'apache-release'
-profile, like it is done in this command:</p>
-<div class="codehilite"><pre><span class="nv">$</span> <span class="nv">mvn</span> <span class="n">install</span> <span class="o">-</span><span class="n">Papache</span><span class="o">-</span><span class="n">release</span>
-</pre></div>
-
-
-<p>The 'apache-release' profile will be automatically activated when the Maven Release plugin is used. For staging an official release with signing the
-released artifact, making SVN tags, and uploading the artifact to the
-staging repository, you start with</p>
-<div class="codehilite"><pre><span class="nv">$</span> <span class="nv">mvn</span> <span class="n">release:prepare</span> <span class="o">-</span><span class="n">DpreparationGoals</span><span class="o">=</span><span class="n">clean</span> <span class="n">install</span> <span class="o">-</span><span class="n">DscmCommentPrefix</span><span class="o">=</span><span class="n">STANBOL</span><span class="o">-</span><span class="n">XXX:</span>
-</pre></div>
-
-
-<p>Please, replace the XXX with the corresponding Jira issue number. After the release was prepared and tags created, the release has to be staged. This is done by executing the following command.</p>
-<div class="codehilite"><pre><span class="nv">$</span> <span class="nv">mvn</span> <span class="n">release:perform</span> <span class="o">-</span><span class="n">DreleaseProfiles</span><span class="o">=</span><span class="n">apache</span><span class="o">-</span><span class="n">release</span> <span class="o">-</span><span class="n">DscmCommentPrefix</span><span class="o">=</span><span class="n">STANBOL</span><span class="o">-</span><span class="n">XXX:</span>
-</pre></div>
-
-
-<p>For further information we refer to the
-<a href="http://sling.apache.org">Apache Sling</a>
-website and their very good
-<a href="http://sling.apache.org/site/release-management.html">documentation</a>
-of doing a release.</p>
-<h2 id="tips-tricks">Tips & Tricks</h2>
-<p>Here are some tips and tricks of commands that are useful, e.g. when examing the
-code base before a release.</p>
-<h3 id="determine-snapshot-dependencies">Determine SNAPSHOT dependencies</h3>
-<p>If you want to release a component, e.g. the Entity Hub, you have to know all
-used SNAPSHOT dependencies. We are especially interested in internal dependencies
-to other Apache Stanbol components. On a Unix system something like this could
-be used:</p>
-<div class="codehilite"><pre><span class="nv">$</span> <span class="nv">mvn</span> <span class="n">dependency:tree</span> <span class="o">|</span> <span class="nb">grep</span> <span class="o">\\-</span><span class="n">SNAPSHOT</span> <span class="o">|</span> <span class="n">sed</span> <span class="sr">s/.*org/org/</span> <span class="o">|</span> <span class="nb">sort</span> <span class="o">-</span><span class="n">u</span>
-</pre></div>
-
-
-<h3 id="update-version-of-parent-pom">Update version of parent POM</h3>
-<p>The parent POM got released and now we have to update to the new version in
-all artifacts. The
-<a href="http://www.java.net/external?url=http://mojo.codehaus.org/versions-maven-plugin/">Versions Maven Plugin</a>
-can help here. Is has a separate goal to
-<a href="http://mojo.codehaus.org/versions-maven-plugin/update-parent-mojo.html">update the parent</a>
-POM. The plugin searches in the local Maven repository for the latest available version of the
-parent POM and updates all POMs to this version. When executing this goal the parent POM itself
-must not be part of the build. So maybe you have to edit the top level reactor POM first. The
-used command looks as follows.</p>
-<div class="codehilite"><pre><span class="nv">$</span> <span class="nv">mvn</span> <span class="n">versions:update</span><span class="o">-</span><span class="n">parent</span> <span class="o">-</span><span class="n">DgenerateBackupPoms</span><span class="o">=</span><span class="n">false</span> <span class="o">-</span><span class="n">DallowSnapshots</span><span class="o">=</span><span class="n">true</span>
-</pre></div>
-
-
-<p>If you want to update to the latest non-SNAPSHOT version, you have to set 'allowSnapshots'
-to 'false' (default). A backup of the changed POMs is not needed when files are under
-SVN control. To revert any local changes, you could use</p>
-<div class="codehilite"><pre><span class="nv">$</span> <span class="nv">svn</span> <span class="n">revert</span> <span class="o">-</span><span class="n">R</span> <span class="o">*</span>
-</pre></div>
-
-
-<h3 id="exclude-files-from-check-for-modifcations">Exclude files from check for modifcations</h3>
-<p>When you use</p>
-<div class="codehilite"><pre><span class="nv">$</span> <span class="nv">mvn</span> <span class="n">release:prepare</span>
-</pre></div>
-
-
-<p>it will check for local modifications. If you want to exclude some files from this check,
-e.g. a RAT report file named "rat.txt", you can do it like this</p>
-<div class="codehilite"><pre><span class="nv">$</span> <span class="nv">mvn</span> <span class="n">release:prepare</span> <span class="o">-</span><span class="n">DcheckModificationExcludeList</span><span class="o">=</span><span class="n">rat</span><span class="o">.</span><span class="n">txt</span>
-</pre></div>
-
-
-<h3 id="change-the-comment-when-creating-commiting-changes">Change the comment when creating commiting changes</h3>
-<p>The default commit comment starts with "[maven-release-plugin]" when using the Maven Release Plugin.
-You can change this and e.g. set it to a Stanbol Jira issue number.</p>
-<div class="codehilite"><pre><span class="nv">$</span> <span class="nv">mvn</span> <span class="n">release:prepare</span> <span class="o">-</span><span class="n">DscmCommentPrefix</span><span class="o">=</span><span class="n">STANBOL</span><span class="o">-</span><span class="n">XXX:</span>
-</pre></div>
</div>
<div id="footer">
Added: websites/staging/stanbol/trunk/content/stanbol/development/release-management.html
==============================================================================
--- websites/staging/stanbol/trunk/content/stanbol/development/release-management.html (added)
+++ websites/staging/stanbol/trunk/content/stanbol/development/release-management.html Wed Jun 6 12:39:18 2012
@@ -0,0 +1,187 @@
+<!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 - Release Management</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"/>
+ <script type="text/javascript">
+ // Google Analytics Tracking Code
+ var _gaq = _gaq || [];
+ _gaq.push(['_setAccount', 'UA-32086816-1']);
+ _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 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>
+<li><a href="/stanbol/development/">Development</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>
+<li><a href="/stanbol/privacy-policy.html">Privacy Policy</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">Release Management</h1>
+ <p>Before you do any release related action, you should definitely read the
+<a href="http://www.apache.org/dev/#releases">release sections</a> on the Apache
+website and the
+<a href="http://incubator.apache.org/guides/releasemanagement.html">incubator release management pages</a>.</p>
+<p>The Apache Stanbol release management process is very similar to the one
+followed by the <a href="http://sling.apache.org/">Apache Sling</a> project. Their
+<a href="http://sling.apache.org/site/release-management.html">release management documentation</a>
+is a must read for Apache Stanbol committers. </p>
+<p>Apache Stanbol is a modular software stack and therefore all of its modules
+basically have different release cycles. So each component of Apache Stanbol
+may be released independently of others. The only requirement is, that a
+released Apache Stanbol component may not have any SNAPSHOT dependencies to
+any other component it depends on.</p>
+<p>To release a single component, Apache Stanbol makes use the
+<a href="http://maven.apache.org/plugins/maven-release-plugin/">Maven Release plugin</a>.
+This plugin takes care of checking that there are no SNAPSHOT
+dependencies left. Additionally, there are some checks for legal issues
+automatically performed using the
+<a href="http://incubator.apache.org/rat/">Apache RAT</a> Maven plugin.</p>
+<p>To do a release test build, you have to activate the 'apache-release'
+profile, like it is done in this command:</p>
+<div class="codehilite"><pre><span class="nv">$</span> <span class="nv">mvn</span> <span class="n">install</span> <span class="o">-</span><span class="n">Papache</span><span class="o">-</span><span class="n">release</span>
+</pre></div>
+
+
+<p>The 'apache-release' profile will be automatically activated when the Maven Release plugin is used. For staging an official release with signing the
+released artifact, making SVN tags, and uploading the artifact to the
+staging repository, you start with</p>
+<div class="codehilite"><pre><span class="nv">$</span> <span class="nv">mvn</span> <span class="n">release:prepare</span> <span class="o">-</span><span class="n">DpreparationGoals</span><span class="o">=</span><span class="n">clean</span> <span class="n">install</span> <span class="o">-</span><span class="n">DscmCommentPrefix</span><span class="o">=</span><span class="n">STANBOL</span><span class="o">-</span><span class="n">XXX:</span>
+</pre></div>
+
+
+<p>Please, replace the XXX with the corresponding Jira issue number. After the release was prepared and tags created, the release has to be staged. This is done by executing the following command.</p>
+<div class="codehilite"><pre><span class="nv">$</span> <span class="nv">mvn</span> <span class="n">release:perform</span> <span class="o">-</span><span class="n">DreleaseProfiles</span><span class="o">=</span><span class="n">apache</span><span class="o">-</span><span class="n">release</span> <span class="o">-</span><span class="n">DscmCommentPrefix</span><span class="o">=</span><span class="n">STANBOL</span><span class="o">-</span><span class="n">XXX:</span>
+</pre></div>
+
+
+<p>For further information we refer to the
+<a href="http://sling.apache.org">Apache Sling</a>
+website and their very good
+<a href="http://sling.apache.org/site/release-management.html">documentation</a>
+of doing a release.</p>
+<h2 id="tips-tricks">Tips & Tricks</h2>
+<p>Here are some tips and tricks of commands that are useful, e.g. when examing the
+code base before a release.</p>
+<h3 id="determine-snapshot-dependencies">Determine SNAPSHOT dependencies</h3>
+<p>If you want to release a component, e.g. the Entity Hub, you have to know all
+used SNAPSHOT dependencies. We are especially interested in internal dependencies
+to other Apache Stanbol components. On a Unix system something like this could
+be used:</p>
+<div class="codehilite"><pre><span class="nv">$</span> <span class="nv">mvn</span> <span class="n">dependency:tree</span> <span class="o">|</span> <span class="nb">grep</span> <span class="o">\\-</span><span class="n">SNAPSHOT</span> <span class="o">|</span> <span class="n">sed</span> <span class="sr">s/.*org/org/</span> <span class="o">|</span> <span class="nb">sort</span> <span class="o">-</span><span class="n">u</span>
+</pre></div>
+
+
+<h3 id="update-version-of-parent-pom">Update version of parent POM</h3>
+<p>The parent POM got released and now we have to update to the new version in
+all artifacts. The
+<a href="http://www.java.net/external?url=http://mojo.codehaus.org/versions-maven-plugin/">Versions Maven Plugin</a>
+can help here. Is has a separate goal to
+<a href="http://mojo.codehaus.org/versions-maven-plugin/update-parent-mojo.html">update the parent</a>
+POM. The plugin searches in the local Maven repository for the latest available version of the
+parent POM and updates all POMs to this version. When executing this goal the parent POM itself
+must not be part of the build. So maybe you have to edit the top level reactor POM first. The
+used command looks as follows.</p>
+<div class="codehilite"><pre><span class="nv">$</span> <span class="nv">mvn</span> <span class="n">versions:update</span><span class="o">-</span><span class="n">parent</span> <span class="o">-</span><span class="n">DgenerateBackupPoms</span><span class="o">=</span><span class="n">false</span> <span class="o">-</span><span class="n">DallowSnapshots</span><span class="o">=</span><span class="n">true</span>
+</pre></div>
+
+
+<p>If you want to update to the latest non-SNAPSHOT version, you have to set 'allowSnapshots'
+to 'false' (default). A backup of the changed POMs is not needed when files are under
+SVN control. To revert any local changes, you could use</p>
+<div class="codehilite"><pre><span class="nv">$</span> <span class="nv">svn</span> <span class="n">revert</span> <span class="o">-</span><span class="n">R</span> <span class="o">*</span>
+</pre></div>
+
+
+<h3 id="exclude-files-from-check-for-modifcations">Exclude files from check for modifcations</h3>
+<p>When you use</p>
+<div class="codehilite"><pre><span class="nv">$</span> <span class="nv">mvn</span> <span class="n">release:prepare</span>
+</pre></div>
+
+
+<p>it will check for local modifications. If you want to exclude some files from this check,
+e.g. a RAT report file named "rat.txt", you can do it like this</p>
+<div class="codehilite"><pre><span class="nv">$</span> <span class="nv">mvn</span> <span class="n">release:prepare</span> <span class="o">-</span><span class="n">DcheckModificationExcludeList</span><span class="o">=</span><span class="n">rat</span><span class="o">.</span><span class="n">txt</span>
+</pre></div>
+
+
+<h3 id="change-the-comment-when-creating-commiting-changes">Change the comment when creating commiting changes</h3>
+<p>The default commit comment starts with "[maven-release-plugin]" when using the Maven Release Plugin.
+You can change this and e.g. set it to a Stanbol Jira issue number.</p>
+<div class="codehilite"><pre><span class="nv">$</span> <span class="nv">mvn</span> <span class="n">release:prepare</span> <span class="o">-</span><span class="n">DscmCommentPrefix</span><span class="o">=</span><span class="n">STANBOL</span><span class="o">-</span><span class="n">XXX:</span>
+</pre></div>
+ </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>
Modified: websites/staging/stanbol/trunk/content/stanbol/development/website.html
==============================================================================
--- websites/staging/stanbol/trunk/content/stanbol/development/website.html (original)
+++ websites/staging/stanbol/trunk/content/stanbol/development/website.html Wed Jun 6 12:39:18 2012
@@ -78,7 +78,9 @@
<div id="content">
<h1 class="title">Website Development</h1>
- <p>Apache Stanbol uses the <a href="">ASF CMS</a> to manage its website. With this approach
+ <p>Apache Stanbol uses the
+<a href="http://www.apache.org/dev/cms.html">ASF CMS</a>
+to manage its website. With this approach
the website sources are hosted in SVN along the software sources. The website
source can be checked out from:</p>
<div class="codehilite"><pre><span class="n">http:</span><span class="sr">//s</span><span class="n">vn</span><span class="o">.</span><span class="n">apache</span><span class="o">.</span><span class="n">org</span><span class="sr">/repos/</span><span class="n">asf</span><span class="sr">/incubator/s</span><span class="n">tanbol</span><span class="sr">/site/</span><span class="n">trunk</span><span class="o">/</span>
@@ -91,18 +93,18 @@ This makes it very easy to write, edit a
write HTML.</p>
<h2 id="how-to-contribute-to-the-website">How to contribute to the website</h2>
<p>We are always trying to improve the available documentation and sources of
-information about Apache Stanbol. To contribute to the website is just as
-easy as to contribute a patch to the software sources.</p>
-<p>For your contribution you should first open a new
-<a href="https://issues.apache.org/jira/browse/STANBOL">Jira issue</a> describing
-your desired changes.</p>
-<p>Then you checkout the current version of the website sources from the SVN
-and make your changes. See the existing content for how to add images and
+information about Apache Stanbol. To contribute to the website is just as easy
+as to contribute a patch to the software sources.</p>
+<p>For your contribution you should first open a new <a href="https://issues.apache.org/jira/browse/STANBOL">Jira
+issue</a> describing your desired
+changes.</p>
+<p>Then you checkout the current version of the website sources from the SVN and
+make your changes. See the existing content for how to add images and
additional files.</p>
-<p>When you have finished, you create a patch from your
-changes. Zip your patch and upload it to the issue created prior. A
-committer will catch it up and commit your changes after a short review
-to the SVN. This will trigger the publishing process.</p>
+<p>When you have finished, you create a patch from your changes. Zip your patch
+and upload it to the issue created prior. A committer will catch it up and
+commit your changes after a short review to the SVN. This will trigger the
+publishing process.</p>
<h2 id="publishing-process">Publishing process</h2>
<p>Changes to the website are committed to the SVN. This trigger an automatic
build process of the website.</p>