Skip to content

Commit 8997df5

Browse files
committed
Sync documentation of main branch
1 parent ae3f68b commit 8997df5

28 files changed

+1656
-33
lines changed

_data/versioned/main/index/quarkus.yaml

Lines changed: 30 additions & 19 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
@@ -30,7 +30,7 @@ types:
3030
- title: Configure data sources in Quarkus
3131
filename: datasource.adoc
3232
summary: Use a unified configuration model to define datasources for Java Database Connectivity (JDBC) and Reactive drivers.
33-
categories: "data, getting-started"
33+
categories: "getting-started, data"
3434
id: datasources
3535
type: reference
3636
url: /guides/datasource
@@ -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: "web, security"
148+
categories: "security, web"
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: "web, security"
155+
categories: "security, web"
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: "web, security"
169+
categories: "security, web"
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: "web, security"
176+
categories: "security, web"
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: "web, security"
183+
categories: "security, web"
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: "security, contributing"
218+
categories: "contributing, security"
219219
id: security-vulnerability-detection-concept
220220
type: concepts
221221
url: /guides/security-vulnerability-detection-concept
@@ -244,7 +244,7 @@ types:
244244
- title: Building a Native Executable
245245
filename: building-native-image.adoc
246246
summary: Build native executables with GraalVM or Mandrel.
247-
categories: "native, getting-started"
247+
categories: "getting-started, native"
248248
type: tutorial
249249
url: /guides/building-native-image
250250
- title: Collect metrics using Micrometer
@@ -283,7 +283,7 @@ types:
283283
- title: Protect a web application by using OpenID Connect (OIDC) authorization code flow
284284
filename: security-oidc-code-flow-authentication-tutorial.adoc
285285
summary: "With the Quarkus OpenID Connect (OIDC) extension, you can protect application HTTP endpoints by using the OIDC Authorization Code Flow mechanism."
286-
categories: "web, security"
286+
categories: "security, web"
287287
id: security-oidc-code-flow-authentication-tutorial
288288
type: tutorial
289289
url: /guides/security-oidc-code-flow-authentication-tutorial
@@ -296,7 +296,7 @@ types:
296296
- title: Secure a Quarkus application with Basic authentication and Jakarta Persistence
297297
filename: security-basic-authentication-tutorial.adoc
298298
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).
299-
categories: "security, getting-started"
299+
categories: "getting-started, security"
300300
id: security-basic-authentication-tutorial
301301
type: tutorial
302302
url: /guides/security-basic-authentication-tutorial
@@ -391,6 +391,11 @@ types:
391391
categories: writing-extensions
392392
type: guide
393393
url: /guides/all-builditems
394+
- title: Build analytics
395+
filename: build-analytics.adoc
396+
summary: This guide presents what build analytics is and how to configure it.
397+
type: guide
398+
url: /guides/build-analytics
394399
- title: "Build, Sign and Encrypt JSON Web Tokens"
395400
filename: security-jwt-build.adoc
396401
summary: "According to RFC7519, JSON Web Token (JWT) is a compact, URL-safe means of representing claims which are encoded as a JSON object that is used as the payload of a JSON Web Signature (JWS) structure or as the plaintext of a JSON Web Encryption (JWE) structure, enabling the claims to be digitally signed or integrity protected with a Message Authentication Code(MAC) and/or encrypted."
@@ -491,7 +496,7 @@ types:
491496
- title: Deploying on OpenShift
492497
filename: deploying-to-openshift.adoc
493498
summary: This guide covers how to deploy a native application on OpenShift.
494-
categories: "native, cloud"
499+
categories: "cloud, native"
495500
id: deploy-openshift
496501
type: guide
497502
url: /guides/deploying-to-openshift
@@ -546,7 +551,7 @@ types:
546551
- title: Dev Services for Databases
547552
filename: databases-dev-services.adoc
548553
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."
549-
categories: "tooling, data"
554+
categories: "data, tooling"
550555
type: guide
551556
url: /guides/databases-dev-services
552557
- title: Dev Services for Elasticsearch
@@ -583,6 +588,12 @@ types:
583588
categories: data
584589
type: guide
585590
url: /guides/redis-dev-services
591+
- title: Dev UI
592+
filename: dev-ui-v2.adoc
593+
summary: Learn how to get your extension to contribute features to the Dev UI (v2).
594+
categories: writing-extensions
595+
type: guide
596+
url: /guides/dev-ui-v2
586597
- title: Dev UI
587598
filename: dev-ui.adoc
588599
summary: Learn how to get your extension contribute features to the Dev UI (v1).
@@ -758,7 +769,7 @@ types:
758769
- title: Kubernetes extension
759770
filename: deploying-to-kubernetes.adoc
760771
summary: This guide covers how to deploy a native application on Kubernetes.
761-
categories: "native, cloud"
772+
categories: "cloud, native"
762773
id: deploy-kubernetes
763774
type: guide
764775
url: /guides/deploying-to-kubernetes
@@ -1015,14 +1026,14 @@ types:
10151026
- title: Testing Your Application
10161027
filename: getting-started-testing.adoc
10171028
summary: "This guide covers testing in JVM mode, native mode, and injection of resources into tests"
1018-
categories: "tooling, core, native"
1029+
categories: "core, tooling, native"
10191030
id: testing
10201031
type: guide
10211032
url: /guides/getting-started-testing
10221033
- title: Tips for writing native applications
10231034
filename: writing-native-applications-tips.adoc
10241035
summary: This guide is a collection of tips to help you solve the problems you encounter when compiling applications to native executable.
1025-
categories: "core, native, writing-extensions"
1036+
categories: "core, writing-extensions, native"
10261037
type: guide
10271038
url: /guides/writing-native-applications-tips
10281039
- title: Update projects to the latest version of Quarkus
@@ -1158,7 +1169,7 @@ types:
11581169
- title: Using SSL With Native Executables
11591170
filename: native-and-ssl.adoc
11601171
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."
1161-
categories: "core, native, security"
1172+
categories: "core, security, native"
11621173
type: guide
11631174
url: /guides/native-and-ssl
11641175
- title: Using Security with .properties File
@@ -1265,13 +1276,13 @@ types:
12651276
- title: Validation with Hibernate Validator
12661277
filename: validation.adoc
12671278
summary: This guide covers how to use Hibernate Validator/Bean Validation in your REST services.
1268-
categories: "web, data"
1279+
categories: "data, web"
12691280
type: guide
12701281
url: /guides/validation
12711282
- title: Writing JSON REST Services
12721283
filename: rest-json.adoc
12731284
summary: JSON is now the lingua franca between microservices.
1274-
categories: "web, serialization"
1285+
categories: "serialization, web"
12751286
type: guide
12761287
url: /guides/rest-json
12771288
- title: Writing REST Services with RESTEasy Reactive
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
[{"configDocKey":{"type":"java.lang.Boolean","key":"quarkus.analytics.disabled","configDoc":"If Build time analytics are disabled.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"disabled","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.analytics","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.analytics.uri-base","configDoc":"The Segment base URI.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"uri-base","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.analytics","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":"quarkus.analytics.timeout","configDoc":"The Timeout to send the build time analytics to segment.","withinAMap":false,"defaultValue":"3000","javaDocSiteLink":"","docMapKey":"timeout","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.analytics","enum":false}}]
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
io.quarkus.runtime.BuildAnalyticsConfig

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

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1461,7 +1461,11 @@ a| None
14611461
[%header,cols=2*]
14621462
|===
14631463
|Class Name |Attributes
1464-
a| https://github.com/quarkusio/quarkus/blob/main/extensions/netty/deployment/src/main/java/io/quarkus/netty/deployment/EventLoopSupplierBuildItem.java[`io.quarkus.netty.deployment.EventLoopSupplierBuildItem`, window="_blank"] :: +++<i>No Javadoc found</i>+++
1464+
a| https://github.com/quarkusio/quarkus/blob/main/extensions/netty/deployment/src/main/java/io/quarkus/netty/deployment/EventLoopGroupBuildItem.java[`io.quarkus.netty.deployment.EventLoopGroupBuildItem`, window="_blank"] :: +++Provides suppliers that return EventLoopGroup used by the application. See EventLoopSupplierBuildItem to register custom EventLoopGroup+++
1465+
a| `Supplier bossEventLoopGroup` :: +++<i>No Javadoc found</i>+++
1466+
`Supplier mainEventLoopGroup` :: +++<i>No Javadoc found</i>+++
1467+
1468+
a| https://github.com/quarkusio/quarkus/blob/main/extensions/netty/deployment/src/main/java/io/quarkus/netty/deployment/EventLoopSupplierBuildItem.java[`io.quarkus.netty.deployment.EventLoopSupplierBuildItem`, window="_blank"] :: +++Register EventLoopGroup suppliers to be used to produce main EventLoopGroup and boss EventLoopGroup annotated beans. If not provided, both will be created from a default supplier. See EventLoopGroupBuildItem for actual supplier instances+++
14651469
a| `Supplier mainSupplier` :: +++<i>No Javadoc found</i>+++
14661470
`Supplier bossSupplier` :: +++<i>No Javadoc found</i>+++
14671471

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

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50133,6 +50133,54 @@ endif::add-copy-button-to-env-var[]
5013350133
|
5013450134

5013550135

50136+
a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus.analytics.disabled]]`link:#quarkus-core_quarkus.analytics.disabled[quarkus.analytics.disabled]`
50137+
50138+
[.description]
50139+
--
50140+
If Build time analytics are disabled.
50141+
50142+
ifdef::add-copy-button-to-env-var[]
50143+
Environment variable: env_var_with_copy_button:+++QUARKUS_ANALYTICS_DISABLED+++[]
50144+
endif::add-copy-button-to-env-var[]
50145+
ifndef::add-copy-button-to-env-var[]
50146+
Environment variable: `+++QUARKUS_ANALYTICS_DISABLED+++`
50147+
endif::add-copy-button-to-env-var[]
50148+
--|boolean
50149+
|
50150+
50151+
50152+
a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus.analytics.uri-base]]`link:#quarkus-core_quarkus.analytics.uri-base[quarkus.analytics.uri-base]`
50153+
50154+
[.description]
50155+
--
50156+
The Segment base URI.
50157+
50158+
ifdef::add-copy-button-to-env-var[]
50159+
Environment variable: env_var_with_copy_button:+++QUARKUS_ANALYTICS_URI_BASE+++[]
50160+
endif::add-copy-button-to-env-var[]
50161+
ifndef::add-copy-button-to-env-var[]
50162+
Environment variable: `+++QUARKUS_ANALYTICS_URI_BASE+++`
50163+
endif::add-copy-button-to-env-var[]
50164+
--|string
50165+
|
50166+
50167+
50168+
a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus.analytics.timeout]]`link:#quarkus-core_quarkus.analytics.timeout[quarkus.analytics.timeout]`
50169+
50170+
[.description]
50171+
--
50172+
The Timeout to send the build time analytics to segment.
50173+
50174+
ifdef::add-copy-button-to-env-var[]
50175+
Environment variable: env_var_with_copy_button:+++QUARKUS_ANALYTICS_TIMEOUT+++[]
50176+
endif::add-copy-button-to-env-var[]
50177+
ifndef::add-copy-button-to-env-var[]
50178+
Environment variable: `+++QUARKUS_ANALYTICS_TIMEOUT+++`
50179+
endif::add-copy-button-to-env-var[]
50180+
--|int
50181+
|`3000`
50182+
50183+
5013650184
a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus.application.name]]`link:#quarkus-core_quarkus.application.name[quarkus.application.name]`
5013750185

5013850186
[.description]
Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
2+
:summaryTableId: quarkus-analytics-build-analytics-config
3+
[.configuration-legend]
4+
icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime
5+
[.configuration-reference, cols="80,.^10,.^10"]
6+
|===
7+
8+
h|[[quarkus-analytics-build-analytics-config_configuration]]link:#quarkus-analytics-build-analytics-config_configuration[Configuration property]
9+
10+
h|Type
11+
h|Default
12+
13+
a|icon:lock[title=Fixed at build time] [[quarkus-analytics-build-analytics-config_quarkus.analytics.disabled]]`link:#quarkus-analytics-build-analytics-config_quarkus.analytics.disabled[quarkus.analytics.disabled]`
14+
15+
[.description]
16+
--
17+
If Build time analytics are disabled.
18+
19+
ifdef::add-copy-button-to-env-var[]
20+
Environment variable: env_var_with_copy_button:+++QUARKUS_ANALYTICS_DISABLED+++[]
21+
endif::add-copy-button-to-env-var[]
22+
ifndef::add-copy-button-to-env-var[]
23+
Environment variable: `+++QUARKUS_ANALYTICS_DISABLED+++`
24+
endif::add-copy-button-to-env-var[]
25+
--|boolean
26+
|
27+
28+
29+
a|icon:lock[title=Fixed at build time] [[quarkus-analytics-build-analytics-config_quarkus.analytics.uri-base]]`link:#quarkus-analytics-build-analytics-config_quarkus.analytics.uri-base[quarkus.analytics.uri-base]`
30+
31+
[.description]
32+
--
33+
The Segment base URI.
34+
35+
ifdef::add-copy-button-to-env-var[]
36+
Environment variable: env_var_with_copy_button:+++QUARKUS_ANALYTICS_URI_BASE+++[]
37+
endif::add-copy-button-to-env-var[]
38+
ifndef::add-copy-button-to-env-var[]
39+
Environment variable: `+++QUARKUS_ANALYTICS_URI_BASE+++`
40+
endif::add-copy-button-to-env-var[]
41+
--|string
42+
|
43+
44+
45+
a|icon:lock[title=Fixed at build time] [[quarkus-analytics-build-analytics-config_quarkus.analytics.timeout]]`link:#quarkus-analytics-build-analytics-config_quarkus.analytics.timeout[quarkus.analytics.timeout]`
46+
47+
[.description]
48+
--
49+
The Timeout to send the build time analytics to segment.
50+
51+
ifdef::add-copy-button-to-env-var[]
52+
Environment variable: env_var_with_copy_button:+++QUARKUS_ANALYTICS_TIMEOUT+++[]
53+
endif::add-copy-button-to-env-var[]
54+
ifndef::add-copy-button-to-env-var[]
55+
Environment variable: `+++QUARKUS_ANALYTICS_TIMEOUT+++`
56+
endif::add-copy-button-to-env-var[]
57+
--|int
58+
|`3000`
59+
60+
|===

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

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -165,6 +165,54 @@ endif::add-copy-button-to-env-var[]
165165
|
166166

167167

168+
a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus.analytics.disabled]]`link:#quarkus-core_quarkus.analytics.disabled[quarkus.analytics.disabled]`
169+
170+
[.description]
171+
--
172+
If Build time analytics are disabled.
173+
174+
ifdef::add-copy-button-to-env-var[]
175+
Environment variable: env_var_with_copy_button:+++QUARKUS_ANALYTICS_DISABLED+++[]
176+
endif::add-copy-button-to-env-var[]
177+
ifndef::add-copy-button-to-env-var[]
178+
Environment variable: `+++QUARKUS_ANALYTICS_DISABLED+++`
179+
endif::add-copy-button-to-env-var[]
180+
--|boolean
181+
|
182+
183+
184+
a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus.analytics.uri-base]]`link:#quarkus-core_quarkus.analytics.uri-base[quarkus.analytics.uri-base]`
185+
186+
[.description]
187+
--
188+
The Segment base URI.
189+
190+
ifdef::add-copy-button-to-env-var[]
191+
Environment variable: env_var_with_copy_button:+++QUARKUS_ANALYTICS_URI_BASE+++[]
192+
endif::add-copy-button-to-env-var[]
193+
ifndef::add-copy-button-to-env-var[]
194+
Environment variable: `+++QUARKUS_ANALYTICS_URI_BASE+++`
195+
endif::add-copy-button-to-env-var[]
196+
--|string
197+
|
198+
199+
200+
a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus.analytics.timeout]]`link:#quarkus-core_quarkus.analytics.timeout[quarkus.analytics.timeout]`
201+
202+
[.description]
203+
--
204+
The Timeout to send the build time analytics to segment.
205+
206+
ifdef::add-copy-button-to-env-var[]
207+
Environment variable: env_var_with_copy_button:+++QUARKUS_ANALYTICS_TIMEOUT+++[]
208+
endif::add-copy-button-to-env-var[]
209+
ifndef::add-copy-button-to-env-var[]
210+
Environment variable: `+++QUARKUS_ANALYTICS_TIMEOUT+++`
211+
endif::add-copy-button-to-env-var[]
212+
--|int
213+
|`3000`
214+
215+
168216
a|icon:lock[title=Fixed at build time] [[quarkus-core_quarkus.application.name]]`link:#quarkus-core_quarkus.application.name[quarkus.application.name]`
169217

170218
[.description]

0 commit comments

Comments
 (0)