Skip to content

Commit 168cc2a

Browse files
committed
Sync documentation of main branch
1 parent 9e16024 commit 168cc2a

11 files changed

+86
-14
lines changed

_generated-doc/main/config/quarkus-all-config.adoc

Lines changed: 23 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35139,7 +35139,7 @@ endif::add-copy-button-to-config-props[]
3513935139

3514035140
[.description]
3514135141
--
35142-
The topic-partition pairs to create in the Dev Services Kafka broker. After the broker is started, given topics with partitions are created, skipping already existing topics. For example, `quarkus.kafka.devservices.topic-partitions.test=2` will create a topic named `test` with 2 partitions.
35142+
The topic-partition pairs to create in the Dev Services Kafka broker. After the broker is started, given topics with partitions are created, skipping already existing topics. For example, `quarkus.kafka.devservices.topic-partitions.my-topic=2` will create a topic named `test` with 2 partitions.
3514335143

3514435144
The topic creation will not try to re-partition existing topics with different number of partitions.
3514535145

@@ -96604,7 +96604,7 @@ endif::add-copy-button-to-config-props[]
9660496604

9660596605
[.description]
9660696606
--
96607-
The maximum size of a frame in bytes. The default values is `io.vertx.core.http.HttpClientOptions++#++DEFAULT_MAX_WEBSOCKET_FRAME_SIZEX`.
96607+
The maximum size of a frame in bytes. The default values is `io.vertx.core.http.HttpClientOptions++#++DEFAULT_MAX_WEBSOCKET_FRAME_SIZE`.
9660896608

9660996609

9661096610
ifdef::add-copy-button-to-env-var[]
@@ -96661,6 +96661,27 @@ endif::add-copy-button-to-env-var[]
9666196661
|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]]
9666296662
|
9666396663

96664+
a| [[quarkus-websockets-next_quarkus-websockets-next-client-connection-closing-timeout]] [.property-path]##link:#quarkus-websockets-next_quarkus-websockets-next-client-connection-closing-timeout[`quarkus.websockets-next.client.connection-closing-timeout`]##
96665+
ifdef::add-copy-button-to-config-props[]
96666+
config_property_copy_button:+++quarkus.websockets-next.client.connection-closing-timeout+++[]
96667+
endif::add-copy-button-to-config-props[]
96668+
96669+
96670+
[.description]
96671+
--
96672+
The amount of time a client will wait until it closes the TCP connection after sending a close frame. Any value will be `Duration++#++toSeconds() converted to seconds` and limited to `Integer++#++MAX_VALUE`. The default value is `io.vertx.core.http.HttpClientOptions++#++DEFAULT_WEBSOCKET_CLOSING_TIMEOUT`s
96673+
96674+
96675+
ifdef::add-copy-button-to-env-var[]
96676+
Environment variable: env_var_with_copy_button:+++QUARKUS_WEBSOCKETS_NEXT_CLIENT_CONNECTION_CLOSING_TIMEOUT+++[]
96677+
endif::add-copy-button-to-env-var[]
96678+
ifndef::add-copy-button-to-env-var[]
96679+
Environment variable: `+++QUARKUS_WEBSOCKETS_NEXT_CLIENT_CONNECTION_CLOSING_TIMEOUT+++`
96680+
endif::add-copy-button-to-env-var[]
96681+
--
96682+
|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]]
96683+
|
96684+
9666496685
a| [[quarkus-websockets-next_quarkus-websockets-next-client-unhandled-failure-strategy]] [.property-path]##link:#quarkus-websockets-next_quarkus-websockets-next-client-unhandled-failure-strategy[`quarkus.websockets-next.client.unhandled-failure-strategy`]##
9666596686
ifdef::add-copy-button-to-config-props[]
9666696687
config_property_copy_button:+++quarkus.websockets-next.client.unhandled-failure-strategy+++[]

_generated-doc/main/config/quarkus-kafka-client.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -232,7 +232,7 @@ endif::add-copy-button-to-config-props[]
232232

233233
[.description]
234234
--
235-
The topic-partition pairs to create in the Dev Services Kafka broker. After the broker is started, given topics with partitions are created, skipping already existing topics. For example, `quarkus.kafka.devservices.topic-partitions.test=2` will create a topic named `test` with 2 partitions.
235+
The topic-partition pairs to create in the Dev Services Kafka broker. After the broker is started, given topics with partitions are created, skipping already existing topics. For example, `quarkus.kafka.devservices.topic-partitions.my-topic=2` will create a topic named `test` with 2 partitions.
236236

237237
The topic creation will not try to re-partition existing topics with different number of partitions.
238238

_generated-doc/main/config/quarkus-kafka-client_quarkus.kafka.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -232,7 +232,7 @@ endif::add-copy-button-to-config-props[]
232232

233233
[.description]
234234
--
235-
The topic-partition pairs to create in the Dev Services Kafka broker. After the broker is started, given topics with partitions are created, skipping already existing topics. For example, `quarkus.kafka.devservices.topic-partitions.test=2` will create a topic named `test` with 2 partitions.
235+
The topic-partition pairs to create in the Dev Services Kafka broker. After the broker is started, given topics with partitions are created, skipping already existing topics. For example, `quarkus.kafka.devservices.topic-partitions.my-topic=2` will create a topic named `test` with 2 partitions.
236236

237237
The topic creation will not try to re-partition existing topics with different number of partitions.
238238

_generated-doc/main/config/quarkus-kafka-client_quarkus.kafka.devservices.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -161,7 +161,7 @@ endif::add-copy-button-to-config-props[]
161161

162162
[.description]
163163
--
164-
The topic-partition pairs to create in the Dev Services Kafka broker. After the broker is started, given topics with partitions are created, skipping already existing topics. For example, `quarkus.kafka.devservices.topic-partitions.test=2` will create a topic named `test` with 2 partitions.
164+
The topic-partition pairs to create in the Dev Services Kafka broker. After the broker is started, given topics with partitions are created, skipping already existing topics. For example, `quarkus.kafka.devservices.topic-partitions.my-topic=2` will create a topic named `test` with 2 partitions.
165165

166166
The topic creation will not try to re-partition existing topics with different number of partitions.
167167

_generated-doc/main/config/quarkus-websockets-next.adoc

Lines changed: 22 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -422,7 +422,7 @@ endif::add-copy-button-to-config-props[]
422422

423423
[.description]
424424
--
425-
The maximum size of a frame in bytes. The default values is `io.vertx.core.http.HttpClientOptions++#++DEFAULT_MAX_WEBSOCKET_FRAME_SIZEX`.
425+
The maximum size of a frame in bytes. The default values is `io.vertx.core.http.HttpClientOptions++#++DEFAULT_MAX_WEBSOCKET_FRAME_SIZE`.
426426

427427

428428
ifdef::add-copy-button-to-env-var[]
@@ -479,6 +479,27 @@ endif::add-copy-button-to-env-var[]
479479
|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-websockets-next_quarkus-websockets-next[icon:question-circle[title=More information about the Duration format]]
480480
|
481481

482+
a| [[quarkus-websockets-next_quarkus-websockets-next-client-connection-closing-timeout]] [.property-path]##link:#quarkus-websockets-next_quarkus-websockets-next-client-connection-closing-timeout[`quarkus.websockets-next.client.connection-closing-timeout`]##
483+
ifdef::add-copy-button-to-config-props[]
484+
config_property_copy_button:+++quarkus.websockets-next.client.connection-closing-timeout+++[]
485+
endif::add-copy-button-to-config-props[]
486+
487+
488+
[.description]
489+
--
490+
The amount of time a client will wait until it closes the TCP connection after sending a close frame. Any value will be `Duration++#++toSeconds() converted to seconds` and limited to `Integer++#++MAX_VALUE`. The default value is `io.vertx.core.http.HttpClientOptions++#++DEFAULT_WEBSOCKET_CLOSING_TIMEOUT`s
491+
492+
493+
ifdef::add-copy-button-to-env-var[]
494+
Environment variable: env_var_with_copy_button:+++QUARKUS_WEBSOCKETS_NEXT_CLIENT_CONNECTION_CLOSING_TIMEOUT+++[]
495+
endif::add-copy-button-to-env-var[]
496+
ifndef::add-copy-button-to-env-var[]
497+
Environment variable: `+++QUARKUS_WEBSOCKETS_NEXT_CLIENT_CONNECTION_CLOSING_TIMEOUT+++`
498+
endif::add-copy-button-to-env-var[]
499+
--
500+
|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-websockets-next_quarkus-websockets-next[icon:question-circle[title=More information about the Duration format]]
501+
|
502+
482503
a| [[quarkus-websockets-next_quarkus-websockets-next-client-unhandled-failure-strategy]] [.property-path]##link:#quarkus-websockets-next_quarkus-websockets-next-client-unhandled-failure-strategy[`quarkus.websockets-next.client.unhandled-failure-strategy`]##
483504
ifdef::add-copy-button-to-config-props[]
484505
config_property_copy_button:+++quarkus.websockets-next.client.unhandled-failure-strategy+++[]

_generated-doc/main/config/quarkus-websockets-next_quarkus.websockets-next.adoc

Lines changed: 22 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -422,7 +422,7 @@ endif::add-copy-button-to-config-props[]
422422

423423
[.description]
424424
--
425-
The maximum size of a frame in bytes. The default values is `io.vertx.core.http.HttpClientOptions++#++DEFAULT_MAX_WEBSOCKET_FRAME_SIZEX`.
425+
The maximum size of a frame in bytes. The default values is `io.vertx.core.http.HttpClientOptions++#++DEFAULT_MAX_WEBSOCKET_FRAME_SIZE`.
426426

427427

428428
ifdef::add-copy-button-to-env-var[]
@@ -479,6 +479,27 @@ endif::add-copy-button-to-env-var[]
479479
|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-websockets-next_quarkus-websockets-next[icon:question-circle[title=More information about the Duration format]]
480480
|
481481

482+
a| [[quarkus-websockets-next_quarkus-websockets-next-client-connection-closing-timeout]] [.property-path]##link:#quarkus-websockets-next_quarkus-websockets-next-client-connection-closing-timeout[`quarkus.websockets-next.client.connection-closing-timeout`]##
483+
ifdef::add-copy-button-to-config-props[]
484+
config_property_copy_button:+++quarkus.websockets-next.client.connection-closing-timeout+++[]
485+
endif::add-copy-button-to-config-props[]
486+
487+
488+
[.description]
489+
--
490+
The amount of time a client will wait until it closes the TCP connection after sending a close frame. Any value will be `Duration++#++toSeconds() converted to seconds` and limited to `Integer++#++MAX_VALUE`. The default value is `io.vertx.core.http.HttpClientOptions++#++DEFAULT_WEBSOCKET_CLOSING_TIMEOUT`s
491+
492+
493+
ifdef::add-copy-button-to-env-var[]
494+
Environment variable: env_var_with_copy_button:+++QUARKUS_WEBSOCKETS_NEXT_CLIENT_CONNECTION_CLOSING_TIMEOUT+++[]
495+
endif::add-copy-button-to-env-var[]
496+
ifndef::add-copy-button-to-env-var[]
497+
Environment variable: `+++QUARKUS_WEBSOCKETS_NEXT_CLIENT_CONNECTION_CLOSING_TIMEOUT+++`
498+
endif::add-copy-button-to-env-var[]
499+
--
500+
|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-websockets-next_quarkus-websockets-next[icon:question-circle[title=More information about the Duration format]]
501+
|
502+
482503
a| [[quarkus-websockets-next_quarkus-websockets-next-client-unhandled-failure-strategy]] [.property-path]##link:#quarkus-websockets-next_quarkus-websockets-next-client-unhandled-failure-strategy[`quarkus.websockets-next.client.unhandled-failure-strategy`]##
483504
ifdef::add-copy-button-to-config-props[]
484505
config_property_copy_button:+++quarkus.websockets-next.client.unhandled-failure-strategy+++[]

_versions/main/guides/databases-dev-services.adoc

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -150,12 +150,14 @@ Dev Services volumes can be mapped to the filesystem or the classpath:
150150
# Using a filesystem volume:
151151
quarkus.datasource.devservices.volumes."/path/from"=/container/to <1>
152152
# Using a classpath volume:
153-
quarkus.datasource.devservices.volumes."classpath:./file"=/container/to <2>
153+
quarkus.datasource.devservices.volumes."classpath\:./file"=/container/to <2>
154154
----
155155

156156
<1> The file or folder "/path/from" from the local machine will be accessible at "/container/to" in the container.
157157
<2> When using classpath volumes, the location has to start with "classpath:". The file or folder "./file" from the project's classpath will be accessible at "/container/to" in the container.
158158

159+
CAUTION: The colon character `:` needs to be escaped in `.properties` files as `\:`, or it will be interpreted as a key/value separator.
160+
159161
IMPORTANT: when using a classpath volume, the container will only be granted read permission. On the other hand, when using a filesystem volume, the container will be granted read and write permission.
160162

161163
=== Example of mapping volumes to persist the database data

_versions/main/guides/kafka-dev-services.adoc

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -89,8 +89,14 @@ quarkus.kafka.devservices.image-name=quay.io/strimzi-test-container/test-contain
8989

9090
You can configure the Dev Services for Kafka to create topics once the broker is started.
9191
Topics are created with given number of partitions and 1 replica.
92+
The syntax is the following:
9293

93-
The following example creates a topic named `test` with 3 partitions, and a second topic named `messages` with 2 partitions.
94+
[source, properties]
95+
----
96+
quarkus.kafka.devservices.topic-partitions.<topic-name>=<number-of-partitions>
97+
----
98+
99+
The following example creates a topic named `test` with three partitions, and a second topic named `messages` with two partitions.
94100

95101
[source, properties]
96102
----

_versions/main/guides/telemetry-micrometer-to-opentelemetry.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -137,7 +137,7 @@ The JVM and HTTP server metrics are collected by Micrometer.
137137
Next, are examples of the metrics collected by Micrometer and a comparison of what would be the `quarkus-micrometer-registry-prometheus` output vs the one on this bridge. A link to the equivalent OpenTelemetry Semantic Convention is also provided for reference and is not currently used in the bridge.
138138

139139
|===
140-
|Micrometer Meter |Quarkus Micrometer Prometheus output | This bridge OpenTelemetry output name | Related OpenTelemetry Semantic Convention (not applied)
140+
|Micrometer Meter |Quarkus Micrometer Prometheus client v0.x output | This bridge OpenTelemetry output name | Related OpenTelemetry Semantic Convention (not applied)
141141

142142
|Using the @Timed interceptor.
143143
|

_versions/main/guides/telemetry-micrometer-tutorial.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@ You should find something like this:
8888
----
8989
# HELP http_server_requests_seconds
9090
# TYPE http_server_requests_seconds summary
91-
http_server_requests_seconds_count{method="GET",outcome="SUCCESS",status="200",uri="/example/prime/{number}"} 2.0
91+
http_server_requests_seconds_count{method="GET",outcome="SUCCESS",status="200",uri="/example/prime/{number}"} 2
9292
http_server_requests_seconds_sum{method="GET",outcome="SUCCESS",status="200",uri="/example/prime/{number}"} 0.017385896
9393
# HELP http_server_requests_seconds_max
9494
# TYPE http_server_requests_seconds_max gauge

0 commit comments

Comments
 (0)