You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@karaf.apache.org by jb...@apache.org on 2019/11/25 05:20:08 UTC
[karaf] branch karaf-4.2.x updated: [KARAF-6516] Fix examples
location
This is an automated email from the ASF dual-hosted git repository.
jbonofre pushed a commit to branch karaf-4.2.x
in repository https://gitbox.apache.org/repos/asf/karaf.git
The following commit(s) were added to refs/heads/karaf-4.2.x by this push:
new a98d752 [KARAF-6516] Fix examples location
a98d752 is described below
commit a98d752fee5800baa0175d85cda2cab951106654
Author: Jean-Baptiste Onofré <jb...@apache.org>
AuthorDate: Mon Nov 25 06:19:22 2019 +0100
[KARAF-6516] Fix examples location
---
.../main/asciidoc/developer-guide/branding.adoc | 2 +-
.../asciidoc/developer-guide/creating-bundles.adoc | 6 +-
.../developer-guide/custom-distribution.adoc | 2 +-
.../main/asciidoc/developer-guide/extending.adoc | 2 +-
.../developer-guide/karaf-maven-plugin.adoc | 2 +-
.../asciidoc/developer-guide/writing-tests.adoc | 17 -----
manual/src/main/asciidoc/index.adoc | 88 +++++++++++++++-------
7 files changed, 66 insertions(+), 53 deletions(-)
diff --git a/manual/src/main/asciidoc/developer-guide/branding.adoc b/manual/src/main/asciidoc/developer-guide/branding.adoc
index b89056f..02eeefe 100644
--- a/manual/src/main/asciidoc/developer-guide/branding.adoc
+++ b/manual/src/main/asciidoc/developer-guide/branding.adoc
@@ -60,7 +60,7 @@ The values default to the ones in `etc/branding.properties` if this file is not
==== Branding bundle
-See [https://github.com/apache/karaf/tree/master/examples/karaf-branding-example].
+See https://github.com/apache/karaf/blob/master/examples/karaf-branding-example/README.md
==== WebConsole
diff --git a/manual/src/main/asciidoc/developer-guide/creating-bundles.adoc b/manual/src/main/asciidoc/developer-guide/creating-bundles.adoc
index 33bf543..4edf7b4 100644
--- a/manual/src/main/asciidoc/developer-guide/creating-bundles.adoc
+++ b/manual/src/main/asciidoc/developer-guide/creating-bundles.adoc
@@ -16,9 +16,9 @@
The examples provides different kind of bundles and services definition:
-* [https://github.com/apache/karaf/tree/master/examples/karaf-bundle-example]
-* [https://github.com/apache/karaf/tree/master/examples/karaf-blueprint-example]
-* [https://github.com/apache/karaf/tree/master/examples/karaf-scr-example]
+* https://github.com/apache/karaf/blob/master/examples/karaf-bundle-example/README.md
+* https://github.com/apache/karaf/blob/master/examples/karaf-blueprint-example/README.md
+* https://github.com/apache/karaf/blob/master/examples/karaf-scr-example/README.md
==== Add extended information to bundles
diff --git a/manual/src/main/asciidoc/developer-guide/custom-distribution.adoc b/manual/src/main/asciidoc/developer-guide/custom-distribution.adoc
index efe6b9c..39247cd 100644
--- a/manual/src/main/asciidoc/developer-guide/custom-distribution.adoc
+++ b/manual/src/main/asciidoc/developer-guide/custom-distribution.adoc
@@ -27,7 +27,7 @@ This custom distribution could contain:
* renamed or specific scripts in the bin folder
* system documentation files
-See [example/karaf-maven-example/karaf-maven-example-assembly] for a custom distribution example.
+See https://github.com/apache/karaf/tree/master/examples/karaf-maven-example/karaf-maven-example-assembly for a custom distribution example.
==== Maven assembly
diff --git a/manual/src/main/asciidoc/developer-guide/extending.adoc b/manual/src/main/asciidoc/developer-guide/extending.adoc
index cf37aa6..75b3638 100644
--- a/manual/src/main/asciidoc/developer-guide/extending.adoc
+++ b/manual/src/main/asciidoc/developer-guide/extending.adoc
@@ -18,7 +18,7 @@ Apache Karaf is a very flexible container that you can extend very easily.
==== Shell commands
-See [examples/karaf-command-example] to add your own shell commands.
+See https://github.com/apache/karaf/blob/master/examples/karaf-command-example/README.md to add your own shell commands.
==== WebConsole
diff --git a/manual/src/main/asciidoc/developer-guide/karaf-maven-plugin.adoc b/manual/src/main/asciidoc/developer-guide/karaf-maven-plugin.adoc
index f47c9f7..479cd41 100644
--- a/manual/src/main/asciidoc/developer-guide/karaf-maven-plugin.adoc
+++ b/manual/src/main/asciidoc/developer-guide/karaf-maven-plugin.adoc
@@ -20,7 +20,7 @@ The Karaf Maven plugin allows you:
* to create Karaf commands help: it generates help from Karaf commands
* to modify Karaf instances and create distributions
-See [examples/karaf-maven-example] for details.
+See https://github.com/apache/karaf/blob/master/examples/karaf-maven-example/README.md for details.
==== Packaging
diff --git a/manual/src/main/asciidoc/developer-guide/writing-tests.adoc b/manual/src/main/asciidoc/developer-guide/writing-tests.adoc
deleted file mode 100644
index e0194cf..0000000
--- a/manual/src/main/asciidoc/developer-guide/writing-tests.adoc
+++ /dev/null
@@ -1,17 +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.
-//
-
-=== Writing integration tests
-
-See [examples/karaf-itest-example/README.md]
\ No newline at end of file
diff --git a/manual/src/main/asciidoc/index.adoc b/manual/src/main/asciidoc/index.adoc
index 889b6db..eb809e7 100644
--- a/manual/src/main/asciidoc/index.adoc
+++ b/manual/src/main/asciidoc/index.adoc
@@ -110,13 +110,13 @@ include::developer-guide/custom-distribution.adoc[]
include::developer-guide/creating-bundles.adoc[]
-==== Blueprint
+=== Blueprint
-See https://github.com/apache/karaf/tree/master/examples/karaf-blueprint-example/README.md
+See https://github.com/apache/karaf/blob/master/examples/karaf-blueprint-example/README.md
-==== SCR
+=== SCR
-See https://github.com/apache/karaf/tree/master/examples/karaf-scr-example/README.md
+See https://github.com/apache/karaf/tree/master/examples/karaf-scr-example
include::developer-guide/archetypes.adoc[]
@@ -124,56 +124,86 @@ include::developer-guide/security-framework.adoc[]
include::developer-guide/debugging.adoc[]
-include::developer-guide/writing-tests.adoc[]
+=== Configuration
+
+See https://github.com/apache/karaf/blob/master/examples/karaf-config-example/README.md
+
+=== Deployer
+
+See https://github.com/apache/karaf/blob/master/examples/karaf-deployer-example/README.md
=== Dump extender
-See https://github.com/apache/karaf/tree/master/examples/karaf-dump-example/README.md
+See https://github.com/apache/karaf/blob/master/examples/karaf-dump-example/README.md
+
+=== JDBC & JPA
+
+See https://github.com/apache/karaf/blob/master/examples/karaf-jdbc-example/README.md
+
+See https://github.com/apache/karaf/blob/master/examples/karaf-jpa-example/README.md
+
+=== JMS
+
+See https://github.com/apache/karaf/blob/master/examples/karaf-jms-example/README.md
+
+=== Custom log appender
+
+See https://github.com/apache/karaf/blob/master/examples/karaf-log-appender-example/README.md
+
+=== Custom JMX MBean
+
+See https://github.com/apache/karaf/blob/master/examples/karaf-mbean-example/README.md
+
+=== Working with profiles
+
+See https://github.com/apache/karaf/blob/master/examples/karaf-profile-example/README.md
+
+=== Security & JAAS
-==== JDBC & JPA
+See https://github.com/apache/karaf/blob/master/examples/karaf-jaas-example/README.md
-See https://github.com/apache/karaf/tree/master/examples/karaf-jdbc-example/README.md
+=== Servlet
-See https://github.com/apache/karaf/tree/master/examples/karaf-jpa-example/README.md
+See https://github.com/apache/karaf/blob/master/examples/karaf-servlet-example/README.md
-==== JMS
+=== WAR
-See https://github.com/apache/karaf/tree/master/examples/karaf-jms-example/README.md
+See https://github.com/apache/karaf/blob/master/examples/karaf-war-example/README.md
-==== Custom log appender
+=== HTTP Resources
-See https://github.com/apache/karaf/tree/master/examples/karaf-log-appender-example/README.md
+See https://github.com/apache/karaf/blob/master/examples/karaf-http-resource-example/README.md
-==== Custom JMX MBean
+=== REST service
-See https://github.com/apache/karaf/tree/master/examples/karaf-mbean-example/README.md
+See https://github.com/apache/karaf/blob/master/examples/karaf-rest-example/README.md
-==== Working with profiles
+=== SOAP service
-See https://github.com/apache/karaf/tree/master/examples/karaf-profile-example/README.md
+See https://github.com/apache/karaf/blob/master/examples/karaf-soap-example/README.md
-==== Servlet
+=== Websocket
-See https://github.com/apache/karaf/tree/master/examples/karaf-servlet-example/README.md
+See https://github.com/apache/karaf/blob/master/examples/karaf-websocket-example/README.md
-==== WAR
+=== Scheduler
-See https://github.com/apache/karaf/tree/master/examples/karaf-war-example/README.md
+See https://github.com/apache/karaf/blob/master/examples/karaf-scheduler-example/README.md
-==== REST service
+=== Quick example with Apache Camel
-See https://github.com/apache/karaf/tree/master/examples/karaf-rest-example/README.md
+See https://github.com/apache/karaf/blob/master/examples/karaf-camel-example/README.md
-==== SOAP service
+=== Custom URL handler
-See https://github.com/apache/karaf/tree/master/examples/karaf-soap-example/README.md
+See https://github.com/apache/karaf/blob/master/examples/karaf-url-namespace-handler-example/README.md
-==== Scheduling jobs
+=== Integration Tests
-See https://github.com/apache/karaf/tree/master/examples/karaf-scheduler-example/README.md
+See https://github.com/apache/karaf/blob/master/examples/karaf-itest-example/README.md
-==== Custom URL handler
+=== Distributions & Docker
-See https://github.com/apache/karaf/tree/master/examples/karaf-url-namespace-handler-example/README.md
+See https://github.com/apache/karaf/blob/master/examples/karaf-docker-example/README.md
include::developer-guide/github-contributions.adoc[]