aries-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
Subject svn commit: r1693563 - in /aries/site/trunk: content/ content/development/ templates/
Date Fri, 31 Jul 2015 10:26:31 GMT
Author: cschneider
Date: Fri Jul 31 10:26:31 2015
New Revision: 1693563

Cleanup and Restructuring


Added: aries/site/trunk/content/development/architecture.mdtext
--- aries/site/trunk/content/development/architecture.mdtext (added)
+++ aries/site/trunk/content/development/architecture.mdtext Fri Jul 31 10:26:31 2015
@@ -0,0 +1,11 @@
+Title: ModuleDependencies
+<a name="ModuleDependencies-Modulebuildtimedependencies"></a>
+# Module build time dependencies
+There are build time dependencies between Aries modules. This diagram shows
+the dependencies. For example, if you need to build 0.2-incubating JPA
+module you will find that you need to have built (or have available)
+parent, testsupport, util, blueprint, quiesce and transaction at the level
+specified in the pom.xml for the JPA module.

Modified: aries/site/trunk/content/development/buildingaries.mdtext
--- aries/site/trunk/content/development/buildingaries.mdtext (original)
+++ aries/site/trunk/content/development/buildingaries.mdtext Fri Jul 31 10:26:31 2015
@@ -30,16 +30,8 @@ As a next step you can run the tests too
 After these steps you should have imported your selected aries projects into eclipse. 
-<a name="BuildingAries-CodeStyle"></a>
-# Code Styles
-There are not yet complete code formatters and checkstyle rules for aries. In the mean time
you can set these rules.
-* 4 spaces instead of tabs
-* Line width 130 characters
 <a name="BuildingAries-Outofmemoryerrors"></a>
-##### Out of memory errors
+# Out of memory errors
 You may find that building Aries fails with out of memory exceptions on
 some systems (eg Mac)  if you use the standard Java settings. Setting the
 two environment variables as shown below may help.

Added: aries/site/trunk/content/development/guidelines.mdtext
--- aries/site/trunk/content/development/guidelines.mdtext (added)
+++ aries/site/trunk/content/development/guidelines.mdtext Fri Jul 31 10:26:31 2015
@@ -0,0 +1,48 @@
+Title: Coding guidelines
+<a name="BuildingAries-CodeStyle"></a>
+# Code Style
+There are not yet complete code formatters and checkstyle rules for aries. In the mean time
you can set these rules.
+* 4 spaces instead of tabs
+* Line width 130 characters
+<a name="MavenbestpracticeinAries-Assembledbestpracticenotes"></a>
+# Maven best practice in Aries development
+<a name="MavenbestpracticeinAries-Overallstructure"></a>
+### Overall structure
+The Aries project is a collection of loosely couple bundles, therefore
+it must be possible to build each bundle on its own. This implies:
+1. A parent pom that isn't at the root of the SVN trunk.
+1. Each bundle has enough pom info so that it can be released
+1. parent/default-parent has dependency management for basic osgi-dependencies that
+all projects are almost certain to use (this includes PAX dependencies for
+1. Each bundle has legal files in its checkout root.
+1. Each bundle has an SCM element in its top level pom.
+1. Bundles do not (except samples) have sub-modules.
+<a name="MavenbestpracticeinAries-Goodpracticeinthepom"></a>
+### Good practice in the pom
+1. Alphabetic ordering in dependency management is helpful
+1. Include a brief description of the project
+1. Commenting in platform dependencies, see samples assembly projects.
+1. Use ${project.version} _not_ ${version} for Maven 3 compatibility.
+<a name="MavenbestpracticeinAries-GroupandArtifactnames"></a>
+### Group and Artifact names 
+1. The Bundle Symbolic Name is explicitly set to the Maven artifactId. For
+projects which deliver bundles, the artifactID will therefore completely
+describe the jar and must begin org.apache.aries.\{subproject\}. For
+projects which do not deliver bundles (for example agregator projects) it
+is acceptable to use a short descriptive artifactID.
+1. The group ID will overlap with the artifactId and will normally be of the
+form org.apache.aries.\{subproject\}

Modified: aries/site/trunk/content/index.mdtext
--- aries/site/trunk/content/index.mdtext (original)
+++ aries/site/trunk/content/index.mdtext Fri Jul 31 10:26:31 2015
@@ -16,13 +16,10 @@ implementations (and extensions) of the
   - Subsystem Service Specification
 The specifications are defined in the OSGi Alliance Enterprise Expert Group (EEG) for deployment
to a variety of OSGi
-based runtimes.
-The OSGi R5 Enterprise Specification can be found here:
+based runtimes. The OSGi R5 Enterprise Specification can be found here:
 To understand the complete scope of the Aries project, see the Aries
 proposal document on the [incubator wiki](
@@ -32,13 +29,3 @@ To understand how to _use_ Aries compone
  pages which guides you through how to build the Aries code, provides
 sample applications and describes how to set up an environment in which to
 run the consuming application.
-The Aries project provides enterprise OSGi componentry such as the Blueprint container
-and projects to integrate enterprise technologies such as JTA, JNDI and JPA
-into an OSGi environment to make these available to OSGi bundles. Some
-Aries components, such as the Aries Blueprint container, require nothing
-more than an OSGi framework (such as Equinox or Felix) to run on; others
-are intended to be integrated into application server or integration
-runtimes such as Apache ServiceMix or Apache Geronimo.
-Continuous builds of the Aries project are available for download from [](

Modified: aries/site/trunk/templates/navigation.mdtext
--- aries/site/trunk/templates/navigation.mdtext (original)
+++ aries/site/trunk/templates/navigation.mdtext Fri Jul 31 10:26:31 2015
@@ -3,9 +3,6 @@
 	<div class="menuitem">
 		<a href="/overview/boardreports.html">Board Reports</a> 
-	<div class="menuitem">
-		<a href="/overview/news.html">News</a> 
-	</div>
 <div onclick="SwitchMenu('modules')" id="modulesTitle" class="menutitle">Modules</div>
 <div id="modules" class="menuitemgroup">
@@ -52,6 +49,10 @@
 		<a href="/modules/transactionsproject.html">Transactions</a> 
 	<div class="menuitem">
+        <div class="menuitem">
+                <a href="/development/resources.html">Developer Resources</a>

+        </div>
+	<div class="menuitem">
 		<a href="/modules/spi-fly.html">SPI Fly</a> 
 	<div class="menuitem">

View raw message