You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@stanbol.apache.org by fl...@apache.org on 2012/10/25 14:09:39 UTC
svn commit: r1402121 - in /stanbol/site/trunk/content/production:
file-bundle-configuration.mdtext partial-updates.mdtext your-launcher.mdtext
Author: florent
Date: Thu Oct 25 12:09:38 2012
New Revision: 1402121
URL: http://svn.apache.org/viewvc?rev=1402121&view=rev
Log:
STANBOL-789 md format
Modified:
stanbol/site/trunk/content/production/file-bundle-configuration.mdtext
stanbol/site/trunk/content/production/partial-updates.mdtext
stanbol/site/trunk/content/production/your-launcher.mdtext
Modified: stanbol/site/trunk/content/production/file-bundle-configuration.mdtext
URL: http://svn.apache.org/viewvc/stanbol/site/trunk/content/production/file-bundle-configuration.mdtext?rev=1402121&r1=1402120&r2=1402121&view=diff
==============================================================================
--- stanbol/site/trunk/content/production/file-bundle-configuration.mdtext (original)
+++ stanbol/site/trunk/content/production/file-bundle-configuration.mdtext Thu Oct 25 12:09:38 2012
@@ -1,11 +1,10 @@
Title: File based bundle configuration
-* During development and deployment process it can be a pain have to reconfigure all your bundles in the Felix web interface.
-
-* Stanbol offer the bundleconfig mechanism that allow you to save this configurations and apply them automatically.
-
-* A bundleconfig artifact is a Maven project with this structure :
+During development and deployment process it can be a pain have to reconfigure all your bundles in the Felix web interface.
+Stanbol offer the **bundleconfig** mechanism that allow you to save this configurations and apply them automatically.
+A bundleconfig artifact is a Maven project with this structure :
+<pre>
mybundlelistFolder
|
|- pom.xml
@@ -16,15 +15,14 @@ Title: File based bundle configuration
|- config1.conf
|- config2.conf
|- ....
+</pre>
-* The pom.xml has nothing special. You can copy [this one](https://svn.apache.org/repos/asf/stanbol/trunk/data/defaultconfig/pom.xml) for example and only adapt group and artifact ID to suit your project naming convention.
-
-* The configurations are held by files in the src/main/resources/config folder.
-* This configurations files need to respect this naming convention :
- * {bundleArtifactID}-{uniqueID}.conf, where {uniqueID} can be anything.
+The pom.xml has nothing special. You can copy [this one](https://svn.apache.org/repos/asf/stanbol/trunk/data/defaultconfig/pom.xml) for example and only adapt group and artifact ID to suit your project naming convention.
+The configurations are held by files in the src/main/resources/config folder. This configurations files :
+* need to respect this naming convention :
+ * {bundleArtifactID}-{uniqueID}.conf, where {uniqueID} can be anything but unique to not be overloaded.
* for example a configuration file with this name "org.apache.stanbol.enhancer.engines.keywordextraction.engine.KeywordLinkingEngine-entityhub.config" will be used to configure the Keyword Linking Engine bundle.
-
-* The content of this configuration files are key-values pairs where :
+* contains key-values pairs lines where :
* the key is the fully qualified name of the property (example : org.apache.stanbol.enhancer.engines.keywordextraction.maxSuggestions)
* and the value is a string that contains the needed value for the property. To ensure a correct binding between the value in the configuration file and the property's Java type, this conventions are helpfull :
* *"my value"* : for String properties
@@ -32,4 +30,4 @@ Title: File based bundle configuration
* *I"5"* : for int properties
* *["value1","value2"]* : for String collection properties
-* Of course, this bundleconfig bundle can be added to your [custom launcher and bundlelist](your-launcher.html), just be careful to define a higher startlevel to your bundleconfig than the configured bundles' startlevel.
+Of course, this bundleconfig bundle can be added to your [custom launcher and bundlelist](your-launcher.html), just be careful to define a higher startlevel to your bundleconfig than the configured bundles' startlevel.
Modified: stanbol/site/trunk/content/production/partial-updates.mdtext
URL: http://svn.apache.org/viewvc/stanbol/site/trunk/content/production/partial-updates.mdtext?rev=1402121&r1=1402120&r2=1402121&view=diff
==============================================================================
--- stanbol/site/trunk/content/production/partial-updates.mdtext (original)
+++ stanbol/site/trunk/content/production/partial-updates.mdtext Thu Oct 25 12:09:38 2012
@@ -3,9 +3,10 @@ Title: Hot partial Stanbol update
One of the biggest "cool feature" of OSGI is the capability to update pieces of the server without restart it.
Felix web interface allow you to do this with click, but it's not always comfortable to do this way (production environment, numerous bundles to update,...).
The Apache Sling File Provider allow you to define a folder, where you just have to drop/update/delete your bundle to get your server in sync.
+
Follow this two step procedure to enjoy this feature :
-0. Install the "Sling File Provider" Bundle (not needed as this is included by default in Stanbol)
-1. Configure the "sling.fileinstall.dir" property: You can add this to the "{stanbol-working-dir}/stanbol/sling.properties file" or parse it as a system property '-Dsling.fileinstall.dir={path-to-dir}' when you start stanbol.
-2. Create the referenced Folder on you file system.
+* 0. Install the "Sling File Provider" Bundle (not needed as this is included by default in Stanbol)
+* 1. Configure the "sling.fileinstall.dir" property: You can add this to the "{stanbol-working-dir}/stanbol/sling.properties file" or parse it as a system property '-Dsling.fileinstall.dir={path-to-dir}' when you start stanbol.
+* 2. Create the referenced Folder on you file system.
-Note : this procedure was extracted for a Rupert Westenthaler's mail. Thanks to him to spot it !
+Note : this procedure was extracted for a Rupert Westenthaler's [mail](http://markmail.org/message/jpxpl6x4nkmz6kda). Thanks to him to spot it !
Modified: stanbol/site/trunk/content/production/your-launcher.mdtext
URL: http://svn.apache.org/viewvc/stanbol/site/trunk/content/production/your-launcher.mdtext?rev=1402121&r1=1402120&r2=1402121&view=diff
==============================================================================
--- stanbol/site/trunk/content/production/your-launcher.mdtext (original)
+++ stanbol/site/trunk/content/production/your-launcher.mdtext Thu Oct 25 12:09:38 2012
@@ -2,14 +2,12 @@ Title: Build your launcher
# Principle
-* A Stanbol launcher is a big set of bundles that work together and provide features packages (EntityHub, ContentHub, Enhancer,...).
-* Each features package need a list of bundles to work smoothly.
-* Thanks for Stanbol design, you can have in your server only some of the proposed features package (for example only the EntityHub and Enhancer, without others features). You only need all required bundles for the features package you want.
+A Stanbol launcher is a big set of bundles that work together and provide features packages (EntityHub, ContentHub, Enhancer,...). Each features package need a list of bundles to work smoothly.
-* Identify and manually add all feature's required bundles can be pain and long.
-* Hopefully, the *bundlelist* mechanism allow the creation of specific set of bundles that will be added together to the launcher and started in the right way.
+Thanks for Stanbol design, you can have in your server only some of the proposed features package (for example only the EntityHub and Enhancer, without others features). Then you only need required bundles for the features package you want.
+But identify and manually add all feature's required bundles can be pain and long. Hopefully, the **bundlelist** mechanism allow the creation of specific set of bundles that will be added together to the launcher and started in the right way.
-* Stanbol launcher's use this bundlelist mechanism. Let's dive into the details.
+Stanbol launcher's use this bundlelist mechanism. Let's dive into the details.
# Use existing bundlelists to build your launcher
@@ -17,7 +15,7 @@ Title: Build your launcher
* Bundlelist are in fact just jar. So you just need to declare them as dependencies in you launcher pom.xml to get the feature package and all required bundle for it.
* For example, if you want the entityHub feature in you server, you only need to add this dependency to your launcher pom.xml :
-<code>
+<pre>
<dependency>
<groupId>org.apache.stanbol</groupId>
<artifactId>org.apache.stanbol.entityhub.bundlelist</artifactId>
@@ -25,9 +23,9 @@ Title: Build your launcher
<type>partialbundlelist</type>
<scope>provided</scope>
</dependency>
-</code>
+</pre>
-* please note the <type>partialbundlelist</type> of the dependency.
+* Please note the <pre><type>partialbundlelist</type></pre> property of the dependency.
* Also in actual Stanbol code base you can easily detect feature package bundlelist as their artifactId has the structure org.apache.stanbol.{feature-name}.bundlelist
## Build *your* launcher
@@ -57,7 +55,7 @@ Title: Build your launcher
* The bundlelist mechanism is the perfect and simple way to include your list of bundles into your launcher !
-## Build **your** bundlelist dependency
+## Build *your** bundlelist dependency
* Bundlelist (or partialbundlelist) artifact is a really simple Maven project that rely on this structure :
@@ -93,22 +91,22 @@ Title: Build your launcher
* You can find and extensive bundlelist definition for inspiration in the [Enhancer bundlelist list.xml](http://svn.apache.org/repos/asf/stanbol/trunk/enhancer/bundlelist/src/main/bundles/list.xml).
-## Add **your** bundlelist to **your** launcher
+## Add *your* bundlelist to *your* launcher
* Let's says that your bundlelist pom.xml contains :
-
+<pre>
<groupId>com.example</groupId>
<artifactId>my.bundlelist</artifactId>
<version>0.10.0-SNAPSHOT</version>
<packaging>partialbundlelist</packaging>
-
+</pre>
* Bring your bundles into your launcher only require you to edit my-launcher/pom.xml and add in <dependencies> section, this one :
-
+<pre>
<dependency>
<groupId>com.example</groupId>
<artifactId>my.bundlelist</artifactId>
<version>0.10.0-SNAPSHOT</version>
<packaging>partialbundlelist</packaging>
</dependency>
-
+</pre>
* Stanbol is now all yours !