Author: agruber
Date: Fri Nov 4 09:08:28 2011
New Revision: 1197442
URL: http://svn.apache.org/viewvc?rev=1197442&view=rev
Log:
Added explanation on documentation structureSTANBOL-365
Modified:
incubator/stanbol/site/trunk/content/stanbol/docs/trunk/index.mdtext
Modified: incubator/stanbol/site/trunk/content/stanbol/docs/trunk/index.mdtext
URL:
http://svn.apache.org/viewvc/incubator/stanbol/site/trunk/content/stanbol/docs/trunk/index.mdtext?rev=1197442&r1=1197441&r2=1197442&view=diff
==============================================================================
--- incubator/stanbol/site/trunk/content/stanbol/docs/trunk/index.mdtext
(original)
+++ incubator/stanbol/site/trunk/content/stanbol/docs/trunk/index.mdtext Fri
Nov 4 09:08:28 2011
@@ -1,11 +1,22 @@
Title: Apache Stanbol - services for semantic content management
-## How to build, install and run Apache Stanbol
+The documentation of its services and components can be retrieved from
different places:
-As there is no official release of Apache Stanbol so far, one needs to build
the software from source.
+1. Below, you get the description how to build, install and run Apache
Stanbol, its major features as well as scenarios how to use it.
+1. Every running Stanbol server provides you with further descriptions at its
Web UI and for the RESTful web services for each component.
-### Installation
+1. An even more detailed technical documentation can be found within
Readme.files wihin the [source
code](http://svn.apache.org/repos/asf/incubator/stanbol/trunk/).
+
+
+
+
+## 1. How to build, install and run Apache Stanbol
+
+As there is no official release of Apache Stanbol so far, one needs to install
and build the software from source. As an alternative, you may download
+
+
+### 1.1. Installation
1. To build Stanbol from source you need Java 6 and maven 2.2.1 + (version as
defined in the pom). You probably need also: <code>$ export
MAVEN_OPTS="-Xmx512M -XX:MaxPermSize=128M </code>
@@ -21,7 +32,7 @@ As there is no official release of Apach
_Updating sources_: From your Stanbol root directory call <code>$ mvn
clean</code>, then <code>% svn update</code> and build a new version with
<code>$ mvn clean install</code>.
-### Launch the Server
+### 1.2. Launch the Server
Several launchers are available under the <code>launchers/</code> directory:
@@ -42,12 +53,28 @@ Upon first startup, a folder named `slin
contains Stanbol's persistent data, deployment configuration and logs.
-### HTTP entry points
+### 1.3. HTTP entry points
The web interface of your Apache Stanbol installation provides information for
the main HTTP entry points. Each resource comes with a web view that documents
the matching RESTful API for applications. Depending on which launcher you use,
you will get a different set of [services](services.html).
+## 2. Technical Documentation
-## Usage Scenarios for Apache Stanbol
+A detailed technical documentation of its services and components can be found
here:
+
+* [Stanbol Services](services.html)
+* [Enhancer](enhancer.html)
+* [Enhancement Engines](engines.html)
+* [Entityhub](entityhub.html)
+* [Contenthub](contenthub.html)
+* [CMS Adapter](cmsadapter.html)
+* Ontology Manager
+* Reasoners
+* Reengineer
+* [Rules](rules.html)
+* FactStore
+* Benchmark
+
+## 3. Usage Scenarios for Apache Stanbol
* [Basic Content Enhancement](contentenhancement.html)
@@ -73,23 +100,6 @@ The web interface of your Apache Stanbol
* Provide repository structures as thesaurus or domain ontology, e.g.
categories.
-## Technical Documentation
-
-A detailed technical documentation of its services and components can be found
here:
-
-* [Stanbol Services](services.html)
-* [Enhancer](enhancer.html)
-* [Enhancement Engines](engines.html)
-* [Entityhub](entityhub.html)
-* [Contenthub](contenthub.html)
-* [CMS Adapter](cmsadapter.html)
-* Ontology Manager
-* Reasoners
-* Reengineer
-* [Rules](rules.html)
-* FactStore
-* Benchmark
-
## Follow and support Apache Stanbol
@@ -97,11 +107,4 @@ A detailed technical documentation of it
- Please report bugs on the [Apache issue
tracker](https://issues.apache.org/jira/browse/STANBOL)
-[iks]: http://www.iks-project.eu/
-[stan-home]: http://incubator.apache.org/stanbol/
-[stan-admin]: http://localhost:8080/system/console/
-[stan-engines]: http://localhost:8080/engines
-[stan-contenthub]: http://localhost:8080/contenthub
-[stan-rules]: http://localhost:8080/rules
-
