Skip to content

Commit 312cc33

Browse files
committed
Sync documentation of main branch
1 parent e660af8 commit 312cc33

File tree

9 files changed

+283
-66
lines changed

9 files changed

+283
-66
lines changed

_data/versioned/main/index/quarkus.yaml

Lines changed: 17 additions & 17 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
@@ -18,7 +18,7 @@ types:
1818
- title: Command Mode Applications
1919
filename: command-mode-reference.adoc
2020
summary: This reference guide explains how to develop command line applications with Quarkus.
21-
categories: "command-line, core"
21+
categories: "core, command-line"
2222
type: reference
2323
url: /guides/command-mode-reference
2424
- title: Configuration Reference Guide
@@ -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: "security, web"
134+
categories: "web, security"
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: "security, web"
141+
categories: "web, security"
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: "security, web"
155+
categories: "web, security"
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: "security, web"
162+
categories: "web, security"
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: "security, web"
169+
categories: "web, security"
170170
id: security-proactive-authentication-concept
171171
type: concepts
172172
url: /guides/security-proactive-authentication-concept
@@ -230,7 +230,7 @@ types:
230230
- title: Building a Native Executable
231231
filename: building-native-image.adoc
232232
summary: Build native executables with GraalVM or Mandrel.
233-
categories: "getting-started, native"
233+
categories: "native, getting-started"
234234
type: tutorial
235235
url: /guides/building-native-image
236236
- title: Collect metrics using Micrometer
@@ -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: "getting-started, data, reactive"
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: "security, web"
279+
categories: "web, security"
280280
id: security-oidc-code-flow-authentication-tutorial
281281
type: tutorial
282282
url: /guides/security-oidc-code-flow-authentication-tutorial
@@ -539,7 +539,7 @@ types:
539539
- title: Dev Services for Databases
540540
filename: databases-dev-services.adoc
541541
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."
542-
categories: "data, tooling"
542+
categories: "tooling, data"
543543
type: guide
544544
url: /guides/databases-dev-services
545545
- title: Dev Services for Elasticsearch
@@ -960,7 +960,7 @@ types:
960960
- title: Simplified Hibernate ORM with Panache and Kotlin
961961
filename: hibernate-orm-panache-kotlin.adoc
962962
summary: This explains the specifics of using Hibernate ORM with Panache in a Kotlin project.
963-
categories: "data, alt-languages"
963+
categories: "alt-languages, data"
964964
type: guide
965965
url: /guides/hibernate-orm-panache-kotlin
966966
- title: Simplified Hibernate Reactive with Panache
@@ -978,13 +978,13 @@ types:
978978
- title: Simplified MongoDB with Panache and Kotlin
979979
filename: mongodb-panache-kotlin.adoc
980980
summary: This guide covers the usage of MongoDB using active records and repositories in a Kotlin project.
981-
categories: "data, alt-languages"
981+
categories: "alt-languages, data"
982982
type: guide
983983
url: /guides/mongodb-panache-kotlin
984984
- title: SmallRye Fault Tolerance
985985
filename: smallrye-fault-tolerance.adoc
986986
summary: This guide demonstrates how your Quarkus application can utilize the SmallRye Fault Tolerance specification through the SmallRye Fault Tolerance extension.
987-
categories: "observability, web"
987+
categories: "web, observability"
988988
type: guide
989989
url: /guides/smallrye-fault-tolerance
990990
- title: SmallRye GraphQL
@@ -1021,7 +1021,7 @@ types:
10211021
- title: Tips for writing native applications
10221022
filename: writing-native-applications-tips.adoc
10231023
summary: This guide is a collection of tips to help you solve the problems you encounter when compiling applications to native executable.
1024-
categories: "writing-extensions, core, native"
1024+
categories: "core, writing-extensions, native"
10251025
type: guide
10261026
url: /guides/writing-native-applications-tips
10271027
- title: Update projects to the latest version of Quarkus
@@ -1157,7 +1157,7 @@ types:
11571157
- title: Using SSL With Native Executables
11581158
filename: native-and-ssl.adoc
11591159
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."
1160-
categories: "security, core, native"
1160+
categories: "core, security, native"
11611161
type: guide
11621162
url: /guides/native-and-ssl
11631163
- title: Using Security with .properties File
@@ -1264,7 +1264,7 @@ types:
12641264
- title: Validation with Hibernate Validator
12651265
filename: validation.adoc
12661266
summary: This guide covers how to use Hibernate Validator/Bean Validation in your REST services.
1267-
categories: "data, web"
1267+
categories: "web, data"
12681268
type: guide
12691269
url: /guides/validation
12701270
- title: Writing JSON REST Services

_generated-doc/main/config/all-configuration-roots-generated-doc/io.quarkus.azure.functions.deployment.AzureFunctionsConfig

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

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

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -850,6 +850,9 @@ a| `String functionName` :: +++<i>No Javadoc found</i>+++
850850
`Class declaring` :: +++<i>No Javadoc found</i>+++
851851
`Method method` :: +++<i>No Javadoc found</i>+++
852852
853+
a| https://github.com/quarkusio/quarkus/blob/main/extensions/azure-functions/deployment/src/main/java/io/quarkus/azure/functions/deployment/AzureFunctionsAppNameBuildItem.java[`io.quarkus.azure.functions.deployment.AzureFunctionsAppNameBuildItem`, window="_blank"] :: +++<i>No Javadoc found</i>+++
854+
a| `String appName` :: +++<i>No Javadoc found</i>+++
855+
853856
|===
854857
== Cache
855858
[%header,cols=2*]

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2327,7 +2327,7 @@ a|icon:lock[title=Fixed at build time] [[quarkus-azure-functions_quarkus.azure-f
23272327

23282328
[.description]
23292329
--
2330-
App name for azure function project. This is required setting
2330+
App name for azure function project. This is required setting. Defaults to the base artifact name
23312331

23322332
ifdef::add-copy-button-to-env-var[]
23332333
Environment variable: env_var_with_copy_button:+++QUARKUS_AZURE_FUNCTIONS_APP_NAME+++[]
@@ -2336,7 +2336,7 @@ ifndef::add-copy-button-to-env-var[]
23362336
Environment variable: `+++QUARKUS_AZURE_FUNCTIONS_APP_NAME+++`
23372337
endif::add-copy-button-to-env-var[]
23382338
--|string
2339-
|required icon:exclamation-circle[title=Configuration property is required]
2339+
|
23402340

23412341

23422342
a|icon:lock[title=Fixed at build time] [[quarkus-azure-functions_quarkus.azure-functions.resource-group]]`link:#quarkus-azure-functions_quarkus.azure-functions.resource-group[quarkus.azure-functions.resource-group]`

_generated-doc/main/config/quarkus-azure-functions-azure-functions-config.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ a|icon:lock[title=Fixed at build time] [[quarkus-azure-functions-azure-functions
1414

1515
[.description]
1616
--
17-
App name for azure function project. This is required setting
17+
App name for azure function project. This is required setting. Defaults to the base artifact name
1818

1919
ifdef::add-copy-button-to-env-var[]
2020
Environment variable: env_var_with_copy_button:+++QUARKUS_AZURE_FUNCTIONS_APP_NAME+++[]
@@ -23,7 +23,7 @@ ifndef::add-copy-button-to-env-var[]
2323
Environment variable: `+++QUARKUS_AZURE_FUNCTIONS_APP_NAME+++`
2424
endif::add-copy-button-to-env-var[]
2525
--|string
26-
|required icon:exclamation-circle[title=Configuration property is required]
26+
|
2727

2828

2929
a|icon:lock[title=Fixed at build time] [[quarkus-azure-functions-azure-functions-config_quarkus.azure-functions.resource-group]]`link:#quarkus-azure-functions-azure-functions-config_quarkus.azure-functions.resource-group[quarkus.azure-functions.resource-group]`

_generated-doc/main/config/quarkus-azure-functions.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ a|icon:lock[title=Fixed at build time] [[quarkus-azure-functions_quarkus.azure-f
1414

1515
[.description]
1616
--
17-
App name for azure function project. This is required setting
17+
App name for azure function project. This is required setting. Defaults to the base artifact name
1818

1919
ifdef::add-copy-button-to-env-var[]
2020
Environment variable: env_var_with_copy_button:+++QUARKUS_AZURE_FUNCTIONS_APP_NAME+++[]
@@ -23,7 +23,7 @@ ifndef::add-copy-button-to-env-var[]
2323
Environment variable: `+++QUARKUS_AZURE_FUNCTIONS_APP_NAME+++`
2424
endif::add-copy-button-to-env-var[]
2525
--|string
26-
|required icon:exclamation-circle[title=Configuration property is required]
26+
|
2727

2828

2929
a|icon:lock[title=Fixed at build time] [[quarkus-azure-functions_quarkus.azure-functions.resource-group]]`link:#quarkus-azure-functions_quarkus.azure-functions.resource-group[quarkus.azure-functions.resource-group]`

0 commit comments

Comments
 (0)