svn commit: r817222 - in /websites/staging/stanbol/trunk/content: ./ stanbol/development/index.html

[bu...@apache.org]

Author: buildbot
Date: Fri May 11 12:21:39 2012
New Revision: 817222

Log:
Staging update by buildbot for stanbol

Modified:
    websites/staging/stanbol/trunk/content/   (props changed)
    websites/staging/stanbol/trunk/content/stanbol/development/index.html

Propchange: websites/staging/stanbol/trunk/content/
------------------------------------------------------------------------------
--- cms:source-revision (original)
+++ cms:source-revision Fri May 11 12:21:39 2012
@@ -1 +1 @@
-1336752
+1337127

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 Fri May 11 12:21:39 2012
@@ -64,7 +64,15 @@
   
   <div id="content">
     <h1 class="title">Development</h1>
-    <h2 id="dependency-management">Dependency Management</h2>
+    <p>This site documents development related issues when working with the
+Apache Stanbol source code and contributing to it.</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>
+</ul>
+<p><a name="dependency-management" /></p>
+<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
@@ -73,10 +81,11 @@ an OSGi environment. Apache Stanbol uses
 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>
+<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" /></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>
@@ -95,21 +104,25 @@ 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
+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 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
+<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" /></p>
 <h3 id="runtime-osgi-dependency-management">Runtime (OSGi) Dependency Management</h3>
+<p><a name="launcher-configuration-management" /></p>
 <h3 id="launcher-configuration-management">Launcher Configuration Management</h3>
+<p><a name="coding" /></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
@@ -117,6 +130,18 @@ code conventions for this IDE can be imp
 '/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
@@ -133,6 +158,7 @@ developer has to keep in mind when writi
     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" /></p>
 <h2 id="release-process">Release Process</h2>
   </div>