Skip to content

Commit

Permalink
Sync web site with Quarkus documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
quarkusbot committed Dec 11, 2024
1 parent 0aa09ef commit 3ef2e95
Show file tree
Hide file tree
Showing 12 changed files with 96 additions and 13 deletions.
19 changes: 18 additions & 1 deletion _generated-doc/latest/config/quarkus-all-config.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -26524,7 +26524,7 @@ Kafka dev service container type.

Redpanda, Strimzi and kafka-native container providers are supported. Default is redpanda.

For Redpanda: See https://docs.redpanda.com/current/get-started/quick-start/ and https://hub.docker.com/r/vectorized/redpanda
For Redpanda: See https://docs.redpanda.com/current/get-started/quick-start/ and https://hub.docker.com/r/redpandadata/redpanda

For Strimzi: See https://github.com/strimzi/test-container and https://quay.io/repository/strimzi-test-container/test-container

Expand Down Expand Up @@ -61469,6 +61469,23 @@ endif::add-copy-button-to-env-var[]
|list of string
|

a| [[quarkus-spring-cloud-config-client_quarkus-spring-cloud-config-ordinal]] [.property-path]##link:#quarkus-spring-cloud-config-client_quarkus-spring-cloud-config-ordinal[`quarkus.spring-cloud-config.ordinal`]##

[.description]
--
Microprofile Config ordinal.


ifdef::add-copy-button-to-env-var[]
Environment variable: env_var_with_copy_button:+++QUARKUS_SPRING_CLOUD_CONFIG_ORDINAL+++[]
endif::add-copy-button-to-env-var[]
ifndef::add-copy-button-to-env-var[]
Environment variable: `+++QUARKUS_SPRING_CLOUD_CONFIG_ORDINAL+++`
endif::add-copy-button-to-env-var[]
--
|int
|`450`


h|[.extension-name]##Quartz##
h|Type
Expand Down
2 changes: 1 addition & 1 deletion _generated-doc/latest/config/quarkus-kafka-client.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@ Kafka dev service container type.

Redpanda, Strimzi and kafka-native container providers are supported. Default is redpanda.

For Redpanda: See https://docs.redpanda.com/current/get-started/quick-start/ and https://hub.docker.com/r/vectorized/redpanda
For Redpanda: See https://docs.redpanda.com/current/get-started/quick-start/ and https://hub.docker.com/r/redpandadata/redpanda

For Strimzi: See https://github.com/strimzi/test-container and https://quay.io/repository/strimzi-test-container/test-container

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@ Kafka dev service container type.

Redpanda, Strimzi and kafka-native container providers are supported. Default is redpanda.

For Redpanda: See https://docs.redpanda.com/current/get-started/quick-start/ and https://hub.docker.com/r/vectorized/redpanda
For Redpanda: See https://docs.redpanda.com/current/get-started/quick-start/ and https://hub.docker.com/r/redpandadata/redpanda

For Strimzi: See https://github.com/strimzi/test-container and https://quay.io/repository/strimzi-test-container/test-container

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ Kafka dev service container type.

Redpanda, Strimzi and kafka-native container providers are supported. Default is redpanda.

For Redpanda: See https://docs.redpanda.com/current/get-started/quick-start/ and https://hub.docker.com/r/vectorized/redpanda
For Redpanda: See https://docs.redpanda.com/current/get-started/quick-start/ and https://hub.docker.com/r/redpandadata/redpanda

For Strimzi: See https://github.com/strimzi/test-container and https://quay.io/repository/strimzi-test-container/test-container

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -300,6 +300,23 @@ endif::add-copy-button-to-env-var[]
|list of string
|

a| [[quarkus-spring-cloud-config-client_quarkus-spring-cloud-config-ordinal]] [.property-path]##link:#quarkus-spring-cloud-config-client_quarkus-spring-cloud-config-ordinal[`quarkus.spring-cloud-config.ordinal`]##

[.description]
--
Microprofile Config ordinal.


ifdef::add-copy-button-to-env-var[]
Environment variable: env_var_with_copy_button:+++QUARKUS_SPRING_CLOUD_CONFIG_ORDINAL+++[]
endif::add-copy-button-to-env-var[]
ifndef::add-copy-button-to-env-var[]
Environment variable: `+++QUARKUS_SPRING_CLOUD_CONFIG_ORDINAL+++`
endif::add-copy-button-to-env-var[]
--
|int
|`450`

|===

ifndef::no-duration-note[]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -300,6 +300,23 @@ endif::add-copy-button-to-env-var[]
|list of string
|

a| [[quarkus-spring-cloud-config-client_quarkus-spring-cloud-config-ordinal]] [.property-path]##link:#quarkus-spring-cloud-config-client_quarkus-spring-cloud-config-ordinal[`quarkus.spring-cloud-config.ordinal`]##

[.description]
--
Microprofile Config ordinal.


ifdef::add-copy-button-to-env-var[]
Environment variable: env_var_with_copy_button:+++QUARKUS_SPRING_CLOUD_CONFIG_ORDINAL+++[]
endif::add-copy-button-to-env-var[]
ifndef::add-copy-button-to-env-var[]
Environment variable: `+++QUARKUS_SPRING_CLOUD_CONFIG_ORDINAL+++`
endif::add-copy-button-to-env-var[]
--
|int
|`450`

|===

ifndef::no-duration-note[]
Expand Down
2 changes: 1 addition & 1 deletion _guides/_attributes.adoc
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
// Common attributes.
// --> No blank lines (it ends the document header)
:project-name: Quarkus
:quarkus-version: 3.17.3
:quarkus-version: 3.17.4
:quarkus-platform-groupid: io.quarkus.platform
// .
:maven-version: 3.9.9
Expand Down
4 changes: 2 additions & 2 deletions _guides/kafka-dev-services.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -56,8 +56,8 @@ Dev Services for Kafka supports https://redpanda.com[Redpanda], https://github/o
and https://strimzi.io[Strimzi] (in https://github.com/apache/kafka/blob/trunk/config/kraft/README.md[Kraft] mode) images.

**Redpanda** is a Kafka compatible event streaming platform.
Because it provides a fast startup times, Dev Services defaults to Redpanda images from `vectorized/redpanda`.
You can select any version from https://hub.docker.com/r/vectorized/redpanda.
Because it provides a fast startup times, Dev Services defaults to Redpanda images from `redpandadata/redpanda`.
You can select any version from https://hub.docker.com/r/redpandadata/redpanda.

**kafka-native** provides images of standard Apache Kafka distribution compiled to native binary using Quarkus and GraalVM.
While still being _experimental_, it provides very fast startup times with small footprint.
Expand Down
8 changes: 4 additions & 4 deletions _guides/native-reference.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -598,7 +598,7 @@ invoke Maven's `verify` goal with `-DskipITs=false -Dquarkus.test.integration-te
generate the native image configuration.
For example:

[source,bash]
[source,bash,subs=attributes+]
----
$ ./mvnw verify -DskipITs=false -Dquarkus.test.integration-test-profile=test-with-native-agent
...
Expand Down Expand Up @@ -660,7 +660,7 @@ This can be useful to verify that the native integration tests work as expected,
assuming that the JVM unit tests have generated the correct native image configuration.
The typical workflow here would be to first run the integration tests with the native image agent as shown in the previous section:

[source,bash]
[source,bash,subs=attributes+]
----
$ ./mvnw verify -DskipITs=false -Dquarkus.test.integration-test-profile=test-with-native-agent
...
Expand All @@ -671,7 +671,7 @@ $ ./mvnw verify -DskipITs=false -Dquarkus.test.integration-test-profile=test-wit
And then request a native build passing in the configuration apply flag.
A message during the native build process will indicate that the native image agent generated configuration files are being applied:

[source,bash]
[source,bash,subs=attributes+]
----
$ ./mvnw verify -Dnative -Dquarkus.native.agent-configuration-apply
...
Expand Down Expand Up @@ -702,7 +702,7 @@ and confirm that the class and/or package making the call or being accessed is n
If the missing entry is related to some resource,
you should inspect the Quarkus build debug output and verify which resource patterns are being discarded, e.g.

[source,bash]
[source,bash,subs=attributes+]
----
$ ./mvnw -X verify -DskipITs=false -Dquarkus.test.integration-test-profile=test-with-native-agent
...
Expand Down
2 changes: 1 addition & 1 deletion _guides/observability-devservices-lgtm.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ Add the Quarkus Grafana OTel LGTM sink (where data goes) extension to your build
[source,gradle,role="secondary asciidoc-tabs-target-sync-gradle"]
.build.gradle
----
implementation("quarkus-observability-devservices-lgtm")
implementation("io.quarkus:quarkus-observability-devservices-lgtm")
----

=== Metrics
Expand Down
32 changes: 32 additions & 0 deletions _guides/rest-client.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -325,6 +325,38 @@ public interface ExtensionsService {
}
----

=== Dynamic base URLs

The REST client allows for a per invocation override of the base URL using the `io.quarkus.rest.client.reactive.Url` annotation.

Here is a simple example:

[source, java]
----
package org.acme.rest.client;
import org.eclipse.microprofile.rest.client.inject.RegisterRestClient;
import jakarta.ws.rs.GET;
import jakarta.ws.rs.Path;
import jakarta.ws.rs.PathParam;
import jakarta.ws.rs.QueryParam;
import java.util.Set;
import io.quarkus.rest.client.reactive.Url;
@Path("/extensions")
@RegisterRestClient
public interface ExtensionsService {
@GET
@Path("/stream/{stream}")
Set<Extension> getByStream(@Url String url, @PathParam("stream") String stream, @QueryParam("id") String id);
}
----

When the `url` parameter is non-null, it will override the base URL that is configured for the client (the default base URL configuration is still mandatory).

=== Sending large payloads

The REST Client is capable of sending arbitrarily large HTTP bodies without buffering the contents in memory, if one of the following types is used:
Expand Down
2 changes: 1 addition & 1 deletion _guides/rest-virtual-threads.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ and in particular, adds the following dependencies:
.build.gradle
----
implementation("io.quarkus:quarkus-rest-jackson")
implementation("quarkus-rest-client-jackson")
implementation("io.quarkus:quarkus-rest-client-jackson")
----

[NOTE]
Expand Down

0 comments on commit 3ef2e95

Please sign in to comment.