Skip to content

Commit 95906e5

Browse files
committed
Sync documentation of main branch
1 parent a936402 commit 95906e5

27 files changed

+799
-410
lines changed

_data/versioned/main/index/quarkus.yaml

Lines changed: 23 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ types:
1818
- title: Command Mode Applications
1919
filename: command-mode-reference.adoc
2020
summary: This reference guide explains how to develop command line applications with Quarkus.
21-
categories: "core, command-line"
21+
categories: "command-line, core"
2222
type: reference
2323
url: /guides/command-mode-reference
2424
- title: Configuration Reference Guide
@@ -148,6 +148,13 @@ types:
148148
categories: miscellaneous
149149
type: reference
150150
url: /guides/vertx-reference
151+
- title: Virtual Thread support reference
152+
filename: virtual-threads.adoc
153+
summary: This guide explains how to benefit from Java 19+ virtual threads in Quarkus application.
154+
categories: core
155+
id: virtual-threads
156+
type: reference
157+
url: /guides/virtual-threads
151158
concepts:
152159
- title: Authentication mechanisms in Quarkus
153160
filename: security-authentication-mechanisms.adoc
@@ -248,11 +255,18 @@ types:
248255
id: update-quarkus
249256
type: howto
250257
url: /guides/update-quarkus
258+
- title: Use virtual threads in REST applications
259+
filename: resteasy-reactive-virtual-threads.adoc
260+
summary: How to use virtual threads in a REST application
261+
categories: "web, core"
262+
id: resteasy-reactive-virtual-threads
263+
type: howto
264+
url: /guides/resteasy-reactive-virtual-threads
251265
tutorial:
252266
- title: Building a Native Executable
253267
filename: building-native-image.adoc
254268
summary: Build native executables with GraalVM or Mandrel.
255-
categories: "native, getting-started"
269+
categories: "getting-started, native"
256270
type: tutorial
257271
url: /guides/building-native-image
258272
- title: Collect metrics using Micrometer
@@ -304,7 +318,7 @@ types:
304318
- title: Secure a Quarkus application with Basic authentication and Jakarta Persistence
305319
filename: security-basic-authentication-tutorial.adoc
306320
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).
307-
categories: "security, getting-started"
321+
categories: "getting-started, security"
308322
id: security-basic-authentication-tutorial
309323
type: tutorial
310324
url: /guides/security-basic-authentication-tutorial
@@ -927,14 +941,14 @@ types:
927941
- title: Quarkus and Gradle
928942
filename: gradle-tooling.adoc
929943
summary: Develop and build your Quarkus application with Gradle
930-
categories: "native, tooling"
944+
categories: "tooling, native"
931945
id: gradle-tooling
932946
type: guide
933947
url: /guides/gradle-tooling
934948
- title: Quarkus and Maven
935949
filename: maven-tooling.adoc
936950
summary: Develop and build your Quarkus application with Maven
937-
categories: "native, tooling"
951+
categories: "tooling, native"
938952
id: maven-tooling
939953
type: guide
940954
url: /guides/maven-tooling
@@ -1062,14 +1076,14 @@ types:
10621076
- title: Testing Your Application
10631077
filename: getting-started-testing.adoc
10641078
summary: "This guide covers testing in JVM mode, native mode, and injection of resources into tests"
1065-
categories: "native, tooling, core"
1079+
categories: "tooling, native, core"
10661080
id: testing
10671081
type: guide
10681082
url: /guides/getting-started-testing
10691083
- title: Tips for writing native applications
10701084
filename: writing-native-applications-tips.adoc
10711085
summary: This guide is a collection of tips to help you solve the problems you encounter when compiling applications to native executable.
1072-
categories: "native, writing-extensions, core"
1086+
categories: "native, core, writing-extensions"
10731087
type: guide
10741088
url: /guides/writing-native-applications-tips
10751089
- title: Using Apache Kafka Streams
@@ -1311,13 +1325,13 @@ types:
13111325
- title: Validation with Hibernate Validator
13121326
filename: validation.adoc
13131327
summary: This guide covers how to use Hibernate Validator/Bean Validation in your REST services.
1314-
categories: "data, web"
1328+
categories: "web, data"
13151329
type: guide
13161330
url: /guides/validation
13171331
- title: Writing JSON REST Services
13181332
filename: rest-json.adoc
13191333
summary: JSON is now the lingua franca between microservices.
1320-
categories: "serialization, web"
1334+
categories: "web, serialization"
13211335
type: guide
13221336
url: /guides/rest-json
13231337
- title: Writing REST Services with RESTEasy Reactive
@@ -1332,11 +1346,6 @@ types:
13321346
categories: writing-extensions
13331347
type: guide
13341348
url: /guides/writing-extensions
1335-
- title: Writing simpler reactive REST services with Quarkus Virtual Thread support
1336-
filename: virtual-threads.adoc
1337-
summary: This guide explains how to benefit from Java 19 virtual threads when writing REST services in Quarkus.
1338-
type: guide
1339-
url: /guides/virtual-threads
13401349
- title: YAML Configuration
13411350
filename: config-yaml.adoc
13421351
summary: YAML as a Configuration Source.

_generated-doc/main/config/all-configuration-groups-generated-doc/io.quarkus.oidc.OidcTenantConfig

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

_generated-doc/main/config/all-configuration-groups-generated-doc/io.quarkus.smallrye.reactivemessaging.rabbitmq.deployment.RabbitMQDevServicesBuildTimeConfig

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
[{"configDocKey":{"type":"string","key":"quarkus.jacoco.data-file","additionalKeys":[],"configDoc":"The jacoco data file. By default this will be target/jacoco-quarkus.exec. The path can be relative (to the module) or absolute.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"data-file","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.jacoco","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.jacoco.reuse-data-file","additionalKeys":[],"configDoc":"Whether to reuse (`true`) or delete (`false`) the jacoco data file on each run.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"reuse-data-file","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.jacoco","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.jacoco.report","additionalKeys":[],"configDoc":"If Quarkus should generate the Jacoco report","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"report","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.jacoco","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.jacoco.output-encoding","additionalKeys":[],"configDoc":"Encoding of the generated reports.","withinAMap":false,"defaultValue":"UTF-8","javaDocSiteLink":"","docMapKey":"output-encoding","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.jacoco","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.jacoco.title","additionalKeys":[],"configDoc":"Name of the root node HTML report pages.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"title","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.jacoco","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.jacoco.footer","additionalKeys":[],"configDoc":"Footer text used in HTML report pages.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"footer","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.jacoco","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.jacoco.source-encoding","additionalKeys":[],"configDoc":"Encoding of the source files.","withinAMap":false,"defaultValue":"UTF-8","javaDocSiteLink":"","docMapKey":"source-encoding","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.jacoco","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.jacoco.includes","additionalKeys":[],"configDoc":"A list of class files to include in the report. May use wildcard characters (++*++ and ?). When not specified everything will be included.\n\nFor instance:\n\n - `++**++/fo/++**++/++*++` targets all classes under fo and sub packages\n - `++**++/bar/++*++` targets all classes directly under bar\n - `++**++/++*++BAR++*++.class` targets classes that contain BAR in their name regardless of path","withinAMap":false,"defaultValue":"**","javaDocSiteLink":"","docMapKey":"includes","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":false,"list":true,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.jacoco","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.jacoco.excludes","additionalKeys":[],"configDoc":"A list of class files to exclude from the report. May use wildcard characters (++*++ and ?). When not specified nothing will be excluded.\n\nFor instance:\n\n - `++**++/fo/++**++/++*++` targets all classes under fo and sub packages\n - `++**++/bar/++*++` targets all classes directly under bar\n - `++**++/++*++BAR++*++.class` targets classes that contain BAR in their name regardless of path","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"excludes","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":true,"list":true,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.jacoco","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.jacoco.report-location","additionalKeys":[],"configDoc":"The location of the report files. By default this will be target/jacoco-report. The path can be relative (to the module) or absolute.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"report-location","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.jacoco","enum":false}}]
1+
[{"configDocKey":{"type":"string","key":"quarkus.jacoco.data-file","additionalKeys":[],"configDoc":"The jacoco data file. The path can be relative (to the module) or absolute.","withinAMap":false,"defaultValue":"target/jacoco-quarkus.exec","javaDocSiteLink":"","docMapKey":"data-file","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.jacoco","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.jacoco.reuse-data-file","additionalKeys":[],"configDoc":"Whether to reuse (`true`) or delete (`false`) the jacoco data file on each run.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"reuse-data-file","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.jacoco","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.jacoco.report","additionalKeys":[],"configDoc":"If Quarkus should generate the Jacoco report","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"report","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.jacoco","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.jacoco.output-encoding","additionalKeys":[],"configDoc":"Encoding of the generated reports.","withinAMap":false,"defaultValue":"UTF-8","javaDocSiteLink":"","docMapKey":"output-encoding","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.jacoco","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.jacoco.title","additionalKeys":[],"configDoc":"Name of the root node HTML report pages.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"title","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.jacoco","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.jacoco.footer","additionalKeys":[],"configDoc":"Footer text used in HTML report pages.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"footer","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.jacoco","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.jacoco.source-encoding","additionalKeys":[],"configDoc":"Encoding of the source files.","withinAMap":false,"defaultValue":"UTF-8","javaDocSiteLink":"","docMapKey":"source-encoding","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.jacoco","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.jacoco.includes","additionalKeys":[],"configDoc":"A list of class files to include in the report. May use wildcard characters (++*++ and ?). When not specified everything will be included.\n\nFor instance:\n\n - `++**++/fo/++**++/++*++` targets all classes under fo and sub packages\n - `++**++/bar/++*++` targets all classes directly under bar\n - `++**++/++*++BAR++*++.class` targets classes that contain BAR in their name regardless of path","withinAMap":false,"defaultValue":"**","javaDocSiteLink":"","docMapKey":"includes","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":false,"list":true,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.jacoco","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.jacoco.excludes","additionalKeys":[],"configDoc":"A list of class files to exclude from the report. May use wildcard characters (++*++ and ?). When not specified nothing will be excluded.\n\nFor instance:\n\n - `++**++/fo/++**++/++*++` targets all classes under fo and sub packages\n - `++**++/bar/++*++` targets all classes directly under bar\n - `++**++/++*++BAR++*++.class` targets classes that contain BAR in their name regardless of path","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"excludes","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":true,"list":true,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.jacoco","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.jacoco.report-location","additionalKeys":[],"configDoc":"The location of the report files. The path can be relative (to the module) or absolute.","withinAMap":false,"defaultValue":"target/jacoco-report","javaDocSiteLink":"","docMapKey":"report-location","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.jacoco","enum":false}}]

_generated-doc/main/config/all-configuration-roots-generated-doc/io.quarkus.oidc.runtime.OidcConfig

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

0 commit comments

Comments
 (0)