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
gsmet committed Oct 5, 2023
1 parent 9df69d3 commit c3e504c
Show file tree
Hide file tree
Showing 15 changed files with 140 additions and 59 deletions.
32 changes: 16 additions & 16 deletions _data/versioned/latest/index/quarkus.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ types:
- title: Command Mode Applications
filename: command-mode-reference.adoc
summary: This reference guide explains how to develop command line applications with Quarkus.
categories: "core, command-line"
categories: "command-line, core"
type: reference
url: /guides/command-mode-reference
- title: Configuration Reference Guide
Expand Down 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: "core, observability, getting-started"
categories: "core, getting-started, observability"
id: logging
type: reference
url: /guides/logging
Expand Down Expand Up @@ -236,7 +236,7 @@ types:
- title: Security vulnerability detection and reporting in Quarkus
filename: security-vulnerability-detection.adoc
summary: Most of the Quarkus tags are registered in the US National Vulnerability Database (NVD) in Common Platform Enumeration (CPE) name format.
categories: "security, contributing"
categories: "contributing, security"
id: security-vulnerability-detection
type: concepts
url: /guides/security-vulnerability-detection
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 @@ -337,7 +337,7 @@ types:
url: /guides/tooling
- 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.
summary: Discover some of the features that make developing with Quarkus a joyful experience.
categories: "core, getting-started, data"
id: getting-started-dev-services-tutorial
type: tutorial
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 @@ -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 @@ -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: "data, alt-languages"
categories: "alt-languages, data"
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: "data, alt-languages"
categories: "alt-languages, data"
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: "core, native, tooling"
categories: "native, tooling, core"
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: "core, writing-extensions, native"
categories: "writing-extensions, native, core"
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: "core, security, native"
categories: "security, native, core"
type: guide
url: /guides/native-and-ssl
- title: Using Security with .properties File
Expand Down Expand Up @@ -1336,7 +1336,7 @@ types:
- title: Validation with Hibernate Validator
filename: validation.adoc
summary: This guide covers how to use Hibernate Validator/Bean Validation in your REST services.
categories: "data, web"
categories: "web, data"
type: guide
url: /guides/validation
- title: Writing JSON REST Services
Expand Down
2 changes: 1 addition & 1 deletion _generated-doc/latest/config/quarkus-all-build-items.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -289,7 +289,7 @@ a| None
a| https://github.com/quarkusio/quarkus/blob/main/core/deployment/src/main/java/io/quarkus/deployment/builditem/nativeimage/JPMSExportBuildItem.java[`io.quarkus.deployment.builditem.nativeimage.JPMSExportBuildItem`, window="_blank"] :: +++A build item that indicates that a Java package should be exported using '-J--add-exports' option to become visible to native-image+++
a| `String moduleName` :: +++<i>No Javadoc found</i>+++
`String packageName` :: +++<i>No Javadoc found</i>+++
`GraalVM.Version exportAfter` :: +++<i>No Javadoc found</i>+++
`GraalVM.Version exportSince` :: +++<i>No Javadoc found</i>+++
`GraalVM.Version exportBefore` :: +++<i>No Javadoc found</i>+++
a| https://github.com/quarkusio/quarkus/blob/main/core/deployment/src/main/java/io/quarkus/deployment/pkg/builditem/JarBuildItem.java[`io.quarkus.deployment.pkg.builditem.JarBuildItem`, window="_blank"] :: +++<i>No Javadoc found</i>+++
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.4.1
:quarkus-version: 3.4.2
:quarkus-platform-groupid: io.quarkus.platform
// .
:maven-version: 3.9.3
Expand Down
5 changes: 5 additions & 0 deletions _guides/appcds.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -87,6 +87,11 @@ This results in an archive generation process that on one hand is completely saf
As a result, users are expected to get a slightly more effective archive if they manually go through the hoops of generating the AppCDS archive.
====

[IMPORTANT]
====
AppCDS has improved significantly in the latest JDK releases. This means that to ensure the best possible improvements from it, make sure your projects targets the highest possible Java version (ideally 17 or 21).
====

=== Usage in containers

When building container images using the `quarkus-container-image-jib` extension, Quarkus automatically takes care of all the steps needed to generate the archive
Expand Down
16 changes: 16 additions & 0 deletions _guides/datasource.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -294,6 +294,22 @@ Quarkus offers several reactive clients for a use with reactive datasource.
+
The installed extension must be consistent with the `quarkus.datasource.db-kind` you define in your datasource configuration.

[WARNING]
====
The Reactive Oracle datasource depends on the https://docs.oracle.com/en/database/oracle/oracle-database/23/jjdbc/jdbc-reactive-extensions.html[Reactive Extensions] provided by Oracle in its JDBC driver.
There is a bug in versions 23.2 and 21.11 of the Oracle JDBC driver that prevents from getting any response if:
* Reactive Extensions are used to execute an update/insert query that ends with an error (e.g. constraint violation), and
* https://vertx.io/docs/vertx-oracle-client/java/#_retrieving_generated_key_values[generated keys retrieval] is enabled.
It is not known yet when the bug will be fixed.
In the meantime, you can either:
* change the version of the driver in your project to `com.oracle.database.jdbc:ojdbc11:21.10.0.0`, or
* avoid executing queries with generated keys retrieval (e.g. load sequence value before inserting)
====

. After adding the driver, configure the connection URL and define a proper size for your connection pool.
+
[source,properties]
Expand Down
Loading

0 comments on commit c3e504c

Please sign in to comment.