Repository: karaf-cave Updated Branches: refs/heads/master 73e712711 -> a33337b8d
Use article for documentation Project: http://git-wip-us.apache.org/repos/asf/karaf-cave/repo Commit: http://git-wip-us.apache.org/repos/asf/karaf-cave/commit/a33337b8 Tree: http://git-wip-us.apache.org/repos/asf/karaf-cave/tree/a33337b8 Diff: http://git-wip-us.apache.org/repos/asf/karaf-cave/diff/a33337b8 Branch: refs/heads/master Commit: a33337b8d67c6a901d1d7b0189ed63b8707a8e40 Parents: 73e7127 Author: Jean-Baptiste Onofré <[email protected]> Authored: Mon Jan 4 17:08:14 2016 +0100 Committer: Jean-Baptiste Onofré <[email protected]> Committed: Mon Jan 4 17:08:14 2016 +0100 ---------------------------------------------------------------------- manual/pom.xml | 4 +-- manual/src/main/asciidoc/index.adoc | 4 +-- manual/src/main/asciidoc/overview.adoc | 2 +- .../asciidoc/user-guide/administrate-cave.adoc | 11 +++--- .../asciidoc/user-guide/cave-repository.adoc | 11 +++--- .../main/asciidoc/user-guide/http-wrapper.adoc | 9 +++-- .../main/asciidoc/user-guide/installation.adoc | 8 ++--- .../main/asciidoc/user-guide/maven-wrapper.adoc | 7 ++-- .../user-guide/populate-repository.adoc | 6 ++-- .../asciidoc/user-guide/proxy-repository.adoc | 12 +++++-- .../main/asciidoc/user-guide/user-index.adoc | 35 -------------------- 11 files changed, 46 insertions(+), 63 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/karaf-cave/blob/a33337b8/manual/pom.xml ---------------------------------------------------------------------- diff --git a/manual/pom.xml b/manual/pom.xml index 7dae498..37dbfbb 100644 --- a/manual/pom.xml +++ b/manual/pom.xml @@ -49,10 +49,10 @@ <configuration> <sourceHighlighter>coderay</sourceHighlighter> <backend>html5</backend> + <doctype>article</doctype> <attributes> <toc/> <linkcss>false</linkcss> - <doctype>book</doctype> </attributes> </configuration> </execution> @@ -60,7 +60,7 @@ <configuration> <sourceDirectory>src/main/asciidoc</sourceDirectory> <headerFooter>true</headerFooter> - <imagesDir>../resources/images</imagesDir> + <imagesDir>src/main/asciidoc/images</imagesDir> </configuration> </plugin> <plugin> http://git-wip-us.apache.org/repos/asf/karaf-cave/blob/a33337b8/manual/src/main/asciidoc/index.adoc ---------------------------------------------------------------------- diff --git a/manual/src/main/asciidoc/index.adoc b/manual/src/main/asciidoc/index.adoc index f83532b..c78f2d2 100644 --- a/manual/src/main/asciidoc/index.adoc +++ b/manual/src/main/asciidoc/index.adoc @@ -15,7 +15,7 @@ Apache Karaf Cave 4.x - Documentation ====================================== Apache Software Foundation -:doctype: book +:doctype: article :toc: left :toclevels: 3 :toc-position: left @@ -24,7 +24,7 @@ Apache Software Foundation include::overview.adoc[] -= User Guide +== User Guide include::user-guide/installation.adoc[] http://git-wip-us.apache.org/repos/asf/karaf-cave/blob/a33337b8/manual/src/main/asciidoc/overview.adoc ---------------------------------------------------------------------- diff --git a/manual/src/main/asciidoc/overview.adoc b/manual/src/main/asciidoc/overview.adoc index 957d7e7..a974c7f 100644 --- a/manual/src/main/asciidoc/overview.adoc +++ b/manual/src/main/asciidoc/overview.adoc @@ -12,7 +12,7 @@ // limitations under the License. // -= Overview +== Overview Apache Karaf Cave is an Apache Karaf sub-project. http://git-wip-us.apache.org/repos/asf/karaf-cave/blob/a33337b8/manual/src/main/asciidoc/user-guide/administrate-cave.adoc ---------------------------------------------------------------------- diff --git a/manual/src/main/asciidoc/user-guide/administrate-cave.adoc b/manual/src/main/asciidoc/user-guide/administrate-cave.adoc index 6e5eb8d..cf32283 100644 --- a/manual/src/main/asciidoc/user-guide/administrate-cave.adoc +++ b/manual/src/main/asciidoc/user-guide/administrate-cave.adoc @@ -12,9 +12,9 @@ // limitations under the License. // -== Administration +=== Administration -=== JMX +==== JMX When you install Apache Karaf Cave server, it provides a CaveServerMBean. @@ -35,7 +35,7 @@ Thanks to this MBean, using any JMX client (like jconsole for instance), you can * void updateRepository(String name) throws Exception; * void uploadArtifact(String repository, String artifactUrl, boolean generate) throws Exception; -=== REST +==== REST Cave provides a complete REST API to manipulate the repositories. @@ -45,7 +45,10 @@ The API is available on: http://localhost:8181/cave/rest ---- -NB: 8181 is the default port of the Apache Karaf HTTP service. +[NOTE] +==== +8181 is the default port of the Apache Karaf HTTP service. +==== You can get the WADL: http://git-wip-us.apache.org/repos/asf/karaf-cave/blob/a33337b8/manual/src/main/asciidoc/user-guide/cave-repository.adoc ---------------------------------------------------------------------- diff --git a/manual/src/main/asciidoc/user-guide/cave-repository.adoc b/manual/src/main/asciidoc/user-guide/cave-repository.adoc index 12f242e..0819b16 100644 --- a/manual/src/main/asciidoc/user-guide/cave-repository.adoc +++ b/manual/src/main/asciidoc/user-guide/cave-repository.adoc @@ -12,7 +12,7 @@ // limitations under the License. // -== Repository +=== Repository A Cave repository is a container for: @@ -51,7 +51,7 @@ cave.storage.location=cave For instance, you can define `/var/cave/store` for the `storage.location` property. -=== Create +==== Create The `cave:repository-create` command creates a new repository: @@ -84,10 +84,13 @@ option to avoid this step: karaf@root()> cave:repository-create -ns -l /home/user/m2/repository m2 ---- -NB: the `-no` and `-ni` options are interesting when you use an existing location for the repository. If you create a +[NOTE] +==== +The `-no` and `-ni` options are interesting when you use an existing location for the repository. If you create a new empty repository, these options don't have really any effect. +==== -=== List +==== List You can list the repositories: http://git-wip-us.apache.org/repos/asf/karaf-cave/blob/a33337b8/manual/src/main/asciidoc/user-guide/http-wrapper.adoc ---------------------------------------------------------------------- diff --git a/manual/src/main/asciidoc/user-guide/http-wrapper.adoc b/manual/src/main/asciidoc/user-guide/http-wrapper.adoc index a708c96..ac64051 100644 --- a/manual/src/main/asciidoc/user-guide/http-wrapper.adoc +++ b/manual/src/main/asciidoc/user-guide/http-wrapper.adoc @@ -12,13 +12,13 @@ // limitations under the License. // -== HTTP wrapper service +=== HTTP wrapper service When you install the Apache Karaf Cave Server, it starts a HTTP service wrapper. It means that all artifacts and repository metadata presents in local repositories are exposed over HTTP. -=== Repository metadata access +==== Repository metadata access Assuming that you have the following repositories: @@ -35,7 +35,10 @@ You can access the repository metadata using the following URL in your favorite http://localhost:8181/cave/http/my-repository-repository.xml ---- -NB: the port 8181 is the default one of the Apache Karaf HTTP service. +[NOTE] +==== +The port 8181 is the default one of the Apache Karaf HTTP service. +==== You can see that the URL follows the format: http://git-wip-us.apache.org/repos/asf/karaf-cave/blob/a33337b8/manual/src/main/asciidoc/user-guide/installation.adoc ---------------------------------------------------------------------- diff --git a/manual/src/main/asciidoc/user-guide/installation.adoc b/manual/src/main/asciidoc/user-guide/installation.adoc index 0f23e94..d74cd4d 100644 --- a/manual/src/main/asciidoc/user-guide/installation.adoc +++ b/manual/src/main/asciidoc/user-guide/installation.adoc @@ -12,11 +12,11 @@ // limitations under the License. // -== Installation +=== Installation This chapter describes how to install Apache Karaf Cave into an existing Apache Karaf instance. -=== Pre-installation requirements +==== Pre-installation requirements As Apache Karaf Cave is a Apache Karaf sub-project, it has to be installed into a running Apache Karaf instance. @@ -25,7 +25,7 @@ connection from the Apache Karaf running instance. Apache Karaf Cave 4.0.x is designed to work on Apache Karaf 4.0.x. -=== Registration of the Apache Karaf Cave features +==== Registration of the Apache Karaf Cave features Simply register the Apache Karaf Cave features URL in your Apache Karaf instance: @@ -45,7 +45,7 @@ cave-rest | 4.0.0 | | Uninstall cave-maven | 4.0.0 | | Uninstalled | karaf-cave-4.0.0 | ---- -=== Starting Apache Karaf Cave Server +==== Starting Apache Karaf Cave Server The Apache Karaf Cave Server is installed by the 'cave-server' feature: http://git-wip-us.apache.org/repos/asf/karaf-cave/blob/a33337b8/manual/src/main/asciidoc/user-guide/maven-wrapper.adoc ---------------------------------------------------------------------- diff --git a/manual/src/main/asciidoc/user-guide/maven-wrapper.adoc b/manual/src/main/asciidoc/user-guide/maven-wrapper.adoc index 957b305..f062cbc 100644 --- a/manual/src/main/asciidoc/user-guide/maven-wrapper.adoc +++ b/manual/src/main/asciidoc/user-guide/maven-wrapper.adoc @@ -12,7 +12,7 @@ // limitations under the License. // -== Maven wrapper service +=== Maven wrapper service When you install the Apache Karaf Cave Server, it starts a Maven service wrapper. @@ -36,7 +36,10 @@ You can access the corresponding Maven repository using: http://localhost:8181/cave/maven ---- -NB: the port 8181 is the default one of the Apache Karaf HTTP service. +[NOTE] +==== +The port 8181 is the default one of the Apache Karaf HTTP service. +==== You can see that the URL follows the format: http://git-wip-us.apache.org/repos/asf/karaf-cave/blob/a33337b8/manual/src/main/asciidoc/user-guide/populate-repository.adoc ---------------------------------------------------------------------- diff --git a/manual/src/main/asciidoc/user-guide/populate-repository.adoc b/manual/src/main/asciidoc/user-guide/populate-repository.adoc index f097e82..67d42f7 100644 --- a/manual/src/main/asciidoc/user-guide/populate-repository.adoc +++ b/manual/src/main/asciidoc/user-guide/populate-repository.adoc @@ -12,11 +12,11 @@ // limitations under the License. // -== Populate repository +=== Populate repository You can add new artifacts in a repository. -=== Upload a single artifact +==== Upload a single artifact You can upload a single artifact into a Cave Repository: @@ -31,7 +31,7 @@ You can also use Maven style URL: karaf@root()> cave:repository-upload my-repository mvn:org.apache.servicemix.bundles/org.apache.servicemix.bundles.ant/1.7.0_5 ---- -=== Populate from an external repository +==== Populate from an external repository You can also make a kind of "bulk" population of your repository, using an external repository: http://git-wip-us.apache.org/repos/asf/karaf-cave/blob/a33337b8/manual/src/main/asciidoc/user-guide/proxy-repository.adoc ---------------------------------------------------------------------- diff --git a/manual/src/main/asciidoc/user-guide/proxy-repository.adoc b/manual/src/main/asciidoc/user-guide/proxy-repository.adoc index cbd4971..b55b713 100644 --- a/manual/src/main/asciidoc/user-guide/proxy-repository.adoc +++ b/manual/src/main/asciidoc/user-guide/proxy-repository.adoc @@ -12,7 +12,7 @@ // limitations under the License. // -== Proxy repository +=== Proxy repository As you can populate repository, you can also proxy an "external" repository. @@ -23,10 +23,16 @@ for the remote artifacts: karaf@root()> cave:repository-proxy my-repository http://repo1.maven.org/maven2/org/apache/servicemix/bundles/org.apache.servicemix.bundles.commons-lang/ ---- -NB: the Cave repository will only handle the repository metadata, it doesn't monitor the remote repository. It means that you +[NOTE] +==== +The Cave repository will only handle the repository metadata, it doesn't monitor the remote repository. It means that you have to call the `cave:proxy-repository` command each time the remote repository change (new artifacts, etc). +==== -NB: a best practice is to create a Cave repository dedicated for each proxied repository. +[NOTE] +==== +A best practice is to create a Cave repository dedicated for each proxied repository. +==== The `cave:repository-proxy` command accepts the filter option, as the `cave:repository-populate` command: http://git-wip-us.apache.org/repos/asf/karaf-cave/blob/a33337b8/manual/src/main/asciidoc/user-guide/user-index.adoc ---------------------------------------------------------------------- diff --git a/manual/src/main/asciidoc/user-guide/user-index.adoc b/manual/src/main/asciidoc/user-guide/user-index.adoc deleted file mode 100644 index 6a33329..0000000 --- a/manual/src/main/asciidoc/user-guide/user-index.adoc +++ /dev/null @@ -1,35 +0,0 @@ -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. -// - -Apache Karaf Cave 4.x - User Guide -================================== -:toc: left -:toclevels: 3 -:toc-position: left -:toc-title: Apache Karaf Cave 4.x - User Guide -:numbered: - -include::user-guide/installation.adoc[] - -include::user-guide/cave-repository.adoc[] - -include::user-guide/populate-repository.adoc[] - -include::user-guide/proxy-repository.adoc[] - -include::user-guide/http-wrapper.adoc[] - -include::user-guide/maven-wrapper.adoc[] - -include::user-guide/administrate-cave.adoc[]
