Skip to content

Commit e35f214

Browse files
committed
Sync documentation of main branch
1 parent a39b1c7 commit e35f214

File tree

7 files changed

+97
-30
lines changed

7 files changed

+97
-30
lines changed

_data/versioned/main/index/quarkus.yaml

Lines changed: 15 additions & 15 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
@@ -131,14 +131,14 @@ types:
131131
- title: Authentication mechanisms in Quarkus
132132
filename: security-authentication-mechanisms-concept.adoc
133133
summary: "The Quarkus Security framework supports multiple authentication mechanisms, which you can use to secure your applications."
134-
categories: "web, security"
134+
categories: "security, web"
135135
id: security-authentication-mechanisms-concept
136136
type: concepts
137137
url: /guides/security-authentication-mechanisms-concept
138138
- title: Basic authentication
139139
filename: security-basic-authentication-concept.adoc
140140
summary: HTTP Basic authentication is one of the least resource-demanding techniques that enforce access controls to web resources.
141-
categories: "web, security"
141+
categories: "security, web"
142142
id: security-basic-authentication-concept
143143
type: concepts
144144
url: /guides/security-basic-authentication-concept
@@ -152,21 +152,21 @@ types:
152152
- title: OpenID Connect (OIDC) Bearer authentication
153153
filename: security-oidc-bearer-token-authentication-concept.adoc
154154
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.
155-
categories: "web, security"
155+
categories: "security, web"
156156
id: security-oidc-bearer-token-authentication-concept
157157
type: concepts
158158
url: /guides/security-oidc-bearer-token-authentication-concept
159159
- title: OpenID Connect authorization code flow mechanism for protecting web applications
160160
filename: security-oidc-code-flow-authentication-concept.adoc
161161
summary: "To protect your web applications, you can use the authorization code flow mechanism provided by the Quarkus OpenID Connect (OIDC) extension."
162-
categories: "web, security"
162+
categories: "security, web"
163163
id: security-oidc-code-flow-authentication-concept
164164
type: concepts
165165
url: /guides/security-oidc-code-flow-authentication-concept
166166
- title: Proactive authentication
167167
filename: security-proactive-authentication-concept.adoc
168168
summary: Proactive authentication is enabled in Quarkus by default.
169-
categories: "web, security"
169+
categories: "security, web"
170170
id: security-proactive-authentication-concept
171171
type: concepts
172172
url: /guides/security-proactive-authentication-concept
@@ -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
@@ -243,7 +243,7 @@ types:
243243
- title: Configure data sources in Quarkus
244244
filename: datasource.adoc
245245
summary: Use a unified configuration model to define datasources for Java Database Connectivity (JDBC) and Reactive drivers.
246-
categories: "data, reactive, getting-started"
246+
categories: "reactive, data, getting-started"
247247
id: datasources
248248
type: tutorial
249249
url: /guides/datasource
@@ -276,7 +276,7 @@ types:
276276
- title: Protect a web application by using OpenID Connect (OIDC) authorization code flow
277277
filename: security-oidc-code-flow-authentication-tutorial.adoc
278278
summary: "With the Quarkus OpenID Connect (OIDC) extension, you can protect application HTTP endpoints by using the OIDC Authorization Code Flow mechanism."
279-
categories: "web, security"
279+
categories: "security, web"
280280
id: security-oidc-code-flow-authentication-tutorial
281281
type: tutorial
282282
url: /guides/security-oidc-code-flow-authentication-tutorial
@@ -460,7 +460,7 @@ types:
460460
url: /guides/grpc-service-consumption
461461
- title: Container Images
462462
filename: container-image.adoc
463-
summary: "Learn how to build and push container images with Jib, S2I or Docker as part of the Quarkus build."
463+
summary: "Learn how to build and push container images with Jib, OpenShift or Docker as part of the Quarkus build."
464464
categories: cloud
465465
type: guide
466466
url: /guides/container-image
@@ -880,14 +880,14 @@ types:
880880
- title: Quarkus and Gradle
881881
filename: gradle-tooling.adoc
882882
summary: Develop and build your Quarkus application with Gradle
883-
categories: "native, tooling"
883+
categories: "tooling, native"
884884
id: gradle-tooling
885885
type: guide
886886
url: /guides/gradle-tooling
887887
- title: Quarkus and Maven
888888
filename: maven-tooling.adoc
889889
summary: Develop and build your Quarkus application with Maven
890-
categories: "native, tooling"
890+
categories: "tooling, native"
891891
id: maven-tooling
892892
type: guide
893893
url: /guides/maven-tooling
@@ -1015,14 +1015,14 @@ types:
10151015
- title: Testing Your Application
10161016
filename: getting-started-testing.adoc
10171017
summary: "This guide covers testing in JVM mode, native mode, and injection of resources into tests"
1018-
categories: "core, native, tooling"
1018+
categories: "core, tooling, native"
10191019
id: testing
10201020
type: guide
10211021
url: /guides/getting-started-testing
10221022
- title: Tips for writing native applications
10231023
filename: writing-native-applications-tips.adoc
10241024
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, writing-extensions, native"
1025+
categories: "writing-extensions, core, native"
10261026
type: guide
10271027
url: /guides/writing-native-applications-tips
10281028
- title: Update projects to the latest version of Quarkus
@@ -1158,7 +1158,7 @@ types:
11581158
- title: Using SSL With Native Executables
11591159
filename: native-and-ssl.adoc
11601160
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, security, native"
1161+
categories: "security, core, native"
11621162
type: guide
11631163
url: /guides/native-and-ssl
11641164
- title: Using Security with .properties File
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
[{"configDocKey":{"type":"string","key":"quarkus.docker.dockerfile-jvm-path","configDoc":"Path to the JVM Dockerfile. If set to an absolute path then the absolute path will be used, otherwise the path will be considered relative to the project root. If not set src/main/docker/Dockerfile.jvm will be used.","withinAMap":false,"defaultValue":"src/main/docker/Dockerfile.jvm","javaDocSiteLink":"","docMapKey":"dockerfile-jvm-path","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.docker","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.docker.dockerfile-native-path","configDoc":"Path to the native Dockerfile. If set to an absolute path then the absolute path will be used, otherwise the path will be considered relative to the project root. If not set src/main/docker/Dockerfile.native will be used.","withinAMap":false,"defaultValue":"src/main/docker/Dockerfile.native","javaDocSiteLink":"","docMapKey":"dockerfile-native-path","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.docker","enum":false}},{"configDocKey":{"type":"`Map<String,String>`","key":"quarkus.docker.build-args","configDoc":"Build args passed to docker via `--build-arg`","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"build-args","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":true,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.docker","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.docker.cache-from","configDoc":"Images to consider as cache sources. Values are passed to `docker build` via the `cache-from` option","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"cache-from","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":true,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.docker","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.docker.network","configDoc":"","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"network","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.docker","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.docker.executable-name","configDoc":"Name of binary used to execute the docker commands. This setting can override the global container runtime detection.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"executable-name","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.docker","enum":false}},{"configDocSection":{"name":"quarkus.docker.buildx","optional":false,"withinAMap":false,"sectionDetails":"= Configuration for Docker Buildx options","sectionDetailsTitle":"Configuration for Docker Buildx options","configPhase":"BUILD_TIME","topLevelGrouping":"quarkus.docker","configGroupType":"io.quarkus.container.image.docker.deployment.DockerConfig.DockerBuildxConfig","showSection":true,"configDocItems":[{"configDocKey":{"type":"string","key":"quarkus.docker.buildx.platform","configDoc":"Which platform(s) to target during the build. See https://docs.docker.com/engine/reference/commandline/buildx_build/++#++platform","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"platform","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":true,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.docker","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.docker.buildx.output","configDoc":"Sets the export action for the build result. See https://docs.docker.com/engine/reference/commandline/buildx_build/++#++output. Note that any filesystem paths need to be absolute paths, not relative from where the command is executed from.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"output","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.docker","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.docker.buildx.progress","configDoc":"Set type of progress output (`auto`, `plain`, `tty`). Use `plain` to show container output (default “`auto`”). See https://docs.docker.com/engine/reference/commandline/buildx_build/++#++progress","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"progress","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.docker","enum":false}}],"anchorPrefix":null}}]
1+
[{"configDocKey":{"type":"string","key":"quarkus.docker.dockerfile-jvm-path","configDoc":"Path to the JVM Dockerfile. If set to an absolute path then the absolute path will be used, otherwise the path will be considered relative to the project root. If not set src/main/docker/Dockerfile.jvm will be used.","withinAMap":false,"defaultValue":"src/main/docker/Dockerfile.jvm","javaDocSiteLink":"","docMapKey":"dockerfile-jvm-path","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.docker","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.docker.dockerfile-native-path","configDoc":"Path to the native Dockerfile. If set to an absolute path then the absolute path will be used, otherwise the path will be considered relative to the project root. If not set src/main/docker/Dockerfile.native will be used.","withinAMap":false,"defaultValue":"src/main/docker/Dockerfile.native","javaDocSiteLink":"","docMapKey":"dockerfile-native-path","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.docker","enum":false}},{"configDocKey":{"type":"`Map<String,String>`","key":"quarkus.docker.build-args","configDoc":"Build args passed to docker via `--build-arg`","withinAMap":true,"defaultValue":"","javaDocSiteLink":"","docMapKey":"build-args","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":true,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.docker","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.docker.cache-from","configDoc":"Images to consider as cache sources. Values are passed to `docker build` via the `cache-from` option","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"cache-from","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":true,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.docker","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.docker.network","configDoc":"","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"network","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.docker","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.docker.executable-name","configDoc":"Name of binary used to execute the docker commands. This setting can override the global container runtime detection.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"executable-name","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.docker","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.docker.additional-args","configDoc":"Additional arbitrary arguments passed to the executable when building the container image.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"additional-args","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":true,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.docker","enum":false}},{"configDocSection":{"name":"quarkus.docker.buildx","optional":false,"withinAMap":false,"sectionDetails":"= Configuration for Docker Buildx options","sectionDetailsTitle":"Configuration for Docker Buildx options","configPhase":"BUILD_TIME","topLevelGrouping":"quarkus.docker","configGroupType":"io.quarkus.container.image.docker.deployment.DockerConfig.DockerBuildxConfig","showSection":true,"configDocItems":[{"configDocKey":{"type":"string","key":"quarkus.docker.buildx.platform","configDoc":"Which platform(s) to target during the build. See https://docs.docker.com/engine/reference/commandline/buildx_build/++#++platform","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"platform","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":true,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.docker","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.docker.buildx.output","configDoc":"Sets the export action for the build result. See https://docs.docker.com/engine/reference/commandline/buildx_build/++#++output. Note that any filesystem paths need to be absolute paths, not relative from where the command is executed from.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"output","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.docker","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.docker.buildx.progress","configDoc":"Set type of progress output (`auto`, `plain`, `tty`). Use `plain` to show container output (default “`auto`”). See https://docs.docker.com/engine/reference/commandline/buildx_build/++#++progress","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"progress","configPhase":"BUILD_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"quarkus.docker","enum":false}}],"anchorPrefix":null}}]

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

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3301,6 +3301,22 @@ endif::add-copy-button-to-env-var[]
33013301
|
33023302

33033303

3304+
a|icon:lock[title=Fixed at build time] [[quarkus-container-image-docker_quarkus.docker.additional-args]]`link:#quarkus-container-image-docker_quarkus.docker.additional-args[quarkus.docker.additional-args]`
3305+
3306+
[.description]
3307+
--
3308+
Additional arbitrary arguments passed to the executable when building the container image.
3309+
3310+
ifdef::add-copy-button-to-env-var[]
3311+
Environment variable: env_var_with_copy_button:+++QUARKUS_DOCKER_ADDITIONAL_ARGS+++[]
3312+
endif::add-copy-button-to-env-var[]
3313+
ifndef::add-copy-button-to-env-var[]
3314+
Environment variable: `+++QUARKUS_DOCKER_ADDITIONAL_ARGS+++`
3315+
endif::add-copy-button-to-env-var[]
3316+
--|list of string
3317+
|
3318+
3319+
33043320
a|icon:lock[title=Fixed at build time] [[quarkus-container-image-docker_quarkus.docker.build-args-build-args]]`link:#quarkus-container-image-docker_quarkus.docker.build-args-build-args[quarkus.docker.build-args]`
33053321

33063322
[.description]

_generated-doc/main/config/quarkus-container-image-docker.adoc

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -88,6 +88,22 @@ endif::add-copy-button-to-env-var[]
8888
|
8989

9090

91+
a|icon:lock[title=Fixed at build time] [[quarkus-container-image-docker_quarkus.docker.additional-args]]`link:#quarkus-container-image-docker_quarkus.docker.additional-args[quarkus.docker.additional-args]`
92+
93+
[.description]
94+
--
95+
Additional arbitrary arguments passed to the executable when building the container image.
96+
97+
ifdef::add-copy-button-to-env-var[]
98+
Environment variable: env_var_with_copy_button:+++QUARKUS_DOCKER_ADDITIONAL_ARGS+++[]
99+
endif::add-copy-button-to-env-var[]
100+
ifndef::add-copy-button-to-env-var[]
101+
Environment variable: `+++QUARKUS_DOCKER_ADDITIONAL_ARGS+++`
102+
endif::add-copy-button-to-env-var[]
103+
--|list of string
104+
|
105+
106+
91107
a|icon:lock[title=Fixed at build time] [[quarkus-container-image-docker_quarkus.docker.build-args-build-args]]`link:#quarkus-container-image-docker_quarkus.docker.build-args-build-args[quarkus.docker.build-args]`
92108

93109
[.description]

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

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -88,6 +88,22 @@ endif::add-copy-button-to-env-var[]
8888
|
8989

9090

91+
a|icon:lock[title=Fixed at build time] [[quarkus-docker-docker-config_quarkus.docker.additional-args]]`link:#quarkus-docker-docker-config_quarkus.docker.additional-args[quarkus.docker.additional-args]`
92+
93+
[.description]
94+
--
95+
Additional arbitrary arguments passed to the executable when building the container image.
96+
97+
ifdef::add-copy-button-to-env-var[]
98+
Environment variable: env_var_with_copy_button:+++QUARKUS_DOCKER_ADDITIONAL_ARGS+++[]
99+
endif::add-copy-button-to-env-var[]
100+
ifndef::add-copy-button-to-env-var[]
101+
Environment variable: `+++QUARKUS_DOCKER_ADDITIONAL_ARGS+++`
102+
endif::add-copy-button-to-env-var[]
103+
--|list of string
104+
|
105+
106+
91107
a|icon:lock[title=Fixed at build time] [[quarkus-docker-docker-config_quarkus.docker.build-args-build-args]]`link:#quarkus-docker-docker-config_quarkus.docker.build-args-build-args[quarkus.docker.build-args]`
92108

93109
[.description]

0 commit comments

Comments
 (0)