Skip to content

Commit 875db22

Browse files
committed
Sync documentation of main branch
1 parent 9806d6b commit 875db22

File tree

178 files changed

+295
-208
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

178 files changed

+295
-208
lines changed
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
[{"configDocKey":{"type":"boolean","key":".enabled","additionalKeys":[],"configDoc":"If set to true and SmallRye Context Propagation extension is present then enable the context propagation for CDI contexts.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}}]
1+
[{"configDocKey":{"type":"boolean","key":".enabled","additionalKeys":[],"configDoc":"If set to true and the SmallRye Context Propagation extension is present then the CDI contexts will be propagated by means of the MicroProfile Context Propagation API. Specifically, a `org.eclipse.microprofile.context.spi.ThreadContextProvider` implementation is registered. On the other hand, if set to false then the MicroProfile Context Propagation API will never be used to propagate the CDI contexts. Note that the CDI contexts may be propagated in a different way though. For example with the Vertx duplicated context.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}}]
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
[{"configDocKey":{"type":"boolean","key":".monitoring-enabled","additionalKeys":[],"configDoc":"If set to true then the container monitors business method invocations and fired events during the development mode.\n\nNOTE: This config property should not be changed in the development mode as it requires a full rebuild of the application","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"monitoring-enabled","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}}]
1+
[{"configDocKey":{"type":"boolean","key":".monitoring-enabled","additionalKeys":[],"configDoc":"If set to true then the container monitors business method invocations and fired events during the development mode.\n\nNOTE: This config property should not be changed in the development mode as it requires a full rebuild of the application","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"monitoring-enabled","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"boolean","key":".generate-dependency-graphs","additionalKeys":[],"configDoc":"If set to true then the dependency graphs are generated and available in the Dev UI.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"generate-dependency-graphs","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}}]
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
[{"configDocKey":{"type":"string","key":".group-id","additionalKeys":[],"configDoc":"The maven groupId of the artifact.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"group-id","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".artifact-id","additionalKeys":[],"configDoc":"The maven artifactId of the artifact.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"artifact-id","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".classifier","additionalKeys":[],"configDoc":"The maven classifier of the artifact.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"classifier","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}}]
1+
[{"configDocKey":{"type":"string","key":".group-id","additionalKeys":[],"configDoc":"The maven groupId of the artifact.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"group-id","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".artifact-id","additionalKeys":[],"configDoc":"The maven artifactId of the artifact (optional).","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"artifact-id","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".classifier","additionalKeys":[],"configDoc":"The maven classifier of the artifact (optional).","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"classifier","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}}]

_generated-doc/main/config/all-configuration-roots-generated-doc/io.quarkus.arc.deployment.ArcConfig

+1-1
Large diffs are not rendered by default.
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
[{"configDocSection":{"name":"quarkus.index-dependency.index-dependency","optional":false,"withinAMap":false,"sectionDetails":"= Artifacts on the classpath that should also be indexed\n\nTheir classes will be in the index and processed by Quarkus processors.","sectionDetailsTitle":"Artifacts on the classpath that should also be indexed","configPhase":"BUILD_TIME","topLevelGrouping":"quarkus.index-dependency","configGroupType":"io.quarkus.deployment.index.IndexDependencyConfig","showSection":true,"configDocItems":[{"configDocKey":{"type":"string","key":"quarkus.index-dependency.\"dependency-name\".group-id","additionalKeys":[],"configDoc":"The maven groupId of the artifact.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"group-id","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.index-dependency","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.index-dependency.\"dependency-name\".artifact-id","additionalKeys":[],"configDoc":"The maven artifactId of the artifact.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"artifact-id","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.index-dependency","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.index-dependency.\"dependency-name\".classifier","additionalKeys":[],"configDoc":"The maven classifier of the artifact.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"classifier","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.index-dependency","enum":false}}],"anchorPrefix":null}}]
1+
[{"configDocSection":{"name":"quarkus.index-dependency.index-dependency","optional":false,"withinAMap":false,"sectionDetails":"= Artifacts on the classpath that should also be indexed\n\nTheir classes will be in the index and processed by Quarkus processors.","sectionDetailsTitle":"Artifacts on the classpath that should also be indexed","configPhase":"BUILD_TIME","topLevelGrouping":"quarkus.index-dependency","configGroupType":"io.quarkus.deployment.index.IndexDependencyConfig","showSection":true,"configDocItems":[{"configDocKey":{"type":"string","key":"quarkus.index-dependency.\"dependency-name\".group-id","additionalKeys":[],"configDoc":"The maven groupId of the artifact.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"group-id","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.index-dependency","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.index-dependency.\"dependency-name\".artifact-id","additionalKeys":[],"configDoc":"The maven artifactId of the artifact (optional).","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"artifact-id","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.index-dependency","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.index-dependency.\"dependency-name\".classifier","additionalKeys":[],"configDoc":"The maven classifier of the artifact (optional).","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"classifier","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.index-dependency","enum":false}}],"anchorPrefix":null}}]

_generated-doc/main/config/quarkus-agroal-config-group-data-source-jdbc-runtime-config.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -818,7 +818,7 @@ ifndef::no-duration-note[]
818818
.About the Duration format
819819
====
820820
To write duration values, use the standard `java.time.Duration` format.
821-
See the link:https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/time/Duration.html#parse(java.lang.CharSequence)[Duration#parse() Java API documentation] for more information.
821+
See the link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html#parse(java.lang.CharSequence)[Duration#parse() Java API documentation] for more information.
822822

823823
You can also use a simplified format, starting with a number:
824824

_generated-doc/main/config/quarkus-agroal-config-group-data-sources-jdbc-runtime-config-data-source-jdbc-outer-named-runtime-config.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -417,7 +417,7 @@ ifndef::no-duration-note[]
417417
.About the Duration format
418418
====
419419
To write duration values, use the standard `java.time.Duration` format.
420-
See the link:https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/time/Duration.html#parse(java.lang.CharSequence)[Duration#parse() Java API documentation] for more information.
420+
See the link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html#parse(java.lang.CharSequence)[Duration#parse() Java API documentation] for more information.
421421

422422
You can also use a simplified format, starting with a number:
423423

_generated-doc/main/config/quarkus-agroal-general-config-items.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -945,7 +945,7 @@ ifndef::no-duration-note[]
945945
.About the Duration format
946946
====
947947
To write duration values, use the standard `java.time.Duration` format.
948-
See the link:https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/time/Duration.html#parse(java.lang.CharSequence)[Duration#parse() Java API documentation] for more information.
948+
See the link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html#parse(java.lang.CharSequence)[Duration#parse() Java API documentation] for more information.
949949

950950
You can also use a simplified format, starting with a number:
951951

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -945,7 +945,7 @@ ifndef::no-duration-note[]
945945
.About the Duration format
946946
====
947947
To write duration values, use the standard `java.time.Duration` format.
948-
See the link:https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/time/Duration.html#parse(java.lang.CharSequence)[Duration#parse() Java API documentation] for more information.
948+
See the link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html#parse(java.lang.CharSequence)[Duration#parse() Java API documentation] for more information.
949949

950950
You can also use a simplified format, starting with a number:
951951

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

+25-8
Original file line numberDiff line numberDiff line change
@@ -2322,6 +2322,23 @@ endif::add-copy-button-to-env-var[]
23222322
|`false`
23232323

23242324

2325+
a|icon:lock[title=Fixed at build time] [[quarkus-arc_quarkus.arc.dev-mode.generate-dependency-graphs]]`link:#quarkus-arc_quarkus.arc.dev-mode.generate-dependency-graphs[quarkus.arc.dev-mode.generate-dependency-graphs]`
2326+
2327+
2328+
[.description]
2329+
--
2330+
If set to true then the dependency graphs are generated and available in the Dev UI.
2331+
2332+
ifdef::add-copy-button-to-env-var[]
2333+
Environment variable: env_var_with_copy_button:+++QUARKUS_ARC_DEV_MODE_GENERATE_DEPENDENCY_GRAPHS+++[]
2334+
endif::add-copy-button-to-env-var[]
2335+
ifndef::add-copy-button-to-env-var[]
2336+
Environment variable: `+++QUARKUS_ARC_DEV_MODE_GENERATE_DEPENDENCY_GRAPHS+++`
2337+
endif::add-copy-button-to-env-var[]
2338+
--|boolean
2339+
|`true`
2340+
2341+
23252342
a|icon:lock[title=Fixed at build time] [[quarkus-arc_quarkus.arc.test.disable-application-lifecycle-observers]]`link:#quarkus-arc_quarkus.arc.test.disable-application-lifecycle-observers[quarkus.arc.test.disable-application-lifecycle-observers]`
23262343

23272344

@@ -2366,7 +2383,7 @@ a|icon:lock[title=Fixed at build time] [[quarkus-arc_quarkus.arc.context-propaga
23662383

23672384
[.description]
23682385
--
2369-
If set to true and SmallRye Context Propagation extension is present then enable the context propagation for CDI contexts.
2386+
If set to true and the SmallRye Context Propagation extension is present then the CDI contexts will be propagated by means of the MicroProfile Context Propagation API. Specifically, a `org.eclipse.microprofile.context.spi.ThreadContextProvider` implementation is registered. On the other hand, if set to false then the MicroProfile Context Propagation API will never be used to propagate the CDI contexts. Note that the CDI contexts may be propagated in a different way though. For example with the Vertx duplicated context.
23702387

23712388
ifdef::add-copy-button-to-env-var[]
23722389
Environment variable: env_var_with_copy_button:+++QUARKUS_ARC_CONTEXT_PROPAGATION_ENABLED+++[]
@@ -2405,7 +2422,7 @@ a|icon:lock[title=Fixed at build time] [[quarkus-arc_quarkus.arc.exclude-depende
24052422

24062423
[.description]
24072424
--
2408-
The maven artifactId of the artifact.
2425+
The maven artifactId of the artifact (optional).
24092426

24102427
ifdef::add-copy-button-to-env-var[]
24112428
Environment variable: env_var_with_copy_button:+++QUARKUS_ARC_EXCLUDE_DEPENDENCY__DEPENDENCY_NAME__ARTIFACT_ID+++[]
@@ -2414,15 +2431,15 @@ ifndef::add-copy-button-to-env-var[]
24142431
Environment variable: `+++QUARKUS_ARC_EXCLUDE_DEPENDENCY__DEPENDENCY_NAME__ARTIFACT_ID+++`
24152432
endif::add-copy-button-to-env-var[]
24162433
--|string
2417-
|required icon:exclamation-circle[title=Configuration property is required]
2434+
|
24182435

24192436

24202437
a|icon:lock[title=Fixed at build time] [[quarkus-arc_quarkus.arc.exclude-dependency.-dependency-name-.classifier]]`link:#quarkus-arc_quarkus.arc.exclude-dependency.-dependency-name-.classifier[quarkus.arc.exclude-dependency."dependency-name".classifier]`
24212438

24222439

24232440
[.description]
24242441
--
2425-
The maven classifier of the artifact.
2442+
The maven classifier of the artifact (optional).
24262443

24272444
ifdef::add-copy-button-to-env-var[]
24282445
Environment variable: env_var_with_copy_button:+++QUARKUS_ARC_EXCLUDE_DEPENDENCY__DEPENDENCY_NAME__CLASSIFIER+++[]
@@ -54724,7 +54741,7 @@ a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus.index-dependency.-
5472454741

5472554742
[.description]
5472654743
--
54727-
The maven artifactId of the artifact.
54744+
The maven artifactId of the artifact (optional).
5472854745

5472954746
ifdef::add-copy-button-to-env-var[]
5473054747
Environment variable: env_var_with_copy_button:+++QUARKUS_INDEX_DEPENDENCY__DEPENDENCY_NAME__ARTIFACT_ID+++[]
@@ -54733,15 +54750,15 @@ ifndef::add-copy-button-to-env-var[]
5473354750
Environment variable: `+++QUARKUS_INDEX_DEPENDENCY__DEPENDENCY_NAME__ARTIFACT_ID+++`
5473454751
endif::add-copy-button-to-env-var[]
5473554752
--|string
54736-
|required icon:exclamation-circle[title=Configuration property is required]
54753+
|
5473754754

5473854755

5473954756
a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus.index-dependency.-dependency-name-.classifier]]`link:#quarkus-core_quarkus.index-dependency.-dependency-name-.classifier[quarkus.index-dependency."dependency-name".classifier]`
5474054757

5474154758

5474254759
[.description]
5474354760
--
54744-
The maven classifier of the artifact.
54761+
The maven classifier of the artifact (optional).
5474554762

5474654763
ifdef::add-copy-button-to-env-var[]
5474754764
Environment variable: env_var_with_copy_button:+++QUARKUS_INDEX_DEPENDENCY__DEPENDENCY_NAME__CLASSIFIER+++[]
@@ -69479,7 +69496,7 @@ ifndef::no-duration-note[]
6947969496
.About the Duration format
6948069497
====
6948169498
To write duration values, use the standard `java.time.Duration` format.
69482-
See the link:https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/time/Duration.html#parse(java.lang.CharSequence)[Duration#parse() Java API documentation] for more information.
69499+
See the link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html#parse(java.lang.CharSequence)[Duration#parse() Java API documentation] for more information.
6948369500

6948469501
You can also use a simplified format, starting with a number:
6948569502

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

+21-4
Original file line numberDiff line numberDiff line change
@@ -276,6 +276,23 @@ endif::add-copy-button-to-env-var[]
276276
|`false`
277277

278278

279+
a|icon:lock[title=Fixed at build time] [[quarkus-arc-arc-config_quarkus.arc.dev-mode.generate-dependency-graphs]]`link:#quarkus-arc-arc-config_quarkus.arc.dev-mode.generate-dependency-graphs[quarkus.arc.dev-mode.generate-dependency-graphs]`
280+
281+
282+
[.description]
283+
--
284+
If set to true then the dependency graphs are generated and available in the Dev UI.
285+
286+
ifdef::add-copy-button-to-env-var[]
287+
Environment variable: env_var_with_copy_button:+++QUARKUS_ARC_DEV_MODE_GENERATE_DEPENDENCY_GRAPHS+++[]
288+
endif::add-copy-button-to-env-var[]
289+
ifndef::add-copy-button-to-env-var[]
290+
Environment variable: `+++QUARKUS_ARC_DEV_MODE_GENERATE_DEPENDENCY_GRAPHS+++`
291+
endif::add-copy-button-to-env-var[]
292+
--|boolean
293+
|`true`
294+
295+
279296
a|icon:lock[title=Fixed at build time] [[quarkus-arc-arc-config_quarkus.arc.test.disable-application-lifecycle-observers]]`link:#quarkus-arc-arc-config_quarkus.arc.test.disable-application-lifecycle-observers[quarkus.arc.test.disable-application-lifecycle-observers]`
280297

281298

@@ -320,7 +337,7 @@ a|icon:lock[title=Fixed at build time] [[quarkus-arc-arc-config_quarkus.arc.cont
320337

321338
[.description]
322339
--
323-
If set to true and SmallRye Context Propagation extension is present then enable the context propagation for CDI contexts.
340+
If set to true and the SmallRye Context Propagation extension is present then the CDI contexts will be propagated by means of the MicroProfile Context Propagation API. Specifically, a `org.eclipse.microprofile.context.spi.ThreadContextProvider` implementation is registered. On the other hand, if set to false then the MicroProfile Context Propagation API will never be used to propagate the CDI contexts. Note that the CDI contexts may be propagated in a different way though. For example with the Vertx duplicated context.
324341

325342
ifdef::add-copy-button-to-env-var[]
326343
Environment variable: env_var_with_copy_button:+++QUARKUS_ARC_CONTEXT_PROPAGATION_ENABLED+++[]
@@ -359,7 +376,7 @@ a|icon:lock[title=Fixed at build time] [[quarkus-arc-arc-config_quarkus.arc.excl
359376

360377
[.description]
361378
--
362-
The maven artifactId of the artifact.
379+
The maven artifactId of the artifact (optional).
363380

364381
ifdef::add-copy-button-to-env-var[]
365382
Environment variable: env_var_with_copy_button:+++QUARKUS_ARC_EXCLUDE_DEPENDENCY__DEPENDENCY_NAME__ARTIFACT_ID+++[]
@@ -368,15 +385,15 @@ ifndef::add-copy-button-to-env-var[]
368385
Environment variable: `+++QUARKUS_ARC_EXCLUDE_DEPENDENCY__DEPENDENCY_NAME__ARTIFACT_ID+++`
369386
endif::add-copy-button-to-env-var[]
370387
--|string
371-
|required icon:exclamation-circle[title=Configuration property is required]
388+
|
372389

373390

374391
a|icon:lock[title=Fixed at build time] [[quarkus-arc-arc-config_quarkus.arc.exclude-dependency.-dependency-name-.classifier]]`link:#quarkus-arc-arc-config_quarkus.arc.exclude-dependency.-dependency-name-.classifier[quarkus.arc.exclude-dependency."dependency-name".classifier]`
375392

376393

377394
[.description]
378395
--
379-
The maven classifier of the artifact.
396+
The maven classifier of the artifact (optional).
380397

381398
ifdef::add-copy-button-to-env-var[]
382399
Environment variable: env_var_with_copy_button:+++QUARKUS_ARC_EXCLUDE_DEPENDENCY__DEPENDENCY_NAME__CLASSIFIER+++[]

0 commit comments

Comments
 (0)