You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@camel.apache.org by al...@apache.org on 2022/09/30 07:27:46 UTC
[camel-quarkus] branch main updated: doc: switch to === syntax to match doc tooling
This is an automated email from the ASF dual-hosted git repository.
aldettinger pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/camel-quarkus.git
The following commit(s) were added to refs/heads/main by this push:
new 1a6e98e28b doc: switch to === syntax to match doc tooling
1a6e98e28b is described below
commit 1a6e98e28b757e64a2d66073dc75c52eb8a18a6b
Author: aldettinger <al...@gmail.com>
AuthorDate: Fri Sep 30 09:12:31 2022 +0200
doc: switch to === syntax to match doc tooling
---
docs/modules/ROOT/pages/reference/extensions/jfr.adoc | 6 ++++--
docs/modules/ROOT/pages/reference/extensions/rest.adoc | 6 ++++--
extensions/jfr/runtime/src/main/doc/usage.adoc | 4 ++--
extensions/rest/runtime/src/main/doc/configuration.adoc | 4 ++--
4 files changed, 12 insertions(+), 8 deletions(-)
diff --git a/docs/modules/ROOT/pages/reference/extensions/jfr.adoc b/docs/modules/ROOT/pages/reference/extensions/jfr.adoc
index c76273bc4e..5db2004bee 100644
--- a/docs/modules/ROOT/pages/reference/extensions/jfr.adoc
+++ b/docs/modules/ROOT/pages/reference/extensions/jfr.adoc
@@ -46,7 +46,8 @@ endif::[]
[id="extensions-jfr-usage"]
== Usage
-### Starting flight recording
+[id="extensions-jfr-usage-starting-flight-recording"]
+=== Starting flight recording
To enable Java Flight Recorder to start a recording and automatically dump the recording to disk after Camel startup is complete, use the following configuration in `application.properties`.
@@ -71,7 +72,8 @@ In native mode, the native executable can be executed as follows.
$ ./my-application-runner -XX:+FlightRecorder -XX:StartFlightRecording=filename=recording.jfr
----
-### Flight recording in native mode
+[id="extensions-jfr-usage-flight-recording-in-native-mode"]
+=== Flight recording in native mode
To build a native image with Java Flight Recorder support, it is mandatory to enable VM inspection via the following configuration property in `application.properties`.
diff --git a/docs/modules/ROOT/pages/reference/extensions/rest.adoc b/docs/modules/ROOT/pages/reference/extensions/rest.adoc
index 1e622974ae..a7b0fa99fd 100644
--- a/docs/modules/ROOT/pages/reference/extensions/rest.adoc
+++ b/docs/modules/ROOT/pages/reference/extensions/rest.adoc
@@ -52,7 +52,8 @@ endif::[]
This extension depends on the xref:reference/extensions/platform-http.adoc[Platform HTTP] extension
and configures it as the component that provides the REST transport.
-### Path parameters containing special characters with platform-http
+[id="extensions-rest-configuration-path-parameters-containing-special-characters-with-platform-http"]
+=== Path parameters containing special characters with platform-http
When using the `platform-http` REST transport, some characters are not allowed within path parameter names. This includes the '-' and '$' characters.
@@ -83,7 +84,8 @@ public class CamelRoute extends RouteBuilder {
There is some more background to this in the https://vertx.io/docs/vertx-web/java/#_capturing_path_parameters[Vert.x Web documentation].
-### Configuring alternate REST transport providers
+[id="extensions-rest-configuration-configuring-alternate-rest-transport-providers"]
+=== Configuring alternate REST transport providers
To use another REST transport provider, such as `netty-http` or `servlet`, you need to add the respective
extension as a dependency to your project and set the provider in your `RouteBuilder`. E.g. for `servlet`, you'd
diff --git a/extensions/jfr/runtime/src/main/doc/usage.adoc b/extensions/jfr/runtime/src/main/doc/usage.adoc
index d4e75f8f44..c3f002806b 100644
--- a/extensions/jfr/runtime/src/main/doc/usage.adoc
+++ b/extensions/jfr/runtime/src/main/doc/usage.adoc
@@ -1,4 +1,4 @@
-### Starting flight recording
+=== Starting flight recording
To enable Java Flight Recorder to start a recording and automatically dump the recording to disk after Camel startup is complete, use the following configuration in `application.properties`.
@@ -23,7 +23,7 @@ In native mode, the native executable can be executed as follows.
$ ./my-application-runner -XX:+FlightRecorder -XX:StartFlightRecording=filename=recording.jfr
----
-### Flight recording in native mode
+=== Flight recording in native mode
To build a native image with Java Flight Recorder support, it is mandatory to enable VM inspection via the following configuration property in `application.properties`.
diff --git a/extensions/rest/runtime/src/main/doc/configuration.adoc b/extensions/rest/runtime/src/main/doc/configuration.adoc
index 9db88977f4..b22f756367 100644
--- a/extensions/rest/runtime/src/main/doc/configuration.adoc
+++ b/extensions/rest/runtime/src/main/doc/configuration.adoc
@@ -1,7 +1,7 @@
This extension depends on the xref:reference/extensions/platform-http.adoc[Platform HTTP] extension
and configures it as the component that provides the REST transport.
-### Path parameters containing special characters with platform-http
+=== Path parameters containing special characters with platform-http
When using the `platform-http` REST transport, some characters are not allowed within path parameter names. This includes the '-' and '$' characters.
@@ -32,7 +32,7 @@ public class CamelRoute extends RouteBuilder {
There is some more background to this in the https://vertx.io/docs/vertx-web/java/#_capturing_path_parameters[Vert.x Web documentation].
-### Configuring alternate REST transport providers
+=== Configuring alternate REST transport providers
To use another REST transport provider, such as `netty-http` or `servlet`, you need to add the respective
extension as a dependency to your project and set the provider in your `RouteBuilder`. E.g. for `servlet`, you'd