svn commit: r1226678 - in /karaf/site/trunk/src/main/webapp: index/subprojects/cave.page index/subprojects/cave/ index/subprojects/cave/building.page index/subprojects/cave/download.page index/subprojects/cave/source.page site/navigation.page

[jb...@apache.org]

Author: jbonofre
Date: Tue Jan  3 07:04:41 2012
New Revision: 1226678

URL: http://svn.apache.org/viewvc?rev=1226678&view=rev
Log:
[KARAF-876] Add Cave resources

Added:
    karaf/site/trunk/src/main/webapp/index/subprojects/cave/
    karaf/site/trunk/src/main/webapp/index/subprojects/cave/building.page
    karaf/site/trunk/src/main/webapp/index/subprojects/cave/download.page
    karaf/site/trunk/src/main/webapp/index/subprojects/cave/source.page
Modified:
    karaf/site/trunk/src/main/webapp/index/subprojects/cave.page
    karaf/site/trunk/src/main/webapp/site/navigation.page

Modified: karaf/site/trunk/src/main/webapp/index/subprojects/cave.page
URL: http://svn.apache.org/viewvc/karaf/site/trunk/src/main/webapp/index/subprojects/cave.page?rev=1226678&r1=1226677&r2=1226678&view=diff
==============================================================================
--- karaf/site/trunk/src/main/webapp/index/subprojects/cave.page (original)
+++ karaf/site/trunk/src/main/webapp/index/subprojects/cave.page Tue Jan  3 07:04:41 2012
@@ -6,9 +6,20 @@ page_modifier: jbonofre
 --- pipeline:conf
 h2. Karaf Cave
 
-Cave is an OBR and Karaf features repository server.
+provides an OSGi Bundle Repository (OBR) and Karaf
+Features Repository (KFR).
 
-TODO
+OBR provides a service that can automatically install a bundle, with its deployment dependencies, from a bundle
+repository.
+
+Apache Karaf Cave provides the following features:
+
+- Storage: Karaf Cave provides a filesystem storage. The storage backend is designed with a kind of plugin system, it means that we can change the default filesystem storage by another kind of storage
+- OBR metadata generation: Karaf Cave automatically creates the OBR metadata for you, using the artifacts presents in the Cave repository.
+- OBR registration: Karaf Cave allows you to directly register a Cave repository into the OBR RepositoryAdmin OSGi service.
+- Artifact upload: you can update any OSGi bundle in a Cave repository, using advanced URL, e.g.  mvn:groupId/artifactId/version
+- "External" repository proxy: you can proxy an existing repository (like a Maven one) into a Cave repository. In that case, the artifacts are still resident on the proxied repository, Cave handles the OBR metadata. Cave supports file: and http: like URL, it means that Cave is able to browse a remote HTTP Maven repository.
+- "External" repository population: you can populate your local Cave repository from an external repository.  It means that Cave browse the external repository URL (file: or http:), looking for OSGi bundles in the artifacts, and copy the bundles in the Cave repository storage.
 
 h2. Quick Start
 

Added: karaf/site/trunk/src/main/webapp/index/subprojects/cave/building.page
URL: http://svn.apache.org/viewvc/karaf/site/trunk/src/main/webapp/index/subprojects/cave/building.page?rev=1226678&view=auto
==============================================================================
--- karaf/site/trunk/src/main/webapp/index/subprojects/cave/building.page (added)
+++ karaf/site/trunk/src/main/webapp/index/subprojects/cave/building.page Tue Jan  3 07:04:41 2012
@@ -0,0 +1,64 @@
+---
+title: Building
+page_version: 1
+page_creator: jbonofre
+page_modifier: jbonofre
+--- pipeline:conf
+h2. Building 
+
+Karaf Cave uses [Maven|http://maven.apache.org/] as its build tool.
+
+h3. Prequisites
+
+*Required:*
+* Download and [install Maven 3.0.x|http://maven.apache.org/download.html]
+* Get the latest [Source|/subproject/cave/source.html] 
+* Java 1.r65
+
+h3. A normal build
+
+{code}
+mvn install
+{code}
+
+h3. Doing a Quick Build
+
+The following avoids running all the unit test cases, we just skip the test running phase and not the building part
+{code}
+mvn -Dmaven.test.skip=true clean install
+{code}
+
+or
+
+{code}
+mvn -DskipTests clean install 
+{code}
+
+h3. Using an IDE
+
+If you prefer to use an IDE then you can auto-generate the IDE's project files using maven plugins. e.g.
+
+{code}
+mvn eclipse:eclipse
+{code}
+
+or
+
+{code}
+mvn idea:idea
+{code} 
+
+h4. Importing into Eclipse
+
+If you have not already done so, you will need to make Eclipse aware of the Maven repository so that it can build everything. In the preferences, go to Java->Build Path->Classpath and define a new Classpath Variable named M2_REPO that points to your local Maven repository (i.e., {{~/.m2/repository}} on Unix and {{c:\Documents and Settings\<user>\.m2\repository}} on Windows).
+
+You can also get Maven to do this for you:
+{code}
+mvn eclipse:add-maven-repo -Declipse.workspace=/path/to/the/workspace/ 
+{code}
+
+h3. Building source jars
+If you want to build jar files with the source code, that for instance Eclipse can important so you can debug the Karaf code as well. Then you can run this command from the karaf root folder:
+{code}
+mvn clean source:jar install -Dtest=false
+{code}

Added: karaf/site/trunk/src/main/webapp/index/subprojects/cave/download.page
URL: http://svn.apache.org/viewvc/karaf/site/trunk/src/main/webapp/index/subprojects/cave/download.page?rev=1226678&view=auto
==============================================================================
--- karaf/site/trunk/src/main/webapp/index/subprojects/cave/download.page (added)
+++ karaf/site/trunk/src/main/webapp/index/subprojects/cave/download.page Tue Jan  3 07:04:41 2012
@@ -0,0 +1,27 @@
+---
+title: Cave Download
+page_version: 1
+page_creator: jbonofre
+page_modifier: jbonofre
+--- pipeline:conf
+h2. Latest Releases
+{section}
+
+{column:width=20%}
+{div:style=padding-right:20px;float:left;}
+!/images/karaf-box.png|width=256!
+{div}
+{column}
+
+{column:width=80%}
+{div:style=min-height:200px}
+
+Karaf Cave has not been released yet.
+
+h2. Keys
+The {{KEYS}} used to sign the release can be found [here|http://www.apache.org/dist/karaf/KEYS].
+
+h2. Snapshots
+If you want to give a try to the latest snapshots, they are available at the following location:
+  https://repository.apache.org/content/groups/snapshots-group/org/apache/karaf/cave
+

Added: karaf/site/trunk/src/main/webapp/index/subprojects/cave/source.page
URL: http://svn.apache.org/viewvc/karaf/site/trunk/src/main/webapp/index/subprojects/cave/source.page?rev=1226678&view=auto
==============================================================================
--- karaf/site/trunk/src/main/webapp/index/subprojects/cave/source.page (added)
+++ karaf/site/trunk/src/main/webapp/index/subprojects/cave/source.page Tue Jan  3 07:04:41 2012
@@ -0,0 +1,54 @@
+---
+title: Source
+page_version: 1
+page_creator: jbonofre
+page_modifier: jbonofre
+--- pipeline:conf
+h2. Web Browsing of SVN
+
+To browse  via the web use the ViewVC interface:
+
+{panel}
+http://svn.apache.org/viewvc/karaf/cave/trunk/
+{panel}
+
+Or to browse the source tree directly:
+
+{panel}
+https://svn.apache.org/repos/asf/karaf/cave/trunk/
+{panel}
+
+h2. Checking out from SVN
+
+{code}
+svn co https://svn.apache.org/repos/asf/karaf/cave/trunk cave
+{code}
+
+Only project developers can commit to the SVN tree via this method.  SSH must be installed on your client machine. Enter your site password when prompted.
+
+h3. SVN and Eclipse
+
+See [this article|http://www-128.ibm.com/developerworks/library/os-ecl-subversion/index.html] for getting started guides. Basically you need [subclipse|http://subclipse.tigris.org]
+
+h3. Branches
+
+We use the trunk for the next main release; then we use a branch for any bug fixes on the previous major release. You can look at all branches here
+
+https://svn.apache.org/repos/asf/karaf/cave/branches/
+
+h2. Using GIT-SVN
+
+A git-svn mirror is available.
+
+{code}
+PROJECT_NAME="karaf-cave"
+git clone git://git.apache.org/"$PROJECT_NAME"
+cd "$PROJECT_NAME"/.git; wget http://git.apache.org/authors.txt; cd ..
+git config svn.authorsfile ".git/authors.txt"
+git svn init --prefix=origin/ --tags=tags --trunk=trunk --branches=branches https://svn.apache.org/repos/asf/"$PROJECT_NAME"
+git svn rebase
+{code}
+
+h2. Building the code
+
+To then build the code see [Building|/index/subprojects/cave/building.html].

Modified: karaf/site/trunk/src/main/webapp/site/navigation.page
URL: http://svn.apache.org/viewvc/karaf/site/trunk/src/main/webapp/site/navigation.page?rev=1226678&r1=1226677&r2=1226678&view=diff
==============================================================================
--- karaf/site/trunk/src/main/webapp/site/navigation.page (original)
+++ karaf/site/trunk/src/main/webapp/site/navigation.page Tue Jan  3 07:04:41 2012
@@ -51,6 +51,11 @@ h3. [Developers]
 
 h3. [Subprojects]
 
+- [Cave]
+-- [Download|/index/subprojects/cave/download.html]
+-- [Source|/index/subprojects/cave/source.html]
+-- [Building|/index/subprojects/cave/building.html]
+
 - [Cellar]
 -- [Download|/index/subprojects/cellar/download.html]
 -- [Source|/index/subprojects/cellar/source.html]