Skip to content

Commit 48c71d4

Browse files
committed
Sync documentation of main branch
1 parent f267d4e commit 48c71d4

File tree

427 files changed

+7272
-7051
lines changed

Some content is hidden

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

427 files changed

+7272
-7051
lines changed

_data/versioned/main/index/quarkus.yaml

Lines changed: 26 additions & 26 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: "security, web"
8+
categories: "web, security"
99
id: security-authorize-web-endpoints-reference
1010
type: reference
1111
url: /guides/security-authorize-web-endpoints-reference
@@ -145,14 +145,14 @@ types:
145145
- title: Authentication mechanisms in Quarkus
146146
filename: security-authentication-mechanisms-concept.adoc
147147
summary: "The Quarkus Security framework supports multiple authentication mechanisms, which you can use to secure your applications."
148-
categories: "security, web"
148+
categories: "web, security"
149149
id: security-authentication-mechanisms-concept
150150
type: concepts
151151
url: /guides/security-authentication-mechanisms-concept
152152
- title: Basic authentication
153153
filename: security-basic-authentication-concept.adoc
154154
summary: HTTP Basic authentication is one of the least resource-demanding techniques that enforce access controls to web resources.
155-
categories: "security, web"
155+
categories: "web, security"
156156
id: security-basic-authentication-concept
157157
type: concepts
158158
url: /guides/security-basic-authentication-concept
@@ -166,21 +166,21 @@ types:
166166
- title: OpenID Connect (OIDC) Bearer authentication
167167
filename: security-oidc-bearer-token-authentication-concept.adoc
168168
summary: Secure HTTP access to Jakarta REST (formerly known as JAX-RS) endpoints in your application with Bearer authentication by using the Quarkus OpenID Connect (OIDC) extension.
169-
categories: "security, web"
169+
categories: "web, security"
170170
id: security-oidc-bearer-token-authentication-concept
171171
type: concepts
172172
url: /guides/security-oidc-bearer-token-authentication-concept
173173
- title: OpenID Connect authorization code flow mechanism for protecting web applications
174174
filename: security-oidc-code-flow-authentication-concept.adoc
175175
summary: "To protect your web applications, you can use the industry-standard authorization code flow mechanism provided by the Quarkus OpenID Connect (OIDC) extension."
176-
categories: "security, web"
176+
categories: "web, security"
177177
id: security-oidc-code-flow-authentication-concept
178178
type: concepts
179179
url: /guides/security-oidc-code-flow-authentication-concept
180180
- title: Proactive authentication
181181
filename: security-proactive-authentication-concept.adoc
182182
summary: Proactive authentication is enabled in Quarkus by default.
183-
categories: "security, web"
183+
categories: "web, security"
184184
id: security-proactive-authentication-concept
185185
type: concepts
186186
url: /guides/security-proactive-authentication-concept
@@ -215,7 +215,7 @@ types:
215215
- title: Security vulnerability detection and reporting in Quarkus
216216
filename: security-vulnerability-detection-concept.adoc
217217
summary: Most of the Quarkus tags are registered in the US National Vulnerability Database (NVD) in Common Platform Enumeration (CPE) name format.
218-
categories: "contributing, security"
218+
categories: "security, contributing"
219219
id: security-vulnerability-detection-concept
220220
type: concepts
221221
url: /guides/security-vulnerability-detection-concept
@@ -240,11 +240,18 @@ types:
240240
id: security-basic-authentication-howto
241241
type: howto
242242
url: /guides/security-basic-authentication-howto
243+
- title: Update projects to the latest Quarkus version
244+
filename: update-quarkus.adoc
245+
summary: Learn how to upgrade your projects to the latest version of Quarkus
246+
categories: core
247+
id: update-quarkus
248+
type: howto
249+
url: /guides/update-quarkus
243250
tutorial:
244251
- title: Building a Native Executable
245252
filename: building-native-image.adoc
246253
summary: Build native executables with GraalVM or Mandrel.
247-
categories: "getting-started, native"
254+
categories: "native, getting-started"
248255
type: tutorial
249256
url: /guides/building-native-image
250257
- title: Collect metrics using Micrometer
@@ -283,7 +290,7 @@ types:
283290
- title: Protect a web application by using OpenID Connect (OIDC) authorization code flow
284291
filename: security-oidc-code-flow-authentication-tutorial.adoc
285292
summary: "With the Quarkus OpenID Connect (OIDC) extension, you can protect application HTTP endpoints by using the OIDC Authorization Code Flow mechanism."
286-
categories: "security, web"
293+
categories: "web, security"
287294
id: security-oidc-code-flow-authentication-tutorial
288295
type: tutorial
289296
url: /guides/security-oidc-code-flow-authentication-tutorial
@@ -352,7 +359,7 @@ types:
352359
- title: AppCDS
353360
filename: appcds.adoc
354361
summary: This reference guide explains how to enable AppCDS with Quarkus.
355-
categories: "core, cloud"
362+
categories: "cloud, core"
356363
type: guide
357364
url: /guides/appcds
358365
- title: Application Data Caching
@@ -496,7 +503,7 @@ types:
496503
- title: Deploying on OpenShift
497504
filename: deploying-to-openshift.adoc
498505
summary: This guide covers how to deploy a native application on OpenShift.
499-
categories: "cloud, native"
506+
categories: "native, cloud"
500507
id: deploy-openshift
501508
type: guide
502509
url: /guides/deploying-to-openshift
@@ -769,7 +776,7 @@ types:
769776
- title: Kubernetes extension
770777
filename: deploying-to-kubernetes.adoc
771778
summary: This guide covers how to deploy a native application on Kubernetes.
772-
categories: "cloud, native"
779+
categories: "native, cloud"
773780
id: deploy-kubernetes
774781
type: guide
775782
url: /guides/deploying-to-kubernetes
@@ -891,14 +898,14 @@ types:
891898
- title: Quarkus and Gradle
892899
filename: gradle-tooling.adoc
893900
summary: Develop and build your Quarkus application with Gradle
894-
categories: "tooling, native"
901+
categories: "native, tooling"
895902
id: gradle-tooling
896903
type: guide
897904
url: /guides/gradle-tooling
898905
- title: Quarkus and Maven
899906
filename: maven-tooling.adoc
900907
summary: Develop and build your Quarkus application with Maven
901-
categories: "tooling, native"
908+
categories: "native, tooling"
902909
id: maven-tooling
903910
type: guide
904911
url: /guides/maven-tooling
@@ -1026,23 +1033,16 @@ types:
10261033
- title: Testing Your Application
10271034
filename: getting-started-testing.adoc
10281035
summary: "This guide covers testing in JVM mode, native mode, and injection of resources into tests"
1029-
categories: "tooling, core, native"
1036+
categories: "native, core, tooling"
10301037
id: testing
10311038
type: guide
10321039
url: /guides/getting-started-testing
10331040
- title: Tips for writing native applications
10341041
filename: writing-native-applications-tips.adoc
10351042
summary: This guide is a collection of tips to help you solve the problems you encounter when compiling applications to native executable.
1036-
categories: "core, writing-extensions, native"
1043+
categories: "native, core, writing-extensions"
10371044
type: guide
10381045
url: /guides/writing-native-applications-tips
1039-
- title: Update projects to the latest version of Quarkus
1040-
filename: update-quarkus.adoc
1041-
summary: Update your projects to the latest version of Quarkus
1042-
categories: core
1043-
id: update-projects-to-quarkus-3-automatically-howto
1044-
type: guide
1045-
url: /guides/update-quarkus
10461046
- title: Using Apache Kafka Streams
10471047
filename: kafka-streams.adoc
10481048
summary: This guide demonstrates how your Quarkus application can utilize the Apache Kafka Streams API to implement stream processing applications based on Apache Kafka.
@@ -1169,7 +1169,7 @@ types:
11691169
- title: Using SSL With Native Executables
11701170
filename: native-and-ssl.adoc
11711171
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."
1172-
categories: "core, security, native"
1172+
categories: "native, security, core"
11731173
type: guide
11741174
url: /guides/native-and-ssl
11751175
- title: Using Security with .properties File
@@ -1276,13 +1276,13 @@ types:
12761276
- title: Validation with Hibernate Validator
12771277
filename: validation.adoc
12781278
summary: This guide covers how to use Hibernate Validator/Bean Validation in your REST services.
1279-
categories: "data, web"
1279+
categories: "web, data"
12801280
type: guide
12811281
url: /guides/validation
12821282
- title: Writing JSON REST Services
12831283
filename: rest-json.adoc
12841284
summary: JSON is now the lingua franca between microservices.
1285-
categories: "serialization, web"
1285+
categories: "web, serialization"
12861286
type: guide
12871287
url: /guides/rest-json
12881288
- title: Writing REST Services with RESTEasy Reactive
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
[{"configDocKey":{"type":"boolean","key":"","configDoc":"If we create a JDBC datasource for this datasource.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".driver","configDoc":"The datasource driver class name","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"driver","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"io.quarkus.agroal.runtime.TransactionIntegration","key":".transactions","configDoc":"Whether we want to use regular JDBC transactions, XA, or disable all transactional capabilities. \nWhen enabling XA you will need a driver implementing `javax.sql.XADataSource`.","withinAMap":false,"defaultValue":"enabled","javaDocSiteLink":"","docMapKey":"transactions","configPhase":"BUILD_TIME","acceptedValues":["`enabled`","`xa`","`disabled`"],"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":true}},{"configDocKey":{"type":"java.lang.Boolean","key":".enable-metrics","configDoc":"Enable datasource metrics collection. If unspecified, collecting metrics will be enabled by default if a metrics extension is active.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"enable-metrics","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"boolean","key":".tracing","configDoc":"Enable JDBC tracing. Disabled by default.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"tracing","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"boolean","key":".telemetry","configDoc":"Enable OpenTelemetry JDBC instrumentation.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"telemetry","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}}]
1+
[{"configDocKey":{"type":"boolean","key":"","configDoc":"If we create a JDBC datasource for this datasource.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"enabled","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"string","key":".driver","configDoc":"The datasource driver class name","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"driver","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"io.quarkus.agroal.runtime.TransactionIntegration","key":".transactions","configDoc":"Whether we want to use regular JDBC transactions, XA, or disable all transactional capabilities.\n\nWhen enabling XA you will need a driver implementing `javax.sql.XADataSource`.","withinAMap":false,"defaultValue":"enabled","javaDocSiteLink":"","docMapKey":"transactions","configPhase":"BUILD_TIME","acceptedValues":["`enabled`","`xa`","`disabled`"],"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":true}},{"configDocKey":{"type":"java.lang.Boolean","key":".enable-metrics","configDoc":"Enable datasource metrics collection. If unspecified, collecting metrics will be enabled by default if a metrics extension is active.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"enable-metrics","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"boolean","key":".tracing","configDoc":"Enable JDBC tracing. Disabled by default.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"tracing","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}},{"configDocKey":{"type":"boolean","key":".telemetry","configDoc":"Enable OpenTelemetry JDBC instrumentation.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"telemetry","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","enum":false}}]

0 commit comments

Comments
 (0)