Skip to content

Commit 12104f4

Browse files
committed
Sync documentation of main branch
1 parent ff27d43 commit 12104f4

File tree

4 files changed

+96
-84
lines changed

4 files changed

+96
-84
lines changed

_data/versioned/main/index/quarkus.yaml

Lines changed: 11 additions & 11 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
@@ -201,7 +201,7 @@ types:
201201
- title: Security vulnerability detection and reporting in Quarkus
202202
filename: security-vulnerability-detection-concept.adoc
203203
summary: Most of the Quarkus tags are registered in the US National Vulnerability Database (NVD) in Common Platform Enumeration (CPE) name format.
204-
categories: "contributing, security"
204+
categories: "security, contributing"
205205
id: security-vulnerability-detection-concept
206206
type: concepts
207207
url: /guides/security-vulnerability-detection-concept
@@ -289,7 +289,7 @@ types:
289289
- title: Secure a Quarkus application with Basic authentication and Jakarta Persistence
290290
filename: security-basic-authentication-tutorial.adoc
291291
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).
292-
categories: "getting-started, security"
292+
categories: "security, getting-started"
293293
id: security-basic-authentication-tutorial
294294
type: tutorial
295295
url: /guides/security-basic-authentication-tutorial
@@ -345,7 +345,7 @@ types:
345345
- title: AppCDS
346346
filename: appcds.adoc
347347
summary: This reference guide explains how to enable AppCDS with Quarkus.
348-
categories: "core, cloud"
348+
categories: "cloud, core"
349349
type: guide
350350
url: /guides/appcds
351351
- title: Application Data Caching
@@ -539,7 +539,7 @@ types:
539539
- title: Dev Services for Databases
540540
filename: databases-dev-services.adoc
541541
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."
542-
categories: "tooling, data"
542+
categories: "data, tooling"
543543
type: guide
544544
url: /guides/databases-dev-services
545545
- title: Dev Services for Elasticsearch
@@ -879,14 +879,14 @@ types:
879879
- title: Quarkus and Gradle
880880
filename: gradle-tooling.adoc
881881
summary: Develop and build your Quarkus application with Gradle
882-
categories: "tooling, native"
882+
categories: "native, tooling"
883883
id: gradle-tooling
884884
type: guide
885885
url: /guides/gradle-tooling
886886
- title: Quarkus and Maven
887887
filename: maven-tooling.adoc
888888
summary: Develop and build your Quarkus application with Maven
889-
categories: "tooling, native"
889+
categories: "native, tooling"
890890
id: maven-tooling
891891
type: guide
892892
url: /guides/maven-tooling
@@ -1014,14 +1014,14 @@ types:
10141014
- title: Testing Your Application
10151015
filename: getting-started-testing.adoc
10161016
summary: "This guide covers testing in JVM mode, native mode, and injection of resources into tests"
1017-
categories: "core, tooling, native"
1017+
categories: "native, core, tooling"
10181018
id: testing
10191019
type: guide
10201020
url: /guides/getting-started-testing
10211021
- title: Tips for writing native applications
10221022
filename: writing-native-applications-tips.adoc
10231023
summary: This guide is a collection of tips to help you solve the problems you encounter when compiling applications to native executable.
1024-
categories: "core, writing-extensions, native"
1024+
categories: "native, writing-extensions, core"
10251025
type: guide
10261026
url: /guides/writing-native-applications-tips
10271027
- title: Update projects to the latest version of Quarkus
@@ -1157,7 +1157,7 @@ types:
11571157
- title: Using SSL With Native Executables
11581158
filename: native-and-ssl.adoc
11591159
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."
1160-
categories: "core, security, native"
1160+
categories: "security, native, core"
11611161
type: guide
11621162
url: /guides/native-and-ssl
11631163
- title: Using Security with .properties File
@@ -1264,7 +1264,7 @@ types:
12641264
- title: Validation with Hibernate Validator
12651265
filename: validation.adoc
12661266
summary: This guide covers how to use Hibernate Validator/Bean Validation in your REST services.
1267-
categories: "data, web"
1267+
categories: "web, data"
12681268
type: guide
12691269
url: /guides/validation
12701270
- title: Writing JSON REST Services

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

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -66,37 +66,37 @@ endif::add-copy-button-to-env-var[]
6666
|`Build system locale`
6767

6868

69-
a| [[quarkus-core_quarkus.args]]`link:#quarkus-core_quarkus.args[quarkus.args]`
69+
a| [[quarkus-core_quarkus.init-and-exit]]`link:#quarkus-core_quarkus.init-and-exit[quarkus.init-and-exit]`
7070

7171
[.description]
7272
--
73-
The arguments passed to the command line.
74-
We don't make it a list as the args are separated by a space, not a comma.
73+
true to quit exit right after the initialization. The option is not meant be used directly by users.
7574

7675
ifdef::add-copy-button-to-env-var[]
77-
Environment variable: env_var_with_copy_button:+++QUARKUS_ARGS+++[]
76+
Environment variable: env_var_with_copy_button:+++QUARKUS_INIT_AND_EXIT+++[]
7877
endif::add-copy-button-to-env-var[]
7978
ifndef::add-copy-button-to-env-var[]
80-
Environment variable: `+++QUARKUS_ARGS+++`
79+
Environment variable: `+++QUARKUS_INIT_AND_EXIT+++`
8180
endif::add-copy-button-to-env-var[]
82-
--|string
83-
|
81+
--|boolean
82+
|`false`
8483

8584

86-
a| [[quarkus-core_quarkus.init-and-exit]]`link:#quarkus-core_quarkus.init-and-exit[quarkus.init-and-exit]`
85+
a| [[quarkus-core_quarkus.args]]`link:#quarkus-core_quarkus.args[quarkus.args]`
8786

8887
[.description]
8988
--
90-
true to quit exit right after the initialization. The option is not meant be used directly by users.
89+
The arguments passed to the command line.
90+
We don't make it a list as the args are separated by a space, not a comma.
9191

9292
ifdef::add-copy-button-to-env-var[]
93-
Environment variable: env_var_with_copy_button:+++QUARKUS_INIT_AND_EXIT+++[]
93+
Environment variable: env_var_with_copy_button:+++QUARKUS_ARGS+++[]
9494
endif::add-copy-button-to-env-var[]
9595
ifndef::add-copy-button-to-env-var[]
96-
Environment variable: `+++QUARKUS_INIT_AND_EXIT+++`
96+
Environment variable: `+++QUARKUS_ARGS+++`
9797
endif::add-copy-button-to-env-var[]
98-
--|boolean
99-
|`false`
98+
--|string
99+
|
100100

101101

102102
a| [[quarkus-core_quarkus.profile]]`link:#quarkus-core_quarkus.profile[quarkus.profile]`

_generated-doc/main/config/quarkus-smallrye-reactivemessaging-kafka.adoc

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -10,51 +10,51 @@ h|[[quarkus-smallrye-reactivemessaging-kafka_configuration]]link:#quarkus-smallr
1010
h|Type
1111
h|Default
1212

13-
a|icon:lock[title=Fixed at build time] [[quarkus-smallrye-reactivemessaging-kafka_quarkus.reactive-messaging.kafka.enable-graceful-shutdown-in-dev-and-test-mode]]`link:#quarkus-smallrye-reactivemessaging-kafka_quarkus.reactive-messaging.kafka.enable-graceful-shutdown-in-dev-and-test-mode[quarkus.reactive-messaging.kafka.enable-graceful-shutdown-in-dev-and-test-mode]`
13+
a|icon:lock[title=Fixed at build time] [[quarkus-smallrye-reactivemessaging-kafka_quarkus.reactive-messaging.kafka.serializer-autodetection.enabled]]`link:#quarkus-smallrye-reactivemessaging-kafka_quarkus.reactive-messaging.kafka.serializer-autodetection.enabled[quarkus.reactive-messaging.kafka.serializer-autodetection.enabled]`
1414

1515
[.description]
1616
--
17-
Enables the graceful shutdown in dev and test modes. The graceful shutdown waits until the inflight records have been processed and the offset committed to Kafka. While this setting is highly recommended in production, in dev and test modes, it's disabled by default. This setting allows to re-enable it.
17+
Whether or not Kafka serializer/deserializer auto-detection is enabled.
1818

1919
ifdef::add-copy-button-to-env-var[]
20-
Environment variable: env_var_with_copy_button:+++QUARKUS_REACTIVE_MESSAGING_KAFKA_ENABLE_GRACEFUL_SHUTDOWN_IN_DEV_AND_TEST_MODE+++[]
20+
Environment variable: env_var_with_copy_button:+++QUARKUS_REACTIVE_MESSAGING_KAFKA_SERIALIZER_AUTODETECTION_ENABLED+++[]
2121
endif::add-copy-button-to-env-var[]
2222
ifndef::add-copy-button-to-env-var[]
23-
Environment variable: `+++QUARKUS_REACTIVE_MESSAGING_KAFKA_ENABLE_GRACEFUL_SHUTDOWN_IN_DEV_AND_TEST_MODE+++`
23+
Environment variable: `+++QUARKUS_REACTIVE_MESSAGING_KAFKA_SERIALIZER_AUTODETECTION_ENABLED+++`
2424
endif::add-copy-button-to-env-var[]
2525
--|boolean
26-
|`false`
26+
|`true`
2727

2828

29-
a|icon:lock[title=Fixed at build time] [[quarkus-smallrye-reactivemessaging-kafka_quarkus.reactive-messaging.kafka.serializer-autodetection.enabled]]`link:#quarkus-smallrye-reactivemessaging-kafka_quarkus.reactive-messaging.kafka.serializer-autodetection.enabled[quarkus.reactive-messaging.kafka.serializer-autodetection.enabled]`
29+
a|icon:lock[title=Fixed at build time] [[quarkus-smallrye-reactivemessaging-kafka_quarkus.reactive-messaging.kafka.serializer-generation.enabled]]`link:#quarkus-smallrye-reactivemessaging-kafka_quarkus.reactive-messaging.kafka.serializer-generation.enabled[quarkus.reactive-messaging.kafka.serializer-generation.enabled]`
3030

3131
[.description]
3232
--
33-
Whether or not Kafka serializer/deserializer auto-detection is enabled.
33+
Whether Kafka serializer/deserializer generation is enabled. When no serializer/deserializer are found and not set, Quarkus generates a Jackson-based serde.
3434

3535
ifdef::add-copy-button-to-env-var[]
36-
Environment variable: env_var_with_copy_button:+++QUARKUS_REACTIVE_MESSAGING_KAFKA_SERIALIZER_AUTODETECTION_ENABLED+++[]
36+
Environment variable: env_var_with_copy_button:+++QUARKUS_REACTIVE_MESSAGING_KAFKA_SERIALIZER_GENERATION_ENABLED+++[]
3737
endif::add-copy-button-to-env-var[]
3838
ifndef::add-copy-button-to-env-var[]
39-
Environment variable: `+++QUARKUS_REACTIVE_MESSAGING_KAFKA_SERIALIZER_AUTODETECTION_ENABLED+++`
39+
Environment variable: `+++QUARKUS_REACTIVE_MESSAGING_KAFKA_SERIALIZER_GENERATION_ENABLED+++`
4040
endif::add-copy-button-to-env-var[]
4141
--|boolean
4242
|`true`
4343

4444

45-
a|icon:lock[title=Fixed at build time] [[quarkus-smallrye-reactivemessaging-kafka_quarkus.reactive-messaging.kafka.serializer-generation.enabled]]`link:#quarkus-smallrye-reactivemessaging-kafka_quarkus.reactive-messaging.kafka.serializer-generation.enabled[quarkus.reactive-messaging.kafka.serializer-generation.enabled]`
45+
a|icon:lock[title=Fixed at build time] [[quarkus-smallrye-reactivemessaging-kafka_quarkus.reactive-messaging.kafka.enable-graceful-shutdown-in-dev-and-test-mode]]`link:#quarkus-smallrye-reactivemessaging-kafka_quarkus.reactive-messaging.kafka.enable-graceful-shutdown-in-dev-and-test-mode[quarkus.reactive-messaging.kafka.enable-graceful-shutdown-in-dev-and-test-mode]`
4646

4747
[.description]
4848
--
49-
Whether Kafka serializer/deserializer generation is enabled. When no serializer/deserializer are found and not set, Quarkus generates a Jackson-based serde.
49+
Enables the graceful shutdown in dev and test modes. The graceful shutdown waits until the inflight records have been processed and the offset committed to Kafka. While this setting is highly recommended in production, in dev and test modes, it's disabled by default. This setting allows to re-enable it.
5050

5151
ifdef::add-copy-button-to-env-var[]
52-
Environment variable: env_var_with_copy_button:+++QUARKUS_REACTIVE_MESSAGING_KAFKA_SERIALIZER_GENERATION_ENABLED+++[]
52+
Environment variable: env_var_with_copy_button:+++QUARKUS_REACTIVE_MESSAGING_KAFKA_ENABLE_GRACEFUL_SHUTDOWN_IN_DEV_AND_TEST_MODE+++[]
5353
endif::add-copy-button-to-env-var[]
5454
ifndef::add-copy-button-to-env-var[]
55-
Environment variable: `+++QUARKUS_REACTIVE_MESSAGING_KAFKA_SERIALIZER_GENERATION_ENABLED+++`
55+
Environment variable: `+++QUARKUS_REACTIVE_MESSAGING_KAFKA_ENABLE_GRACEFUL_SHUTDOWN_IN_DEV_AND_TEST_MODE+++`
5656
endif::add-copy-button-to-env-var[]
5757
--|boolean
58-
|`true`
58+
|`false`
5959

6060
|===

0 commit comments

Comments
 (0)