You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@camel.apache.org by dj...@apache.org on 2021/10/22 17:19:39 UTC
[camel-k] branch main updated: fix refs to camel-quarkus docs to
point to latest released version
This is an automated email from the ASF dual-hosted git repository.
djencks pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/camel-k.git
The following commit(s) were added to refs/heads/main by this push:
new c905cc1 fix refs to camel-quarkus docs to point to latest released version
c905cc1 is described below
commit c905cc11c23a53afa29e070211270bbe203e0ce4
Author: David Jencks <dj...@apache.org>
AuthorDate: Mon Oct 18 13:18:41 2021 -0700
fix refs to camel-quarkus docs to point to latest released version
---
docs/modules/ROOT/pages/architecture/runtime.adoc | 2 +-
docs/modules/ROOT/pages/kamelets/kamelets-dev.adoc | 10 +++++-----
.../ROOT/pages/observability/monitoring/integration.adoc | 6 +++---
docs/modules/ROOT/pages/troubleshooting/debugging.adoc | 2 +-
docs/modules/traits/pages/quarkus.adoc | 2 +-
5 files changed, 11 insertions(+), 11 deletions(-)
diff --git a/docs/modules/ROOT/pages/architecture/runtime.adoc b/docs/modules/ROOT/pages/architecture/runtime.adoc
index 3b975a1..133d952 100644
--- a/docs/modules/ROOT/pages/architecture/runtime.adoc
+++ b/docs/modules/ROOT/pages/architecture/runtime.adoc
@@ -14,7 +14,7 @@ https://github.com/apache/camel-k-runtime[Camel K runtime] is a java application
Camel Quarkus is an Apache Camel subproject that will make your Camel Integration run with the technology offered by https://quarkus.io/[Quarkus] project. Thanks to it, you will be able to reduce resource footprint and have a faster startup, which is a fundamental aspect of cloud native development.
-Learn more in the xref:latest@camel-quarkus::index.adoc[Camel Quarkus documentation section].
+Learn more in the xref:camel-quarkus::index.adoc[Camel Quarkus documentation section].
[[runtime-duties]]
== Runtime main duties
diff --git a/docs/modules/ROOT/pages/kamelets/kamelets-dev.adoc b/docs/modules/ROOT/pages/kamelets/kamelets-dev.adoc
index d70e31f..688c66c 100644
--- a/docs/modules/ROOT/pages/kamelets/kamelets-dev.adoc
+++ b/docs/modules/ROOT/pages/kamelets/kamelets-dev.adoc
@@ -5,7 +5,7 @@
== Introduction
This document guides you through the process of developing a new Kamelet that can be used by any Apache Camel subproject supporting the
-Kamelet technology stack and shared with others via Kamelet catalogs, such as the official the Apache Camel xref:latest@camel-kamelets::index.adoc[Kamelet Catalog].
+Kamelet technology stack and shared with others via Kamelet catalogs, such as the official the Apache Camel xref:camel-kamelets::index.adoc[Kamelet Catalog].
We assume that the reader is familiar with the content of the xref:kamelets/kamelets-user.adoc[Kamelets User Guide] and with
Camel K xref:installation/installation.adoc[installation] and general usage.
@@ -111,7 +111,7 @@ spec:
json: {}
- to: "kamelet:sink" # <5>
----
-<1> `keywords` is a path parameter in xref:latest@components::twitter-search-component.adoc[Camel Twitter-search]
+<1> `keywords` is a path parameter in xref:components::twitter-search-component.adoc[Camel Twitter-search]
<2> Some endpoint parameters are just mapped 1-1
<3> The Camel component `consumerKey` is named `apiKey` to reflect the actual name in the Twitter developer portal
<4> The Camel Twitter component generates Java objects, so we marshal them to JSON
@@ -458,7 +458,7 @@ Since the integration above produces useful data, its route could be technically
as much as possible. We can think to store the time when the last update has been generated by the server and use it in subsequent queries to only obtain new events.
This will not guarantee an "exactly once" semantics, because e.g. if the integration is restarted it will lose the in-memory state and start from the beginning,
but it prevents sending an high amount of redundant data if the integration is kept alive.
-To store the time when last result has been generated by the API, we can use one of the in-memory caches that Camel provides, such as xref:latest@components::caffeine-cache-component.adoc[camel-caffeine-cache].
+To store the time when last result has been generated by the API, we can use one of the in-memory caches that Camel provides, such as xref:components::caffeine-cache-component.adoc[camel-caffeine-cache].
WARNING: We're going to use an in-memory cache because we need to store a single value. When using stateful data repositories, such as caches, it's always a good practice to limit their size to a low value and avoid them to increase their size over time
@@ -512,7 +512,7 @@ public class Earthquake extends RouteBuilder {
<5> We put the current body in the claim check stack to use it for storing the "lastUpdate" field in the cache, then we restore the previous body
<6> Individual records of the response are sent to the destination (which is "log:info" in this phase). In case an exception is thrown while processing a single entry, individual errors are sent to the route error handler and the processing continues
-TIP: Don't be scared from the complexity of the route, as this is a complicated example by choice: most of the Kamelets in the xref:latest@camel-kamelets::index.adoc[Kamelet Catalog] don't use any processing logic or EIP
+TIP: Don't be scared from the complexity of the route, as this is a complicated example by choice: most of the Kamelets in the xref:camel-kamelets::index.adoc[Kamelet Catalog] don't use any processing logic or EIP
WARNING: When writing a route like this, you should always think to errors that might happen in various phases of the execution: here the "lastUpdate" value in the cache is updated after a
successful invocation of the API but before the individual exchanges are sent to the destination, so that the source is protected by individual errors on the features (that are sent to the route error handler),
@@ -939,7 +939,7 @@ In order to implement sending different kinds of data, the Kamelet should adapt
We'll start by writing an end-to-end integration, then we'll convert it into a Kamelet. This time, we'll write routes directly in YAML DSL.
-TIP: For this particular use case, I've created a simple integration before to get the Chat ID corresponding to my phone from the bot: more info xref:latest@components::telegram-component.adoc[here].
+TIP: For this particular use case, I've created a simple integration before to get the Chat ID corresponding to my phone from the bot: more info xref:components::telegram-component.adoc[here].
Let's start with a simple integration:
diff --git a/docs/modules/ROOT/pages/observability/monitoring/integration.adoc b/docs/modules/ROOT/pages/observability/monitoring/integration.adoc
index 4feb4fc..cd8ba0d 100644
--- a/docs/modules/ROOT/pages/observability/monitoring/integration.adoc
+++ b/docs/modules/ROOT/pages/observability/monitoring/integration.adoc
@@ -38,17 +38,17 @@ spec:
----
<1> Actives the Prometheus trait at the platform level
-The xref:2.0.0@camel-quarkus::reference/extensions/microprofile-metrics.adoc[Camel Quarkus MicroProfile Metrics extension] is responsible for collecting and exposing metrics in the https://github.com/OpenObservability/OpenMetrics[OpenMetrics] text format.
+The xref:camel-quarkus::reference/extensions/microprofile-metrics.adoc[Camel Quarkus MicroProfile Metrics extension] is responsible for collecting and exposing metrics in the https://github.com/OpenObservability/OpenMetrics[OpenMetrics] text format.
The MicroProfile Metrics extension registers and exposes the following metrics out-of-the-box:
* https://github.com/eclipse/microprofile-metrics/blob/master/spec/src/main/asciidoc/required-metrics.adoc#required-metrics[JVM and operating system related metrics]
-* xref:2.0.0@camel-quarkus::reference/extensions/microprofile-metrics.adoc#_camel_route_metrics[Camel specific metrics]
+* xref:camel-quarkus::reference/extensions/microprofile-metrics.adoc#_camel_route_metrics[Camel specific metrics]
It is possible to extend this set of metrics by using either, or both:
-* The xref:latest@components::microprofile-metrics-component.adoc[MicroProfile Metrics component]
+* The xref:components::microprofile-metrics-component.adoc[MicroProfile Metrics component]
* The https://github.com/eclipse/microprofile-metrics/blob/master/spec/src/main/asciidoc/app-programming-model.adoc#annotations[MicroProfile Metrics annotations], in external dependencies
diff --git a/docs/modules/ROOT/pages/troubleshooting/debugging.adoc b/docs/modules/ROOT/pages/troubleshooting/debugging.adoc
index 981d6f9..1ff6903 100644
--- a/docs/modules/ROOT/pages/troubleshooting/debugging.adoc
+++ b/docs/modules/ROOT/pages/troubleshooting/debugging.adoc
@@ -59,6 +59,6 @@ When the debugging session is done, hitting kbd:[Ctrl+c] on the terminal where t
As we've seen in the previous section, all `Integration` created in Camel K are finally bundled as a Java application, hence, the possibility to debug via JVM debugger. Any `Kamelet` you will be using directly in your `Route` definition or in a `KameletBinding` is automatically converted in a `yaml` route and injected in the Camel Context to be executed. That means that you cannot directly debug a `Kamelet` as you would do with a Java or any other JVM language `Route`.
-However, you can troubleshoot individually each `Kamelet` definition by focusing on the specification xref:kamelets/kamelets-user.adoc#_flow[`Flow`]. As an example, you can create a simple xref:camel-k:languages:yaml.adoc[`yaml`] test `Route` substituting the `kamelet:source` or `kamelet:sink` with any mock endpoint that can help you debugging the single `Kamelet` flow. Even using a `timer` and a `log` component may be enough for a basic check.
+However, you can troubleshoot individually each `Kamelet` definition by focusing on the specification xref:kamelets/kamelets-user.adoc#_flow[`Flow`]. As an example, you can create a simple xref:languages:yaml.adoc[`yaml`] test `Route` substituting the `kamelet:source` or `kamelet:sink` with any mock endpoint that can help you debugging the single `Kamelet` flow. Even using a `timer` and a `log` component may be enough for a basic check.
NOTE: the same idea applies for a `KameletBinding` which translates to an `Integration` type under the hood. If you need to debug a `KameletBinding` just apply the same troubleshooting technique you would apply on an `Integration`.
diff --git a/docs/modules/traits/pages/quarkus.adoc b/docs/modules/traits/pages/quarkus.adoc
index 78e9f72..0ddf3ef 100755
--- a/docs/modules/traits/pages/quarkus.adoc
+++ b/docs/modules/traits/pages/quarkus.adoc
@@ -50,7 +50,7 @@ integration in case no existing kit that matches the integration exists.
== Supported Camel Components
-Camel K only supports the Camel components that are available as Camel Quarkus Extensions out-of-the-box. These extensions are listed in the xref:2.0.0@camel-quarkus::reference/index.adoc[Camel Quarkus documentation].
+Camel K only supports the Camel components that are available as Camel Quarkus Extensions out-of-the-box. These extensions are listed in the xref:camel-quarkus::reference/index.adoc[Camel Quarkus documentation].
== Examples