Skip to content

Commit 286816d

Browse files
committed
Sync documentation of main branch
1 parent 63fd379 commit 286816d

File tree

37 files changed

+1016
-104
lines changed

37 files changed

+1016
-104
lines changed

_data/versioned/main/index/quarkus.yaml

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ types:
55
- title: Authorization of web endpoints
66
filename: security-authorize-web-endpoints-reference.adoc
77
summary: Quarkus has an integrated pluggable web security layer.
8-
categories: "web, security"
8+
categories: "security, web"
99
id: security-authorize-web-endpoints-reference
1010
type: reference
1111
url: /guides/security-authorize-web-endpoints-reference
@@ -55,7 +55,7 @@ types:
5555
- title: Logging configuration
5656
filename: logging.adoc
5757
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."
58-
categories: "getting-started, observability, core"
58+
categories: "observability, core, getting-started"
5959
id: logging
6060
type: reference
6161
url: /guides/logging
@@ -159,21 +159,21 @@ types:
159159
- title: Authentication mechanisms in Quarkus
160160
filename: security-authentication-mechanisms.adoc
161161
summary: "The Quarkus Security framework supports multiple authentication mechanisms, which you can use to secure your applications."
162-
categories: "web, security"
162+
categories: "security, web"
163163
id: security-authentication-mechanisms
164164
type: concepts
165165
url: /guides/security-authentication-mechanisms
166166
- title: Basic authentication
167167
filename: security-basic-authentication.adoc
168168
summary: HTTP Basic authentication is one of the least resource-demanding techniques that enforce access controls to web resources.
169-
categories: "web, security"
169+
categories: "security, web"
170170
id: security-basic-authentication
171171
type: concepts
172172
url: /guides/security-basic-authentication
173173
- title: Configuring Well-Known OpenID Connect Providers
174174
filename: security-openid-connect-providers.adoc
175175
summary: This document explains how to configure well-known social OIDC and OAuth2 providers.
176-
categories: "web, security"
176+
categories: "security, web"
177177
id: security-openid-connect-providers
178178
type: concepts
179179
url: /guides/security-openid-connect-providers
@@ -194,21 +194,21 @@ types:
194194
- title: OpenID Connect (OIDC) Bearer token authentication
195195
filename: security-oidc-bearer-token-authentication.adoc
196196
summary: Secure HTTP access to Jakarta REST (formerly known as JAX-RS) endpoints in your application with Bearer token authentication by using the Quarkus OpenID Connect (OIDC) extension.
197-
categories: "web, security"
197+
categories: "security, web"
198198
id: security-oidc-bearer-token-authentication
199199
type: concepts
200200
url: /guides/security-oidc-bearer-token-authentication
201201
- title: OpenID Connect authorization code flow mechanism for protecting web applications
202202
filename: security-oidc-code-flow-authentication.adoc
203203
summary: "To protect your web applications, you can use the industry-standard OpenID Connect (OIDC) Authorization Code Flow mechanism provided by the Quarkus OIDC extension."
204-
categories: "web, security"
204+
categories: "security, web"
205205
id: security-oidc-code-flow-authentication
206206
type: concepts
207207
url: /guides/security-oidc-code-flow-authentication
208208
- title: Proactive authentication
209209
filename: security-proactive-authentication.adoc
210210
summary: Proactive authentication is enabled in Quarkus by default.
211-
categories: "web, security"
211+
categories: "security, web"
212212
id: security-proactive-authentication
213213
type: concepts
214214
url: /guides/security-proactive-authentication
@@ -265,7 +265,7 @@ types:
265265
- title: Use virtual threads in REST applications
266266
filename: resteasy-reactive-virtual-threads.adoc
267267
summary: How to use virtual threads in a REST application
268-
categories: "web, core"
268+
categories: "core, web"
269269
id: resteasy-reactive-virtual-threads
270270
type: howto
271271
url: /guides/resteasy-reactive-virtual-threads
@@ -312,7 +312,7 @@ types:
312312
- title: Protect a web application by using OpenID Connect (OIDC) authorization code flow
313313
filename: security-oidc-code-flow-authentication-tutorial.adoc
314314
summary: "With the Quarkus OpenID Connect (OIDC) extension, you can protect application HTTP endpoints by using the OIDC Authorization Code Flow mechanism."
315-
categories: "web, security"
315+
categories: "security, web"
316316
id: security-oidc-code-flow-authentication-tutorial
317317
type: tutorial
318318
url: /guides/security-oidc-code-flow-authentication-tutorial
@@ -325,7 +325,7 @@ types:
325325
- title: Secure a Quarkus application with Basic authentication and Jakarta Persistence
326326
filename: security-basic-authentication-tutorial.adoc
327327
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).
328-
categories: "getting-started, security"
328+
categories: "security, getting-started"
329329
id: security-basic-authentication-tutorial
330330
type: tutorial
331331
url: /guides/security-basic-authentication-tutorial
@@ -338,7 +338,7 @@ types:
338338
- title: Your second Quarkus application
339339
filename: getting-started-dev-services.adoc
340340
summary: Discover some of the features that make developing with Quarkus a joyful experience.
341-
categories: "getting-started, data, core"
341+
categories: "core, getting-started, data"
342342
id: getting-started-dev-services-tutorial
343343
type: tutorial
344344
url: /guides/getting-started-dev-services
@@ -394,7 +394,7 @@ types:
394394
- title: AppCDS
395395
filename: appcds.adoc
396396
summary: This reference guide explains how to enable AppCDS with Quarkus.
397-
categories: "cloud, core"
397+
categories: "core, cloud"
398398
type: guide
399399
url: /guides/appcds
400400
- title: Application Data Caching
@@ -528,7 +528,7 @@ types:
528528
- title: Deploying on OpenShift
529529
filename: deploying-to-openshift.adoc
530530
summary: This guide covers how to deploy a native application on OpenShift.
531-
categories: "native, cloud"
531+
categories: "cloud, native"
532532
id: deploy-openshift
533533
type: guide
534534
url: /guides/deploying-to-openshift
@@ -583,7 +583,7 @@ types:
583583
- title: Dev Services for Databases
584584
filename: databases-dev-services.adoc
585585
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."
586-
categories: "data, tooling"
586+
categories: "tooling, data"
587587
type: guide
588588
url: /guides/databases-dev-services
589589
- title: Dev Services for Elasticsearch
@@ -818,7 +818,7 @@ types:
818818
- title: Kubernetes extension
819819
filename: deploying-to-kubernetes.adoc
820820
summary: This guide covers how to deploy a native application on Kubernetes.
821-
categories: "native, cloud"
821+
categories: "cloud, native"
822822
id: deploy-kubernetes
823823
type: guide
824824
url: /guides/deploying-to-kubernetes
@@ -957,14 +957,14 @@ types:
957957
- title: Quarkus and Gradle
958958
filename: gradle-tooling.adoc
959959
summary: Develop and build your Quarkus application with Gradle
960-
categories: "native, tooling"
960+
categories: "tooling, native"
961961
id: gradle-tooling
962962
type: guide
963963
url: /guides/gradle-tooling
964964
- title: Quarkus and Maven
965965
filename: maven-tooling.adoc
966966
summary: Develop and build your Quarkus application with Maven
967-
categories: "native, tooling"
967+
categories: "tooling, native"
968968
id: maven-tooling
969969
type: guide
970970
url: /guides/maven-tooling
@@ -1062,7 +1062,7 @@ types:
10621062
- title: SmallRye Fault Tolerance
10631063
filename: smallrye-fault-tolerance.adoc
10641064
summary: This guide demonstrates how your Quarkus application can utilize the SmallRye Fault Tolerance specification through the SmallRye Fault Tolerance extension.
1065-
categories: "web, observability"
1065+
categories: "observability, web"
10661066
type: guide
10671067
url: /guides/smallrye-fault-tolerance
10681068
- title: SmallRye GraphQL
@@ -1092,14 +1092,14 @@ types:
10921092
- title: Testing Your Application
10931093
filename: getting-started-testing.adoc
10941094
summary: "This guide covers testing in JVM mode, native mode, and injection of resources into tests"
1095-
categories: "native, core, tooling"
1095+
categories: "core, tooling, native"
10961096
id: testing
10971097
type: guide
10981098
url: /guides/getting-started-testing
10991099
- title: Tips for writing native applications
11001100
filename: writing-native-applications-tips.adoc
11011101
summary: This guide is a collection of tips to help you solve the problems you encounter when compiling applications to native executable.
1102-
categories: "writing-extensions, native, core"
1102+
categories: "core, writing-extensions, native"
11031103
type: guide
11041104
url: /guides/writing-native-applications-tips
11051105
- title: Using Apache Kafka Streams
@@ -1228,7 +1228,7 @@ types:
12281228
- title: Using SSL With Native Executables
12291229
filename: native-and-ssl.adoc
12301230
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."
1231-
categories: "native, core, security"
1231+
categories: "security, core, native"
12321232
type: guide
12331233
url: /guides/native-and-ssl
12341234
- title: Using Security with .properties File
@@ -1347,7 +1347,7 @@ types:
13471347
- title: Writing JSON REST Services
13481348
filename: rest-json.adoc
13491349
summary: JSON is now the lingua franca between microservices.
1350-
categories: "web, serialization"
1350+
categories: "serialization, web"
13511351
type: guide
13521352
url: /guides/rest-json
13531353
- title: Writing REST Services with RESTEasy Reactive

_generated-doc/main/config/all-configuration-groups-generated-doc/io.quarkus.mongodb.runtime.MongoClientConfig

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

_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.
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
[{"configDocKey":{"type":"java.lang.Boolean","key":".enabled","additionalKeys":[],"configDoc":"If Dev Services for AMQP has been explicitly enabled or disabled. Dev Services are generally enabled by default, unless there is an existing configuration present. For AMQP, Dev Services starts a broker unless `amqp-host` or `amqp-port` are set or if all the Reactive Messaging AMQP channel are configured with `host` or `port`.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":".port","additionalKeys":[],"configDoc":"Optional fixed port the dev service will listen to.\n\nIf not defined, the port will be chosen randomly.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"port","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".image-name","additionalKeys":[],"configDoc":"The image to use. Note that only ActiveMQ Artemis images are supported. Specifically, the image repository must end with `artemiscloud/activemq-artemis-broker`. Check the link:https://quay.io/repository/artemiscloud/activemq-artemis-broker[activemq-artemis-broker on Quay page] to find the available versions.","withinAMap":false,"defaultValue":"quay.io/artemiscloud/activemq-artemis-broker:1.0.18","javaDocSiteLink":"","docMapKey":"image-name","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".extra-args","additionalKeys":[],"configDoc":"The value of the `AMQ_EXTRA_ARGS` environment variable to pass to the container.","withinAMap":false,"defaultValue":"--no-autotune --mapped --no-fsync --relax-jolokia --http-host 0.0.0.0","javaDocSiteLink":"","docMapKey":"extra-args","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"boolean","key":".shared","additionalKeys":[],"configDoc":"Indicates if the AMQP broker managed by Quarkus Dev Services is shared. When shared, Quarkus looks for running containers using label-based service discovery. If a matching container is found, it is used, and so a second one is not started. Otherwise, Dev Services for AMQP starts a new container.\n\nThe discovery uses the `quarkus-dev-service-amqp` label. The value is configured using the `service-name` property.\n\nContainer sharing is only used in dev mode.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"shared","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".service-name","additionalKeys":[],"configDoc":"The value of the `quarkus-dev-service-aqmp` label attached to the started container. This property is used when `shared` is set to `true`. In this case, before starting a container, Dev Services for AMQP looks for a container with the `quarkus-dev-service-amqp` label set to the configured value. If found, it will use this container instead of starting a new one. Otherwise, it starts a new container with the `quarkus-dev-service-amqp` label set to the specified value.\n\nThis property is used when you need multiple shared AMQP brokers.","withinAMap":false,"defaultValue":"amqp","javaDocSiteLink":"","docMapKey":"service-name","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"`Map<String,String>`","key":".container-env","additionalKeys":[],"configDoc":"Environment variables that are passed to the container.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"container-env","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":true,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}}]
1+
[{"configDocKey":{"type":"java.lang.Boolean","key":".enabled","additionalKeys":[],"configDoc":"If Dev Services for AMQP has been explicitly enabled or disabled. Dev Services are generally enabled by default, unless there is an existing configuration present. For AMQP, Dev Services starts a broker unless `amqp-host` or `amqp-port` are set or if all the Reactive Messaging AMQP channel are configured with `host` or `port`.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":".port","additionalKeys":[],"configDoc":"Optional fixed port the dev service will listen to.\n\nIf not defined, the port will be chosen randomly.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"port","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".image-name","additionalKeys":[],"configDoc":"The image to use. Note that only ActiveMQ Artemis images are supported. Specifically, the image repository must end with `artemiscloud/activemq-artemis-broker`.\n\nCheck the link:https://quay.io/repository/artemiscloud/activemq-artemis-broker[activemq-artemis-broker on Quay page] to find the available versions.","withinAMap":false,"defaultValue":"quay.io/artemiscloud/activemq-artemis-broker:1.0.22","javaDocSiteLink":"","docMapKey":"image-name","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".extra-args","additionalKeys":[],"configDoc":"The value of the `AMQ_EXTRA_ARGS` environment variable to pass to the container. For ActiveMQ Artemis Broker <= 1.0.21, set this property to `--no-autotune --mapped --no-fsync --relax-jolokia --http-host 0.0.0.0`","withinAMap":false,"defaultValue":"--no-autotune --mapped --no-fsync --relax-jolokia","javaDocSiteLink":"","docMapKey":"extra-args","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"boolean","key":".shared","additionalKeys":[],"configDoc":"Indicates if the AMQP broker managed by Quarkus Dev Services is shared. When shared, Quarkus looks for running containers using label-based service discovery. If a matching container is found, it is used, and so a second one is not started. Otherwise, Dev Services for AMQP starts a new container.\n\nThe discovery uses the `quarkus-dev-service-amqp` label. The value is configured using the `service-name` property.\n\nContainer sharing is only used in dev mode.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"shared","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".service-name","additionalKeys":[],"configDoc":"The value of the `quarkus-dev-service-aqmp` label attached to the started container. This property is used when `shared` is set to `true`. In this case, before starting a container, Dev Services for AMQP looks for a container with the `quarkus-dev-service-amqp` label set to the configured value. If found, it will use this container instead of starting a new one. Otherwise, it starts a new container with the `quarkus-dev-service-amqp` label set to the specified value.\n\nThis property is used when you need multiple shared AMQP brokers.","withinAMap":false,"defaultValue":"amqp","javaDocSiteLink":"","docMapKey":"service-name","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"`Map<String,String>`","key":".container-env","additionalKeys":[],"configDoc":"Environment variables that are passed to the container.","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"container-env","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":true,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}}]

0 commit comments

Comments
 (0)