Skip to content

Commit

Permalink
Sync documentation of main branch
Browse files Browse the repository at this point in the history
  • Loading branch information
actions-user committed Sep 19, 2023
1 parent ffa405c commit 119ffd0
Show file tree
Hide file tree
Showing 7 changed files with 26 additions and 36 deletions.
32 changes: 16 additions & 16 deletions _data/versioned/main/index/quarkus.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ types:
- title: Logging configuration
filename: logging.adoc
summary: "Read about the use of logging API in Quarkus, configuring logging output, and using logging adapters to unify the output from other logging APIs."
categories: "getting-started, observability, core"
categories: "core, getting-started, observability"
id: logging
type: reference
url: /guides/logging
Expand Down Expand Up @@ -273,7 +273,7 @@ types:
- title: Building a Native Executable
filename: building-native-image.adoc
summary: Build native executables with GraalVM or Mandrel.
categories: "getting-started, native"
categories: "native, getting-started"
type: tutorial
url: /guides/building-native-image
- title: Collect metrics using Micrometer
Expand Down Expand Up @@ -325,7 +325,7 @@ types:
- title: Secure a Quarkus application with Basic authentication and Jakarta Persistence
filename: security-basic-authentication-tutorial.adoc
summary: Secure your Quarkus application endpoints by combining the built-in Quarkus Basic authentication with the Jakarta Persistence identity provider to enable role-based access control (RBAC).
categories: "getting-started, security"
categories: "security, getting-started"
id: security-basic-authentication-tutorial
type: tutorial
url: /guides/security-basic-authentication-tutorial
Expand All @@ -338,7 +338,7 @@ types:
- title: Your second Quarkus application
filename: getting-started-dev-services.adoc
summary: This tutorial shows you how to create an application which writes to and reads from a database.
categories: "getting-started, data, core"
categories: "core, getting-started, data"
id: getting-started-dev-services-tutorial
type: tutorial
url: /guides/getting-started-dev-services
Expand Down Expand Up @@ -394,7 +394,7 @@ types:
- title: AppCDS
filename: appcds.adoc
summary: This reference guide explains how to enable AppCDS with Quarkus.
categories: "core, cloud"
categories: "cloud, core"
type: guide
url: /guides/appcds
- title: Application Data Caching
Expand Down Expand Up @@ -528,7 +528,7 @@ types:
- title: Deploying on OpenShift
filename: deploying-to-openshift.adoc
summary: This guide covers how to deploy a native application on OpenShift.
categories: "native, cloud"
categories: "cloud, native"
id: deploy-openshift
type: guide
url: /guides/deploying-to-openshift
Expand Down Expand Up @@ -583,7 +583,7 @@ types:
- title: Dev Services for Databases
filename: databases-dev-services.adoc
summary: "When testing or running in dev mode Quarkus can provide you with a zero-config database out of the box, a feature we refer to as Dev Services."
categories: "data, tooling"
categories: "tooling, data"
type: guide
url: /guides/databases-dev-services
- title: Dev Services for Elasticsearch
Expand Down Expand Up @@ -813,7 +813,7 @@ types:
- title: Kubernetes extension
filename: deploying-to-kubernetes.adoc
summary: This guide covers how to deploy a native application on Kubernetes.
categories: "native, cloud"
categories: "cloud, native"
id: deploy-kubernetes
type: guide
url: /guides/deploying-to-kubernetes
Expand Down Expand Up @@ -952,14 +952,14 @@ types:
- title: Quarkus and Gradle
filename: gradle-tooling.adoc
summary: Develop and build your Quarkus application with Gradle
categories: "native, tooling"
categories: "tooling, native"
id: gradle-tooling
type: guide
url: /guides/gradle-tooling
- title: Quarkus and Maven
filename: maven-tooling.adoc
summary: Develop and build your Quarkus application with Maven
categories: "native, tooling"
categories: "tooling, native"
id: maven-tooling
type: guide
url: /guides/maven-tooling
Expand Down Expand Up @@ -1033,7 +1033,7 @@ types:
- title: Simplified Hibernate ORM with Panache and Kotlin
filename: hibernate-orm-panache-kotlin.adoc
summary: This explains the specifics of using Hibernate ORM with Panache in a Kotlin project.
categories: "alt-languages, data"
categories: "data, alt-languages"
type: guide
url: /guides/hibernate-orm-panache-kotlin
- title: Simplified Hibernate Reactive with Panache
Expand All @@ -1051,13 +1051,13 @@ types:
- title: Simplified MongoDB with Panache and Kotlin
filename: mongodb-panache-kotlin.adoc
summary: This guide covers the usage of MongoDB using active records and repositories in a Kotlin project.
categories: "alt-languages, data"
categories: "data, alt-languages"
type: guide
url: /guides/mongodb-panache-kotlin
- title: SmallRye Fault Tolerance
filename: smallrye-fault-tolerance.adoc
summary: This guide demonstrates how your Quarkus application can utilize the SmallRye Fault Tolerance specification through the SmallRye Fault Tolerance extension.
categories: "observability, web"
categories: "web, observability"
type: guide
url: /guides/smallrye-fault-tolerance
- title: SmallRye GraphQL
Expand Down Expand Up @@ -1087,14 +1087,14 @@ types:
- title: Testing Your Application
filename: getting-started-testing.adoc
summary: "This guide covers testing in JVM mode, native mode, and injection of resources into tests"
categories: "native, tooling, core"
categories: "tooling, core, native"
id: testing
type: guide
url: /guides/getting-started-testing
- title: Tips for writing native applications
filename: writing-native-applications-tips.adoc
summary: This guide is a collection of tips to help you solve the problems you encounter when compiling applications to native executable.
categories: "writing-extensions, native, core"
categories: "writing-extensions, core, native"
type: guide
url: /guides/writing-native-applications-tips
- title: Using Apache Kafka Streams
Expand Down Expand Up @@ -1223,7 +1223,7 @@ types:
- title: Using SSL With Native Executables
filename: native-and-ssl.adoc
summary: "In this guide, we will discuss how you can get your native images to support SSL, as native images don't support it out of the box."
categories: "native, security, core"
categories: "core, native, security"
type: guide
url: /guides/native-and-ssl
- title: Using Security with .properties File
Expand Down
20 changes: 5 additions & 15 deletions _generated-doc/main/config/quarkus-all-build-items.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -1650,24 +1650,14 @@ a| https://github.com/quarkusio/quarkus/blob/main/extensions/qute/deployment/src
a| `Predicate predicate` :: +++<i>No Javadoc found</i>+++
`boolean extensionMethodPredicate` :: +++<i>No Javadoc found</i>+++
|===
== Reactive Datasource
[%header,cols=2*]
|===
|Class Name |Attributes
a| https://github.com/quarkusio/quarkus/blob/main/extensions/reactive-datasource/deployment/src/main/java/io/quarkus/reactive/datasource/deployment/VertxPoolBuildItem.java[`io.quarkus.reactive.datasource.deployment.VertxPoolBuildItem`, window="_blank"] :: +++A build item for Vertx s. <p> If you inject this build item when recording runtime init template calls, you are guaranteed the Pool configuration has been injected and Pools can be created.+++
a| `RuntimeValue vertxPool` :: +++<i>No Javadoc found</i>+++
`String dbKind` :: +++<i>No Javadoc found</i>+++
`boolean isDefault` :: +++<i>No Javadoc found</i>+++
|===
== Reactive DB2 Client
[%header,cols=2*]
|===
|Class Name |Attributes
a| https://github.com/quarkusio/quarkus/blob/main/extensions/reactive-db2-client/deployment/src/main/java/io/quarkus/reactive/db2/client/deployment/DB2PoolBuildItem.java[`io.quarkus.reactive.db2.client.deployment.DB2PoolBuildItem`, window="_blank"] :: +++<i>No Javadoc found</i>+++
a| `String dataSourceName` :: +++<i>No Javadoc found</i>+++
`RuntimeValue db2Pool` :: +++<i>No Javadoc found</i>+++
`Function db2Pool` :: +++<i>No Javadoc found</i>+++
|===
== Reactive Microsoft SQL Server Client
Expand All @@ -1676,7 +1666,7 @@ a| `String dataSourceName` :: +++<i>No Javadoc found</i>+++
|Class Name |Attributes
a| https://github.com/quarkusio/quarkus/blob/main/extensions/reactive-mssql-client/deployment/src/main/java/io/quarkus/reactive/mssql/client/deployment/MSSQLPoolBuildItem.java[`io.quarkus.reactive.mssql.client.deployment.MSSQLPoolBuildItem`, window="_blank"] :: +++<i>No Javadoc found</i>+++
a| `String dataSourceName` :: +++<i>No Javadoc found</i>+++
`RuntimeValue mssqlPool` :: +++<i>No Javadoc found</i>+++
`Function mssqlPool` :: +++<i>No Javadoc found</i>+++
|===
== Reactive MySQL Client
Expand All @@ -1685,7 +1675,7 @@ a| `String dataSourceName` :: +++<i>No Javadoc found</i>+++
|Class Name |Attributes
a| https://github.com/quarkusio/quarkus/blob/main/extensions/reactive-mysql-client/deployment/src/main/java/io/quarkus/reactive/mysql/client/deployment/MySQLPoolBuildItem.java[`io.quarkus.reactive.mysql.client.deployment.MySQLPoolBuildItem`, window="_blank"] :: +++<i>No Javadoc found</i>+++
a| `String dataSourceName` :: +++<i>No Javadoc found</i>+++
`RuntimeValue mysqlPool` :: +++<i>No Javadoc found</i>+++
`Function mysqlPool` :: +++<i>No Javadoc found</i>+++
|===
== Reactive Oracle Client
Expand All @@ -1694,7 +1684,7 @@ a| `String dataSourceName` :: +++<i>No Javadoc found</i>+++
|Class Name |Attributes
a| https://github.com/quarkusio/quarkus/blob/main/extensions/reactive-oracle-client/deployment/src/main/java/io/quarkus/reactive/oracle/client/deployment/OraclePoolBuildItem.java[`io.quarkus.reactive.oracle.client.deployment.OraclePoolBuildItem`, window="_blank"] :: +++<i>No Javadoc found</i>+++
a| `String dataSourceName` :: +++<i>No Javadoc found</i>+++
`RuntimeValue oraclePool` :: +++<i>No Javadoc found</i>+++
`Function oraclePool` :: +++<i>No Javadoc found</i>+++
|===
== Reactive PostgreSQL Client
Expand All @@ -1703,7 +1693,7 @@ a| `String dataSourceName` :: +++<i>No Javadoc found</i>+++
|Class Name |Attributes
a| https://github.com/quarkusio/quarkus/blob/main/extensions/reactive-pg-client/deployment/src/main/java/io/quarkus/reactive/pg/client/deployment/PgPoolBuildItem.java[`io.quarkus.reactive.pg.client.deployment.PgPoolBuildItem`, window="_blank"] :: +++<i>No Javadoc found</i>+++
a| `String dataSourceName` :: +++<i>No Javadoc found</i>+++
`RuntimeValue pgPool` :: +++<i>No Javadoc found</i>+++
`Function pgPool` :: +++<i>No Javadoc found</i>+++
|===
== Reactive Routes
Expand Down
2 changes: 1 addition & 1 deletion _versions/main/guides/aws-lambda-http.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -576,4 +576,4 @@ the `QUARKUS_AWS_LAMBDA_FORCE_USER_NAME` environment variable

== SnapStart

To optimize your application for Lambda SnapStart, check xref:amazon-snapstart.adoc[the SnapStart Configuration Documentation].
To optimize your application for Lambda SnapStart, check xref:aws-lambda-snapstart.adoc[the SnapStart Configuration Documentation].
2 changes: 1 addition & 1 deletion _versions/main/guides/aws-lambda.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -715,4 +715,4 @@ That's all there is to it!

== SnapStart

To optimize your application for Lambda SnapStart, check xref:amazon-snapstart.adoc[the SnapStart Configuration Documentation].
To optimize your application for Lambda SnapStart, check xref:aws-lambda-snapstart.adoc[the SnapStart Configuration Documentation].
2 changes: 1 addition & 1 deletion _versions/main/guides/deploying-to-kubernetes.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -1485,7 +1485,7 @@ To enable Service Binding for supported extensions, add the `quarkus-kubernetes-
* `quarkus-jdbc-mssql`
* `quarkus-jdbc-mysql`
* `quarkus-jdbc-postgresql`
* `quarkus-mongo-client`
* `quarkus-mongodb-client`
* `quarkus-kafka-client`
* `quarkus-smallrye-reactive-messaging-kafka`
Expand Down
2 changes: 1 addition & 1 deletion _versions/main/guides/jms.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ You can follow the instructions from the https://activemq.apache.org/components/

[source,bash]
----
docker run -it --rm -p 8161:8161 -p 61616:61616 -p 5672:5672 -e AMQ_USER=quarkus -e AMQ_PASSWORD=quarkus quay.io/artemiscloud/activemq-artemis-broker:0.1.4
docker run -it --rm -p 8161:8161 -p 61616:61616 -p 5672:5672 -e AMQ_USER=quarkus -e AMQ_PASSWORD=quarkus quay.io/artemiscloud/activemq-artemis-broker:1.0.21
----

=== The price producer
Expand Down
2 changes: 1 addition & 1 deletion _versions/main/guides/kafka.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -675,7 +675,7 @@ public void consume(List<Double> prices) {
}
----

The incoming method can also receive `Message<List<Payload>>`, `KafkaRecordBatch<Key, Payload>` `ConsumerRecords<Key, Payload>` types.
The incoming method can also receive `Message<List<Payload>>`, `KafkaRecordBatch<Key, Payload>`, and `ConsumerRecords<Key, Payload>` types.
They give access to record details such as offset or timestamp:

[source, java]
Expand Down

0 comments on commit 119ffd0

Please sign in to comment.